Class ModuleReflectionUtil
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil
-
public final class ModuleReflectionUtil extends Object
Contains utility methods for module reflection.
-
-
Constructor Summary
Constructors Modifier Constructor Description private
ModuleReflectionUtil()
Prevent instantiation.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Set<Class<?>>
getCheckstyleModules(Collection<String> packages, ClassLoader loader)
Gets checkstyle's modules classes (directly, not recursively) in the given packages.private static boolean
hasDefaultConstructor(Class<?> clazz)
Checks if the class has a default constructor.static boolean
isAuditListener(Class<?> clazz)
Checks whether a class may be considered as the checkstyle audit listener module.static boolean
isCheckstyleModule(Class<?> clazz)
Checks whether a class may be considered as a checkstyle module.static boolean
isCheckstyleTreeWalkerCheck(Class<?> clazz)
Checks whether a class may be considered as the checkstyle check which has TreeWalker as a parent.static boolean
isFileFilterModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyle file filter.static boolean
isFileSetModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyle file set.static boolean
isFilterModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyle filter.private static boolean
isNotXpathFileGenerator(Class<?> clazz)
Checks whether a class isXpathFileGeneratorAstFilter
orXpathFileGeneratorAuditListener
.static boolean
isRootModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyle root module.static boolean
isTreeWalkerFilterModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyleTreeWalker
filter.
-
-
-
Constructor Detail
-
ModuleReflectionUtil
private ModuleReflectionUtil()
Prevent instantiation.
-
-
Method Detail
-
getCheckstyleModules
public static Set<Class<?>> getCheckstyleModules(Collection<String> packages, ClassLoader loader) throws IOException
Gets checkstyle's modules classes (directly, not recursively) in the given packages.- Parameters:
packages
- the collection of package names to useloader
- the class loader used to load Checkstyle package names- Returns:
- the set of checkstyle's module classes
- Throws:
IOException
- if the attempt to read class path resources failed- See Also:
isCheckstyleModule(Class)
-
isCheckstyleModule
public static boolean isCheckstyleModule(Class<?> clazz)
Checks whether a class may be considered as a checkstyle module. Checkstyle's modules are classes which extend 'AutomaticBean', is non-abstract, and has a default constructor.- Parameters:
clazz
- class to check.- Returns:
- true if a class may be considered a valid production class.
-
hasDefaultConstructor
private static boolean hasDefaultConstructor(Class<?> clazz)
Checks if the class has a default constructor.- Parameters:
clazz
- class to check- Returns:
- true if the class has a default constructor.
-
isCheckstyleTreeWalkerCheck
public static boolean isCheckstyleTreeWalkerCheck(Class<?> clazz)
Checks whether a class may be considered as the checkstyle check which has TreeWalker as a parent. Checkstyle's checks are classes which implement 'AbstractCheck' interface.- Parameters:
clazz
- class to check.- Returns:
- true if a class may be considered as the checkstyle check.
-
isFileSetModule
public static boolean isFileSetModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyle file set. Checkstyle's file sets are classes which implement 'AbstractFileSetCheck' interface.- Parameters:
clazz
- class to check.- Returns:
- true if a class may be considered as the checkstyle file set.
-
isFilterModule
public static boolean isFilterModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyle filter. Checkstyle's filters are classes which implement 'Filter' interface.- Parameters:
clazz
- class to check.- Returns:
- true if a class may be considered as the checkstyle filter.
-
isFileFilterModule
public static boolean isFileFilterModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyle file filter. Checkstyle's file filters are classes which implement 'BeforeExecutionFileFilter' interface.- Parameters:
clazz
- class to check.- Returns:
- true if a class may be considered as the checkstyle file filter.
-
isAuditListener
public static boolean isAuditListener(Class<?> clazz)
Checks whether a class may be considered as the checkstyle audit listener module. Checkstyle's audit listener modules are classes which implement 'AuditListener' interface.- Parameters:
clazz
- class to check.- Returns:
- true if a class may be considered as the checkstyle audit listener module.
-
isRootModule
public static boolean isRootModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyle root module. Checkstyle's root modules are classes which implement 'RootModule' interface.- Parameters:
clazz
- class to check.- Returns:
- true if a class may be considered as the checkstyle root module.
-
isTreeWalkerFilterModule
public static boolean isTreeWalkerFilterModule(Class<?> clazz)
Checks whether a class may be considered as the checkstyleTreeWalker
filter. Checkstyle'sTreeWalker
filters are classes which implement 'TreeWalkerFilter' interface.- Parameters:
clazz
- class to check.- Returns:
- true if a class may be considered as the checkstyle
TreeWalker
filter.
-
isNotXpathFileGenerator
private static boolean isNotXpathFileGenerator(Class<?> clazz)
Checks whether a class isXpathFileGeneratorAstFilter
orXpathFileGeneratorAuditListener
. See issue #102- Parameters:
clazz
- class to check.- Returns:
- true if a class name starts with `XpathFileGenerator`.
-
-