Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocMethodCheck.ExceptionInfo

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.ExceptionInfo

Enclosing class:

JavadocMethodCheck

private static final class JavadocMethodCheck.ExceptionInfo
extends Object

Stores useful information about declared exception.

Field Summary

Fields

Modifier and Type	Field	Description
private final DetailAST	ast	AST node representing this exception.
private final JavadocMethodCheck.ClassInfo	classInfo	Class information associated with this exception.
private boolean	found	Does the exception have throws tag associated with.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExceptionInfo(DetailAST ast, JavadocMethodCheck.ClassInfo classInfo)	Creates new instance for FullIdent.

Method Summary

Modifier and Type	Method	Description
private DetailAST	getAst()	Gets the AST node representing this exception.
private JavadocMethodCheck.Token	getName()	Gets exception name.
private boolean	isFound()	Checks that the exception has throws tag associated with it.
private void	setFound()	Mark that the exception has associated throws tag.

Methods inherited from class java.lang.Object

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

Field Details

ast

private final DetailAST ast

AST node representing this exception.

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 Details

ExceptionInfo

private ExceptionInfo(DetailAST ast,
 JavadocMethodCheck.ClassInfo classInfo)

Creates new instance for FullIdent.

Parameters:

ast - AST node representing this exception

classInfo - class info

Method Details

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