Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ javadoc overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.puppycrawl.tools.checkstyle.checks.javadoc
Class HtmlTag  

java.lang.Object
  com.puppycrawl.tools.checkstyle.checks.javadoc.HtmlTag

---

class HtmlTag

extends java.lang.Object

Used to keep track of a tag and the text that follows it.

---

Field Summary
private static int	MAX_TEXT_LEN           The maximum length of text to display with this tag.
private  java.lang.String	mId           The HTML tag name.
private  int	mLineNo           The line number in the source file where this tag was found.
private  int	mPosition           The position within the line where this tag was found.
private  java.lang.String	mText           The comment line of text where this tag appears.

 

Constructor Summary
(package private)	HtmlTag(java.lang.String aId, int aLineNo, int aPosition, java.lang.String aText)           Construct the HtmlTag.

 

Method Summary
java.lang.String	getId()           Returns the id (name) of this tag.
int	getLineno()           Returns the source line number where this tag was found.
int	getPosition()           Returns the position with in the comment line where this tag was found.
boolean	isCloseTag()           Indicates if this tag is a close (end) tag.
java.lang.String	toString()           Returns this HTML tag and trailing text.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

MAX_TEXT_LEN

private static final int MAX_TEXT_LEN

The maximum length of text to display with this tag.

See Also:

Constant Field Values

---

mId

private final java.lang.String mId

The HTML tag name.

---

mLineNo

private final int mLineNo

The line number in the source file where this tag was found.

---

mPosition

private final int mPosition

The position within the line where this tag was found.

---

mText

private final java.lang.String mText

The comment line of text where this tag appears.

Constructor Detail

HtmlTag

HtmlTag(java.lang.String aId,
        int aLineNo,
        int aPosition,
        java.lang.String aText)

Construct the HtmlTag.

Method Detail

getId

public java.lang.String getId()

Returns the id (name) of this tag.

---

isCloseTag

public boolean isCloseTag()

Indicates if this tag is a close (end) tag.

---

getLineno

public int getLineno()

Returns the source line number where this tag was found. Used for displaying a Checkstyle error.

---

getPosition

public int getPosition()

Returns the position with in the comment line where this tag was found. Used for displaying a Checkstyle error.

---

toString

public java.lang.String toString()

Returns this HTML tag and trailing text. Used for displaying a Checkstyle error.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ javadoc overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---