Package com.puppycrawl.tools.checkstyle
Class JavadocDetailNodeParser.ParseStatus
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.ParseStatus
-
- Enclosing class:
- JavadocDetailNodeParser
public static class JavadocDetailNodeParser.ParseStatus extends Object
Contains result of parsing javadoc comment: DetailNode tree and parse error message.
-
-
Field Summary
Fields Modifier and Type Field Description private org.antlr.v4.runtime.Token
firstNonTightHtmlTag
Stores the first non-tight HTML tag encountered while parsing javadoc.private JavadocDetailNodeParser.ParseErrorMessage
parseErrorMessage
Parse error message (is null if parsing is successful).private DetailNode
tree
DetailNode tree (is null if parsing fails).
-
Constructor Summary
Constructors Constructor Description ParseStatus()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.antlr.v4.runtime.Token
getFirstNonTightHtmlTag()
Getter for the first non-tight HTML tag encountered while parsing javadoc.JavadocDetailNodeParser.ParseErrorMessage
getParseErrorMessage()
Getter for error message during parsing.DetailNode
getTree()
Getter for DetailNode tree.boolean
isNonTight()
This method is used to check if the javadoc parsed has non-tight HTML tags.void
setParseErrorMessage(JavadocDetailNodeParser.ParseErrorMessage parseErrorMessage)
Sets parse error message.void
setTree(DetailNode tree)
Sets DetailNode tree.
-
-
-
Field Detail
-
tree
private DetailNode tree
DetailNode tree (is null if parsing fails).
-
parseErrorMessage
private JavadocDetailNodeParser.ParseErrorMessage parseErrorMessage
Parse error message (is null if parsing is successful).
-
firstNonTightHtmlTag
private org.antlr.v4.runtime.Token firstNonTightHtmlTag
Stores the first non-tight HTML tag encountered while parsing javadoc.- See Also:
- Tight HTML rules
-
-
Constructor Detail
-
ParseStatus
public ParseStatus()
-
-
Method Detail
-
getTree
public DetailNode getTree()
Getter for DetailNode tree.- Returns:
- DetailNode tree if parsing was successful, null otherwise.
-
setTree
public void setTree(DetailNode tree)
Sets DetailNode tree.- Parameters:
tree
- DetailNode tree.
-
getParseErrorMessage
public JavadocDetailNodeParser.ParseErrorMessage getParseErrorMessage()
Getter for error message during parsing.- Returns:
- Error message if parsing was unsuccessful, null otherwise.
-
setParseErrorMessage
public void setParseErrorMessage(JavadocDetailNodeParser.ParseErrorMessage parseErrorMessage)
Sets parse error message.- Parameters:
parseErrorMessage
- Parse error message.
-
isNonTight
public boolean isNonTight()
This method is used to check if the javadoc parsed has non-tight HTML tags.- Returns:
- returns true if the javadoc has at least one non-tight HTML tag; false otherwise
- See Also:
- Tight HTML rules
-
getFirstNonTightHtmlTag
public org.antlr.v4.runtime.Token getFirstNonTightHtmlTag()
Getter for the first non-tight HTML tag encountered while parsing javadoc.- Returns:
- the first non-tight HTML tag that is encountered while parsing Javadoc, if one exists
- See Also:
- Tight HTML rules
-
-