Class JavadocMethodCheck.ExceptionInfo
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo
-
- Enclosing class:
- JavadocMethodCheck
private static class JavadocMethodCheck.ExceptionInfo extends java.lang.Object
Stores useful information about declared exception.
-
-
Field Summary
Fields Modifier and Type Field Description private DetailASTastAST node representing this exception.private JavadocMethodCheck.ClassInfoclassInfoClass information associated with this exception.private booleanfoundDoes the exception have throws tag associated with.
-
Constructor Summary
Constructors Constructor Description ExceptionInfo(DetailAST ast, JavadocMethodCheck.ClassInfo classInfo)Creates new instance forFullIdent.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private DetailASTgetAst()Gets the AST node representing this exception.private JavadocMethodCheck.TokengetName()Gets exception name.private booleanisFound()Checks that the exception has throws tag associated with it.private voidsetFound()Mark that the exception has associated throws tag.
-
-
-
Field Detail
-
classInfo
private final JavadocMethodCheck.ClassInfo classInfo
Class information associated with this exception.
-
found
private boolean found
Does the exception have throws tag associated with.
-
-
Constructor Detail
-
ExceptionInfo
ExceptionInfo(DetailAST ast, JavadocMethodCheck.ClassInfo classInfo)
Creates new instance forFullIdent.- Parameters:
ast- AST node representing this exceptionclassInfo- class info
-
-
Method Detail
-
getAst
private DetailAST getAst()
Gets the AST node representing this exception.- Returns:
- the AST node representing this exception
-
setFound
private void setFound()
Mark that the exception has associated throws tag.
-
isFound
private boolean isFound()
Checks that the exception has throws tag associated with it.- Returns:
- whether the exception has throws tag associated with
-
getName
private JavadocMethodCheck.Token getName()
Gets exception name.- Returns:
- exception's name
-
-