Package com.puppycrawl.tools.checkstyle

Class ThreadModeSettings

java.lang.Object

com.puppycrawl.tools.checkstyle.ThreadModeSettings

All Implemented Interfaces:

java.io.Serializable

public class ThreadModeSettings
extends java.lang.Object
implements java.io.Serializable

Thread mode settings for the checkstyle modules.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CHECKER_MODULE_NAME	A checker module name.
static java.lang.String	MULTI_THREAD_CHECKER_MODULE_NAME	A multi thread checker module name.
static java.lang.String	MULTI_THREAD_TREE_WALKER_MODULE_NAME	A multi thread three walker module name.
static ThreadModeSettings	SINGLE_THREAD_MODE_INSTANCE	A single thread mode settings instance.
static java.lang.String	TREE_WALKER_MODULE_NAME	A three walker module name.

Constructor Summary

Constructors

Constructor	Description
ThreadModeSettings(int checkerThreadsNumber, int treeWalkerThreadsNumber)	Initializes the thread mode configuration.

Method Summary

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.
java.lang.String	resolveName(java.lang.String name)	Resolves the module name according to the thread settings.

Methods inherited from class java.lang.Object

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

Field Detail

CHECKER_MODULE_NAME

public static final java.lang.String CHECKER_MODULE_NAME

A checker module name.

MULTI_THREAD_CHECKER_MODULE_NAME

public static final java.lang.String MULTI_THREAD_CHECKER_MODULE_NAME

A multi thread checker module name.

TREE_WALKER_MODULE_NAME

public static final java.lang.String TREE_WALKER_MODULE_NAME

A three walker module name.

MULTI_THREAD_TREE_WALKER_MODULE_NAME

public static final java.lang.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.

Constructor Detail

ThreadModeSettings

public ThreadModeSettings(int checkerThreadsNumber,
                          int treeWalkerThreadsNumber)

Initializes the thread mode configuration.

Parameters:

checkerThreadsNumber - the Checker threads number

treeWalkerThreadsNumber - 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 java.lang.String resolveName(java.lang.String name)

Resolves the module name according to the thread settings.

Parameters:

name - The original module name.

Returns:

resolved module name.

Throws:

java.lang.IllegalArgumentException - when name is Checker or TreeWalker