|
|||||||||
| Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ design overview ] | PREV NEXT | ||||||||
C
- com.puppycrawl.tools.checkstyle.checks.design - package com.puppycrawl.tools.checkstyle.checks.design
D
- DEFAULT_FORMAT - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- Default value for format property.
- DEFAULT_MAX - Static variable in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- default value of max property
- DesignForExtensionCheck - class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck.
- Checks that classes are designed for inheritance.
- DesignForExtensionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
- DesignForExtensionCheckTest - class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheckTest.
- DesignForExtensionCheckTest() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheckTest
F
- FinalClassCheck - class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.
- Checks that class which has only private ctors is declared as final.
- FinalClassCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
- FinalClassCheck.ClassDesc - class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc.
- maintains information about class' ctors
- FinalClassCheck.ClassDesc(boolean, boolean) - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- create a new ClassDesc instance.
- FinalClassCheckTest - class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheckTest.
- FinalClassCheckTest() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheckTest
- findContainingClass(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
- Searches the tree towards the root until it finds a CLASS_DEF node.
G
- getChecker() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheckTest
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- getDefaultTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- getMax() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- Getter for max property.
- getModifiers(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- Returns the set of modifier Strings for a VARIABLE_DEF AST.
- getPublicMemberRegexp() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- getRequiredTokens() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- getVarNameAST(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- Returns the variable name in a VARIABLE_DEF AST.
- getVisibilityScope(Set) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- Returns the visibility scope specified with a set of modifiers.
H
- HideUtilityClassConstructorCheck - class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.
- Make sure that utility classes (classes that contain only static methods) do not have a public constructor.
- HideUtilityClassConstructorCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
- HideUtilityClassConstructorCheckTest - class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheckTest.
- HideUtilityClassConstructorCheckTest() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheckTest
- hasNonPrivateCtor() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- does class have non-private ctors.
- hasPrivateCtor() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- does class have private ctors.
I
- InputMutableException - class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.
- InputMutableException() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException
- InputMutableException.FooError - class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooError.
- InputMutableException.FooError() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooError
- InputMutableException.FooException - class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooException.
- InputMutableException.FooException() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooException
- InputMutableException.FooException.FooExceptionThisIsNot - class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooException.FooExceptionThisIsNot.
- InputMutableException.FooException.FooExceptionThisIsNot() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooException.FooExceptionThisIsNot
- InputNonUtilityClass - class com.puppycrawl.tools.checkstyle.checks.design.InputNonUtilityClass.
- Not a util class because it's not directly derived from java.lang.Object.
- InputNonUtilityClass() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InputNonUtilityClass
- HideUtilityClassConstructorCheck should not report this
- InputThrowsCount - class com.puppycrawl.tools.checkstyle.checks.design.InputThrowsCount.
- InputThrowsCount() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InputThrowsCount
- InterfaceIsTypeCheck - class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck.
- Implements Bloch, Effective Java, Item 17 - Use Interfaces only to define types.
- InterfaceIsTypeCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- InterfaceIsTypeCheckTest - class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheckTest.
- InterfaceIsTypeCheckTest() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheckTest
- inInterfaceBlock(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- Returns whether an AST is in an interface block.
- isDeclaredAsAbstract() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- is class declared as abstract.
- isDeclaredAsFinal() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- is class declared as final.
- isExceptionClass(String) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- isPackageAllowed() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- isProtectedAllowed() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
L
- leaveClassDef() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- Called when we leave class definition.
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
- leaveToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
M
- MutableExceptionCheck - class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck.
- Ensures that exceptions (defined as any class name conforming to some regular expression) are immutable.
- MutableExceptionCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- Creates new instance of the check.
- MutableExceptionCheckTest - class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheckTest.
- MutableExceptionCheckTest() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheckTest
- mAllowMarkerInterfaces - Variable in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- flag to control whether marker interfaces are allowed.
- mChecking - Variable in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- Should we check current class or not.
- mCheckingStack - Variable in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- Stack of checking information for classes.
- mClasses - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
- keeps ClassDesc objects for stack of declared classes
- mDeclaredAsAbstract - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- is class declared as abstract
- mDeclaredAsFinal - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- is class declared as final
- mHasNonPrivateCtor - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- does class have non-provate ctors
- mHasPrivateCtor - Variable in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- does class have private ctors
- mMax - Variable in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- maximum allowed throws statments
- mPackageAllowed - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- whether package visible members are allowed
- mProtectedAllowed - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- whether protected members are allowed
- mPublicMemberPattern - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- pattern for public members that should be ignored.
- mPublicMemberRE - Variable in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- regexp for public members that should be ignored
- methdo2() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InputThrowsCount
- method1() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InputThrowsCount
- method3() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InputThrowsCount
- method4() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InputThrowsCount
- method5() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InputThrowsCount
- method6() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InputThrowsCount
R
- reportNonPrivateCtor() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- adds non-private ctor.
- reportPrivateCtor() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- adds private ctor.
S
- setAllowMarkerInterfaces(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- Controls whether marker interfaces like Serializable are allowed.
- setMax(int) - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- Setter for max property.
- setPackageAllowed(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- Set whether package visible members are allowed.
- setProtectedAllowed(boolean) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- Set whether protected members are allowed.
- setPublicMemberPattern(String) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- Set the pattern for public members to ignore.
T
- ThrowsCountCheck - class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck.
- Restricts throws statements to a specified count (default = 1).
- ThrowsCountCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- Creates new instance of the check.
- ThrowsCountCheckTest - class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheckTest.
- ThrowsCountCheckTest() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheckTest
- test() - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheckTest
- testAllowMarker() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheckTest
- testDefault() - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheckTest
- testDefault() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheckTest
- testDerivedNonUtilClass() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheckTest
- testFianlClass() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheckTest
- testIgnoreAccess() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheckTest
- testInner() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheckTest
- testIt() - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheckTest
- testMax() - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheckTest
- testNonUtilClass() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheckTest
- nonstatic methods - always OK
- testSimple() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheckTest
- testStrictJavadoc() - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheckTest
- testUtilClass() - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheckTest
- only static methods and no constructor - default ctor is visible
- toString() - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.ClassDesc
- Returns a string representation of the object.
U
- utilMethod() - Static method in class com.puppycrawl.tools.checkstyle.checks.design.InputNonUtilityClass
V
- VisibilityModifierCheck - class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck.
- Checks visibility of class members.
- VisibilityModifierCheck() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- Create an instance.
- VisibilityModifierCheckTest - class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheckTest.
- VisibilityModifierCheckTest() - Constructor for class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheckTest
- visitClassDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- Called when we start processing class definition.
- visitLiteralThrows(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- Checks number of throws statments.
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck
- visitToken(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck
- visitVariableDef(DetailAST) - Method in class com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck
- Checks variable definition.
_
- _errorCode - Variable in class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooError
- _errorCode - Variable in class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooException.FooExceptionThisIsNot
- _errorCode - Variable in class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooException
- _finalErrorCode - Variable in class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooException.FooExceptionThisIsNot
- _finalErrorCode - Variable in class com.puppycrawl.tools.checkstyle.checks.design.InputMutableException.FooException
C D F G H I L M R S T U V _
|
|||||||||
| Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ design overview ] | PREV NEXT | ||||||||