com.puppycrawl.tools.checkstyle.utils

Class ModuleReflectionUtils

java.lang.Object

com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtils

public final class ModuleReflectionUtils
extends java.lang.Object

Contains utility methods for module reflection.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ModuleReflectionUtils() Prevent instantiation.

Method Summary

Modifier and Type	Method and Description
static java.util.Set<java.lang.Class<?>>	getCheckstyleModules(java.util.Collection<java.lang.String> packages, java.lang.ClassLoader loader) Gets checkstyle's modules (directly, not recursively) in the given packages.
static boolean	isCheckstyleCheck(java.lang.Class<?> clazz) Checks whether a class may be considered as the checkstyle check.
static boolean	isCheckstyleModule(java.lang.Class<?> clazz) Checks whether a class may be considered as a checkstyle module.
static boolean	isFileFilterModule(java.lang.Class<?> clazz) Checks whether a class may be considered as the checkstyle file filter.
static boolean	isFileSetModule(java.lang.Class<?> clazz) Checks whether a class may be considered as the checkstyle file set.
static boolean	isFilterModule(java.lang.Class<?> clazz) Checks whether a class may be considered as the checkstyle filter.
static boolean	isRootModule(java.lang.Class<?> clazz) Checks whether a class may be considered as the checkstyle root module.
static boolean	isValidCheckstyleClass(java.lang.Class<?> clazz) Checks whether a class extends 'AutomaticBean' and is non-abstract.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleReflectionUtils

private ModuleReflectionUtils()

Prevent instantiation.

Method Detail

getCheckstyleModules

public static java.util.Set<java.lang.Class<?>> getCheckstyleModules(java.util.Collection<java.lang.String> packages,
                                                                     java.lang.ClassLoader loader)
                                                              throws java.io.IOException

Gets checkstyle's modules (directly, not recursively) in the given packages.

Parameters:

packages - the collection of package names to use

loader - the class loader used to load Checkstyle package names

Returns:

the set of checkstyle's module classes

Throws:

java.io.IOException - if the attempt to read class path resources failed

See Also:

isCheckstyleModule(Class)

isCheckstyleModule

public static boolean isCheckstyleModule(java.lang.Class<?> clazz)

Checks whether a class may be considered as a checkstyle module. Checkstyle's modules are non-abstract classes, which are either checkstyle's checks, file sets, filters, file filters, or root module.

Parameters:

clazz - class to check.

Returns:

true if the class may be considered as the checkstyle module.

isValidCheckstyleClass

public static boolean isValidCheckstyleClass(java.lang.Class<?> clazz)

Checks whether a class extends 'AutomaticBean' and is non-abstract.

Parameters:

clazz - class to check.

Returns:

true if a class may be considered a valid production class.

isCheckstyleCheck

public static boolean isCheckstyleCheck(java.lang.Class<?> clazz)

Checks whether a class may be considered as the checkstyle check. 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(java.lang.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(java.lang.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(java.lang.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.

isRootModule

public static boolean isRootModule(java.lang.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.