Package com.puppycrawl.tools.checkstyle.checks.javadoc.utils

Class TagInfo

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.javadoc.utils.TagInfo

public final class TagInfo
extends Object

Value object for storing data about a parsed tag.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	name	Name of the tag ("link", "see", etc).
private final LineColumn	position	Position of the tag in the given comment.
private final String	value	Value of the tag.

Constructor Summary

Constructors

Constructor	Description
TagInfo(String name, String value, LineColumn position)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getName()	Return name of tag.
LineColumn	getPosition()	Return position of tag.
String	getValue()	Return value of tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

private final String name

Name of the tag ("link", "see", etc).

value

private final String value

Value of the tag.

position

private final LineColumn position

Position of the tag in the given comment.

Constructor Details

TagInfo

public TagInfo(String name,
 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 Details

getName

public String getName()

Return name of tag.

Returns:

Name of the tag.

getValue

public String getValue()

Return value of tag.

Returns:

Value of the tag.

getPosition

public LineColumn getPosition()

Return position of tag.

Returns:

Value of the tag.