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 java.lang.ObjectContains result of parsing javadoc comment: DetailNode tree and parse error message.
-
-
Constructor Summary
Constructors Constructor Description ParseStatus()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.antlr.v4.runtime.TokengetFirstNonTightHtmlTag()Getter for the first non-tight HTML tag encountered while parsing javadoc.JavadocDetailNodeParser.ParseErrorMessagegetParseErrorMessage()Getter for error message during parsing.DetailNodegetTree()Getter for DetailNode tree.booleanisNonTight()This method is used to check if the javadoc parsed has non-tight HTML tags.voidsetParseErrorMessage(JavadocDetailNodeParser.ParseErrorMessage parseErrorMessage)Sets parse error message.voidsetTree(DetailNode tree)Sets DetailNode tree.
-
-
-
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
-
-