public class JavadocTag
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private int |
columnNo
The column number of the tag.
|
private java.lang.String |
firstArg
An optional first argument.
|
private int |
lineNo
The line number of the tag.
|
private JavadocTagInfo |
tagInfo
The JavadocTagInfo representing this tag.
|
Constructor and Description |
---|
JavadocTag(int line,
int column,
java.lang.String tag)
Constructs the object.
|
JavadocTag(int line,
int column,
java.lang.String tag,
java.lang.String firstArg)
Constructs the object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canReferenceImports()
Checks that the tag can contain references to imported classes.
|
int |
getColumnNo()
Gets column number.
|
java.lang.String |
getFirstArg()
Returns first argument.
|
int |
getLineNo()
Gets the line number.
|
java.lang.String |
getTagName()
Gets tag name.
|
boolean |
isInheritDocTag()
Checks that the tag is a 'inheritDoc' tag.
|
boolean |
isParamTag()
Checks that the tag is an 'param' tag.
|
boolean |
isReturnTag()
Checks that the tag is an 'return' tag.
|
boolean |
isSeeOrInheritDocTag()
Checks that the tag is a 'see' or 'inheritDoc' tag.
|
boolean |
isThrowsTag()
Checks that the tag is an 'throws' or 'exception' tag.
|
java.lang.String |
toString() |
private final int lineNo
private final int columnNo
private final java.lang.String firstArg
private final JavadocTagInfo tagInfo
public JavadocTag(int line, int column, java.lang.String tag, java.lang.String firstArg)
line
- the line number of the tagcolumn
- the column number of the tagtag
- the tag stringfirstArg
- the tag argumentpublic JavadocTag(int line, int column, java.lang.String tag)
line
- the line number of the tagcolumn
- the column number of the tagtag
- the tag stringpublic java.lang.String getTagName()
public java.lang.String getFirstArg()
public int getLineNo()
public int getColumnNo()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean isReturnTag()
public boolean isParamTag()
public boolean isThrowsTag()
public boolean isSeeOrInheritDocTag()
public boolean isInheritDocTag()
public boolean canReferenceImports()