Package com.puppycrawl.tools.checkstyle.meta

Class ModuleDetails

java.lang.Object

com.puppycrawl.tools.checkstyle.meta.ModuleDetails

public final class ModuleDetails
extends Object

Simple POJO class for module details.

Field Summary

Fields

Modifier and Type	Field	Description
private String	description	Description of the module.
private String	fullQualifiedName	Fully qualified name of the module.
private ModuleType	moduleType	Type of the module(check/filter/filefilter).
private String	name	Name of the module.
private String	parent	Parent module.
private final List<ModulePropertyDetails>	properties	List of properties of the module.
private final List<String>	violationMessageKeys	List of violation message keys of the module.

Constructor Summary

Constructors

Constructor	Description
ModuleDetails()	No-argument constructor.
ModuleDetails(String name, String fullQualifiedName, String parent, String description, ModuleType moduleType, List<ModulePropertyDetails> properties, List<String> violationMessageKeys)	All-argument constructor.

Method Summary

Modifier and Type	Method	Description
void	addToProperties(ModulePropertyDetails property)	Add a single module property to the module's property list and map both.
void	addToProperties(List<ModulePropertyDetails> modulePropertyDetailsList)	Add a list of properties to the module's property list and map both.
void	addToViolationMessages(String msg)	Add a key to the violation message key list of the module.
void	addToViolationMessages(List<String> msgList)	Add a list of keys to the violation message key list of the module.
String	getDescription()	Get description of module.
String	getFullQualifiedName()	Get fully qualified name of module.
ModuleType	getModuleType()	Get module type.
String	getName()	Get name of module.
String	getParent()	Get parent of module.
List<ModulePropertyDetails>	getProperties()	Get property list of module.
List<String>	getViolationMessageKeys()	Get violation message keys of the module.
void	setDescription(String description)	Set description of module.
void	setFullQualifiedName(String fullQualifiedName)	Set fully qualified name of module.
void	setModuleType(ModuleType moduleType)	Set type of module.
void	setName(String name)	Set name of module.
void	setParent(String parent)	Set parent of module.

Methods inherited from class java.lang.Object

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

Field Details

properties

private final List<ModulePropertyDetails> properties

List of properties of the module.

violationMessageKeys

private final List<String> violationMessageKeys

List of violation message keys of the module.

name

private String name

Name of the module.

fullQualifiedName

private String fullQualifiedName

Fully qualified name of the module.

parent

private String parent

Parent module.

description

private String description

Description of the module.

moduleType

private ModuleType moduleType

Type of the module(check/filter/filefilter).

Constructor Details

ModuleDetails

public ModuleDetails()

No-argument constructor.

ModuleDetails

public ModuleDetails(String name,
 String fullQualifiedName,
 String parent,
 String description,
 ModuleType moduleType,
 List<ModulePropertyDetails> properties,
 List<String> violationMessageKeys)

All-argument constructor.

Parameters:

name - name.

fullQualifiedName - full qualified name.

parent - parent.

description - description.

moduleType - module type.

properties - properties.

violationMessageKeys - violation message keys.

Method Details

getName

public String getName()

Get name of module.

Returns:

name of module

setName

public void setName(String name)

Set name of module.

Parameters:

name - module name

getFullQualifiedName

public String getFullQualifiedName()

Get fully qualified name of module.

Returns:

fully qualified name of module

setFullQualifiedName

public void setFullQualifiedName(String fullQualifiedName)

Set fully qualified name of module.

Parameters:

fullQualifiedName - fully qualified name of module

getParent

public String getParent()

Get parent of module.

Returns:

parent of module

setParent

public void setParent(String parent)

Set parent of module.

Parameters:

parent - parent of module

getDescription

public String getDescription()

Get description of module.

Returns:

description of module

setDescription

public void setDescription(String description)

Set description of module.

Parameters:

description - description of module

getProperties

public List<ModulePropertyDetails> getProperties()

Get property list of module.

Returns:

property list of module

addToProperties

public void addToProperties(ModulePropertyDetails property)

Add a single module property to the module's property list and map both.

Parameters:

property - module property

addToProperties

public void addToProperties(List<ModulePropertyDetails> modulePropertyDetailsList)

Add a list of properties to the module's property list and map both.

Parameters:

modulePropertyDetailsList - list of module property

getViolationMessageKeys

public List<String> getViolationMessageKeys()

Get violation message keys of the module.

Returns:

violation message keys of module

addToViolationMessages

public void addToViolationMessages(String msg)

Add a key to the violation message key list of the module.

Parameters:

msg - violation message key

addToViolationMessages

public void addToViolationMessages(List<String> msgList)

Add a list of keys to the violation message key list of the module.

Parameters:

msgList - a list of violation message keys

getModuleType

public ModuleType getModuleType()

Get module type.

Returns:

module type

setModuleType

public void setModuleType(ModuleType moduleType)

Set type of module.

Parameters:

moduleType - type of module