com.puppycrawl.tools.checkstyle.checks.javadoc

Class InvalidJavadocTag

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocTag

public final class InvalidJavadocTag
extends java.lang.Object

Value object for storing data about an invalid Javadoc validTags.

Field Summary

Fields

Modifier and Type	Field and Description
private int	col The column in which the invalid tag occurs.
private int	line The line in which the invalid tag occurs.
private java.lang.String	name The name of the invalid tag.

Constructor Summary

Constructors

Constructor and Description
InvalidJavadocTag(int line, int col, java.lang.String name) Creates an instance.

Method Summary

Modifier and Type	Method and Description
int	getCol() Getter for col field.
int	getLine() Getter for line field.
java.lang.String	getName() Getter for name field.

Methods inherited from class java.lang.Object

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

Field Detail

line

private final int line

The line in which the invalid tag occurs.

col

private final int col

The column in which the invalid tag occurs.

name

private final java.lang.String name

The name of the invalid tag.

Constructor Detail

InvalidJavadocTag

public InvalidJavadocTag(int line,
                         int col,
                         java.lang.String name)

Creates an instance.

Parameters:

line - the line of the tag

col - the column of the tag

name - the name of the invalid tag

Method Detail

getLine

public int getLine()

Getter for line field.

Returns:

line field

getCol

public int getCol()

Getter for col field.

Returns:

col field

getName

public java.lang.String getName()

Getter for name field.

Returns:

name field