public class JavadocBlockTag
extends java.lang.Object
Typically they are found at the end of Javadoc comments.
Examples:
@see AnotherClass
@since v0.0.1
@author Jim O'Java
Modifier and Type | Class and Description |
---|---|
static class |
JavadocBlockTag.Type
The type of tag: it could either correspond to a known tag (param, return, etc.) or represent
an unknown tag.
|
Modifier and Type | Field and Description |
---|---|
private JavadocDescription |
content |
private java.util.Optional<java.lang.String> |
name |
private java.lang.String |
tagName |
private JavadocBlockTag.Type |
type |
Constructor and Description |
---|
JavadocBlockTag(JavadocBlockTag.Type type,
java.lang.String content) |
JavadocBlockTag(java.lang.String tagName,
java.lang.String content) |
Modifier and Type | Method and Description |
---|---|
static JavadocBlockTag |
createParamBlockTag(java.lang.String paramName,
java.lang.String content) |
boolean |
equals(java.lang.Object o) |
JavadocDescription |
getContent() |
java.util.Optional<java.lang.String> |
getName() |
java.lang.String |
getTagName() |
JavadocBlockTag.Type |
getType() |
int |
hashCode() |
java.lang.String |
toString() |
java.lang.String |
toText() |
private JavadocBlockTag.Type type
private JavadocDescription content
private java.util.Optional<java.lang.String> name
private java.lang.String tagName
public JavadocBlockTag(JavadocBlockTag.Type type, java.lang.String content)
public JavadocBlockTag(java.lang.String tagName, java.lang.String content)
public static JavadocBlockTag createParamBlockTag(java.lang.String paramName, java.lang.String content)
public JavadocBlockTag.Type getType()
public JavadocDescription getContent()
public java.util.Optional<java.lang.String> getName()
public java.lang.String getTagName()
public java.lang.String toText()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object