Class JavadocTag
java.lang.Object
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag
Represents a Javadoc tag. Provides methods to query what type of tag it is.
-
Constructor Summary
ConstructorsConstructorDescriptionJavadocTag
(int line, int column, String tag) Constructs the object.JavadocTag
(int line, int column, String tag, String firstArg) Constructs the object. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks that the tag can contain references to imported classes.int
Gets column number.Returns first argument.int
Gets the line number.Gets tag name.boolean
Checks that the tag is a 'inheritDoc' tag.boolean
Checks that the tag is an 'param' tag.boolean
Checks that the tag is an 'return' tag.boolean
Checks that the tag is a 'see' or 'inheritDoc' tag.boolean
Checks that the tag is an 'throws' or 'exception' tag.toString()
-
Constructor Details
-
JavadocTag
Constructs the object.- Parameters:
line
- the line number of the tagcolumn
- the column number of the tagtag
- the tag stringfirstArg
- the tag argument
-
JavadocTag
Constructs the object.- Parameters:
line
- the line number of the tagcolumn
- the column number of the tagtag
- the tag string
-
-
Method Details
-
getTagName
Gets tag name.- Returns:
- the tag string
-
getFirstArg
Returns first argument.- Returns:
- the first argument. null if not set.
-
getLineNo
public int getLineNo()Gets the line number.- Returns:
- the line number
-
getColumnNo
public int getColumnNo()Gets column number.- Returns:
- the column number
-
toString
-
isReturnTag
public boolean isReturnTag()Checks that the tag is an 'return' tag.- Returns:
- whether the tag is an 'return' tag
-
isParamTag
public boolean isParamTag()Checks that the tag is an 'param' tag.- Returns:
- whether the tag is an 'param' tag
-
isThrowsTag
public boolean isThrowsTag()Checks that the tag is an 'throws' or 'exception' tag.- Returns:
- whether the tag is an 'throws' or 'exception' tag
-
isSeeOrInheritDocTag
public boolean isSeeOrInheritDocTag()Checks that the tag is a 'see' or 'inheritDoc' tag.- Returns:
- whether the tag is a 'see' or 'inheritDoc' tag
-
isInheritDocTag
public boolean isInheritDocTag()Checks that the tag is a 'inheritDoc' tag.- Returns:
- whether the tag is a 'inheritDoc' tag
-
canReferenceImports
public boolean canReferenceImports()Checks that the tag can contain references to imported classes.- Returns:
- whether the tag can contain references to imported classes
-