com.puppycrawl.tools.checkstyle.checks

Class AbstractTypeAwareCheck

public abstract class AbstractTypeAwareCheck extends Check

Abstract class that endeavours to maintain type information for the Java file being checked. It provides helper methods for performing type information functions.

Version: 1.0

Author: Oliver Burn

Nested Class Summary
protected abstract static class	AbstractTypeAwareCheck.ClassInfo Contains class's `Token`.
protected static class	AbstractTypeAwareCheck.Token Represents text element with location in the text.

Method Summary
void	beginTree(DetailAST aRootAST)
protected AbstractTypeAwareCheck.ClassInfo	createClassInfo(AbstractTypeAwareCheck.Token aName, String aSurroundingClass) Creates class info for given name.
protected AbstractTypeAwareCheck.ClassInfo	findClassAlias(String aName) Looking if a given name is alias.
protected String	getCurrentClassName() Returns current class.
int[]	getRequiredTokens()
protected boolean	isSubclass(Class aChild, Class aParent) Checks if one class is subclass of another
protected boolean	isUnchecked(Class aException) Is exception is unchecked (subclass of `RuntimeException` or `Error`
protected void	leaveAST(DetailAST aAST) Called when exiting an AST.
void	leaveToken(DetailAST aAST)
protected abstract void	logLoadError(AbstractTypeAwareCheck.Token aIdent) Logs error if unable to load class information.
protected void	logLoadErrorImpl(int aLineNo, int aColumnNo, String aMsgKey, Object[] aValues) Common implementation for logLoadError() method.
protected abstract void	processAST(DetailAST aAST) Called to process an AST when visiting it.
protected Class	resolveClass(String aClassName, String aCurrentClass) Attempts to resolve the Class for a specified name.
void	setLogLoadErrors(boolean aLogLoadErrors) Controls whether to log class loading errors to the checkstyle report instead of throwing a RTE.
void	setSuppressLoadErrors(boolean aSuppressLoadErrors) Controls whether to show class loading errors in the checkstyle report.
protected Class	tryLoadClass(AbstractTypeAwareCheck.Token aIdent, String aCurrentClass) Tries to load class.
void	visitToken(DetailAST aAST)

Method Detail

beginTree

public void beginTree(DetailAST aRootAST)

{@inheritDoc }

createClassInfo

protected final AbstractTypeAwareCheck.ClassInfo createClassInfo(AbstractTypeAwareCheck.Token aName, String aSurroundingClass)

Creates class info for given name.

Parameters: aName name of type. aSurroundingClass name of surrounding class.

Returns: class infor for given name.

findClassAlias

protected final AbstractTypeAwareCheck.ClassInfo findClassAlias(String aName)

Looking if a given name is alias.

Parameters: aName given name

Returns: ClassInfo for alias if it exists, null otherwise

getCurrentClassName

protected final String getCurrentClassName()

Returns current class.

Returns: name of current class.

getRequiredTokens

public final int[] getRequiredTokens()

{@inheritDoc }

isSubclass

protected boolean isSubclass(Class aChild, Class aParent)

Checks if one class is subclass of another

Parameters: aChild Class of class which should be child aParent Class of class which should be parent

Returns: true if aChild is subclass of aParent false otherwise

isUnchecked

protected boolean isUnchecked(Class aException)

Is exception is unchecked (subclass of RuntimeException or Error

Parameters: aException Class of exception to check

Returns: true if exception is unchecked false if exception is checked

leaveAST

protected void leaveAST(DetailAST aAST)

Called when exiting an AST. A no-op by default, extending classes may choose to override this to augment their processing.

Parameters: aAST the AST we are departing. Guaranteed to not be PACKAGE_DEF, CLASS_DEF, or IMPORT

leaveToken

public final void leaveToken(DetailAST aAST)

{@inheritDoc }

logLoadError

protected abstract void logLoadError(AbstractTypeAwareCheck.Token aIdent)

Logs error if unable to load class information. Abstract, should be overrided in subclasses.

Parameters: aIdent class name for which we can no load class.

logLoadErrorImpl

protected final void logLoadErrorImpl(int aLineNo, int aColumnNo, String aMsgKey, Object[] aValues)

Common implementation for logLoadError() method.

Parameters: aLineNo line number of the problem. aColumnNo column number of the problem. aMsgKey message key to use. aValues values to fill the message out.

processAST

protected abstract void processAST(DetailAST aAST)

Called to process an AST when visiting it.

Parameters: aAST the AST to process. Guaranteed to not be PACKAGE_DEF or IMPORT tokens.

resolveClass

protected final Class resolveClass(String aClassName, String aCurrentClass)

Attempts to resolve the Class for a specified name.

Parameters: aClassName name of the class to resolve aCurrentClass name of surrounding class.

Returns: the resolved class or null if unable to resolve the class.

setLogLoadErrors

public final void setLogLoadErrors(boolean aLogLoadErrors)

Controls whether to log class loading errors to the checkstyle report instead of throwing a RTE.

Parameters: aLogLoadErrors true if errors should be logged

setSuppressLoadErrors

public final void setSuppressLoadErrors(boolean aSuppressLoadErrors)

Controls whether to show class loading errors in the checkstyle report.

Parameters: aSuppressLoadErrors true if errors shouldn't be shown

tryLoadClass

protected final Class tryLoadClass(AbstractTypeAwareCheck.Token aIdent, String aCurrentClass)

Tries to load class. Logs error if unable.

Parameters: aIdent name of class which we try to load. aCurrentClass name of surrounding class.

Returns: Class for a ident.

visitToken

public final void visitToken(DetailAST aAST)

{@inheritDoc }