Class TagInfo
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.checks.javadoc.utils.TagInfo
-
public final class TagInfo extends java.lang.Object
Value object for storing data about a parsed tag.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
name
Name of the tag ("link", "see", etc).private LineColumn
position
Position of the tag in the given comment.private java.lang.String
value
Value of the tag.
-
Constructor Summary
Constructors Constructor Description TagInfo(java.lang.String name, java.lang.String value, LineColumn position)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getName()
Return name of tag.LineColumn
getPosition()
Return position of tag.java.lang.String
getValue()
Return value of tag.
-
-
-
Field Detail
-
name
private final java.lang.String name
Name of the tag ("link", "see", etc).
-
value
private final java.lang.String value
Value of the tag.
-
position
private final LineColumn position
Position of the tag in the given comment.
-
-
Constructor Detail
-
TagInfo
public TagInfo(java.lang.String name, java.lang.String value, LineColumn position)
Constructor.- Parameters:
name
- The name of the tag.value
- The value of the tag.position
- The position of the tag in the comment.
-
-
Method Detail
-
getName
public java.lang.String getName()
Return name of tag.- Returns:
- Name of the tag.
-
getValue
public java.lang.String getValue()
Return value of tag.- Returns:
- Value of the tag.
-
getPosition
public LineColumn getPosition()
Return position of tag.- Returns:
- Value of the tag.
-
-