com.puppycrawl.tools.checkstyle.checks
public abstract class AbstractTypeAwareCheck extends Check
Version: 1.0
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) {@inheritDoc} |
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() {@inheritDoc} |
protected boolean | isSameType(String aFirst, String aSecond)
Return if two Strings represent the same type, inspecting the
import statements if necessary
|
protected boolean | isShortName(String aShortName, String aFullName)
Calculate if one type name is a shortname for another type name. |
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) {@inheritDoc} |
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. |
protected Class | tryLoadClass(AbstractTypeAwareCheck.Token aIdent, String aCurrentClass)
Tries to load class. |
void | visitToken(DetailAST aAST) {@inheritDoc} |
Parameters: aName name of type. aSurroundingClass name of surrounding class.
Returns: class infor for given name.
Parameters: aName given name
Returns: ClassInfo for alias if it exists, null otherwise
Returns: name of current class.
Parameters: aFirst first type declared in throws clause aSecond second type declared in thros tag
Returns: true iff type names represent the same type
Parameters: aShortName a shorthand, such as IOException
aFullName a full name, such as java.io.IOException
Returns: true iff aShortName represents the same type as aFullName
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
RuntimeException
or Error
Parameters: aException Class
of exception to check
Returns: true if exception is unchecked false if exception is checked
Parameters: aAST the AST we are departing. Guaranteed to not be PACKAGE_DEF, CLASS_DEF, or IMPORT
Parameters: aIdent class name for which we can no load class.
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.
Parameters: aAST the AST to process. Guaranteed to not be PACKAGE_DEF or IMPORT tokens.
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.
Parameters: aIdent name of class which we try to load. aCurrentClass name of surrounding class.
Returns: Class
for a ident.