Package com.puppycrawl.tools.checkstyle
Class ThreadModeSettings
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.ThreadModeSettings
-
- All Implemented Interfaces:
Serializable
public class ThreadModeSettings extends Object implements Serializable
Thread mode settings for the checkstyle modules.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
CHECKER_MODULE_NAME
A checker module name.private int
checkerThreadsNumber
The checker threads number.static String
MULTI_THREAD_CHECKER_MODULE_NAME
A multi thread checker module name.static String
MULTI_THREAD_TREE_WALKER_MODULE_NAME
A multi thread three walker module name.private static long
serialVersionUID
A unique serial version identifier.static ThreadModeSettings
SINGLE_THREAD_MODE_INSTANCE
A single thread mode settings instance.static String
TREE_WALKER_MODULE_NAME
A three walker module name.private int
treeWalkerThreadsNumber
The tree walker threads number.
-
Constructor Summary
Constructors Constructor Description ThreadModeSettings(int checkerThreadsNumber, int treeWalkerThreadsNumber)
Initializes the thread mode configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getCheckerThreadsNumber()
Gets the number of threads for the Checker module.int
getTreeWalkerThreadsNumber()
Gets the number of threads for the TreeWalker module.String
resolveName(String name)
Resolves the module name according to the thread settings.
-
-
-
Field Detail
-
CHECKER_MODULE_NAME
public static final String CHECKER_MODULE_NAME
A checker module name.
-
MULTI_THREAD_CHECKER_MODULE_NAME
public static final String MULTI_THREAD_CHECKER_MODULE_NAME
A multi thread checker module name.
-
TREE_WALKER_MODULE_NAME
public static final String TREE_WALKER_MODULE_NAME
A three walker module name.
-
MULTI_THREAD_TREE_WALKER_MODULE_NAME
public static final String MULTI_THREAD_TREE_WALKER_MODULE_NAME
A multi thread three walker module name.
-
SINGLE_THREAD_MODE_INSTANCE
public static final ThreadModeSettings SINGLE_THREAD_MODE_INSTANCE
A single thread mode settings instance.
-
serialVersionUID
private static final long serialVersionUID
A unique serial version identifier.- See Also:
- Constant Field Values
-
checkerThreadsNumber
private final int checkerThreadsNumber
The checker threads number.
-
treeWalkerThreadsNumber
private final int treeWalkerThreadsNumber
The tree walker threads number.
-
-
Constructor Detail
-
ThreadModeSettings
public ThreadModeSettings(int checkerThreadsNumber, int treeWalkerThreadsNumber)
Initializes the thread mode configuration.- Parameters:
checkerThreadsNumber
- the Checker threads numbertreeWalkerThreadsNumber
- the TreeWalker threads number
-
-
Method Detail
-
getCheckerThreadsNumber
public int getCheckerThreadsNumber()
Gets the number of threads for the Checker module.- Returns:
- the number of threads for the Checker module.
-
getTreeWalkerThreadsNumber
public int getTreeWalkerThreadsNumber()
Gets the number of threads for the TreeWalker module.- Returns:
- the number of threads for the TreeWalker module.
-
resolveName
public final String resolveName(String name)
Resolves the module name according to the thread settings.- Parameters:
name
- The original module name.- Returns:
- resolved module name.
- Throws:
IllegalArgumentException
- when name is Checker or TreeWalker
-
-