Class ModuleDetails
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.meta.ModuleDetails
-
public final class ModuleDetails extends java.lang.Object
Simple POJO class for module details.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
description
Description of the module.private java.lang.String
fullQualifiedName
Fully qualified name of the module.private ModuleType
moduleType
Type of the module(check/filter/filefilter).private java.lang.String
name
Name of the module.private java.lang.String
parent
Parent module.private java.util.List<ModulePropertyDetails>
properties
List of properties of the module.private java.util.List<java.lang.String>
violationMessageKeys
List of violation message keys of the module.
-
Constructor Summary
Constructors Constructor Description ModuleDetails()
-
Method Summary
All Methods Instance Methods Concrete Methods 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(java.util.List<ModulePropertyDetails> modulePropertyDetailsList)
Add a list of properties to the module's property list and map both.void
addToViolationMessages(java.lang.String msg)
Add a key to the violation message key list of the module.void
addToViolationMessages(java.util.List<java.lang.String> msgList)
Add a list of keys to the violation message key list of the module.java.lang.String
getDescription()
Get description of module.java.lang.String
getFullQualifiedName()
Get fully qualified name of module.ModuleType
getModuleType()
Get module type.java.lang.String
getName()
Get name of module.java.lang.String
getParent()
Get parent of module.java.util.List<ModulePropertyDetails>
getProperties()
Get property list of module.java.util.List<java.lang.String>
getViolationMessageKeys()
Get violation message keys of the module.void
setDescription(java.lang.String description)
Set description of module.void
setFullQualifiedName(java.lang.String fullQualifiedName)
Set fully qualified name of module.void
setModuleType(ModuleType moduleType)
Set type of module.void
setName(java.lang.String name)
Set name of module.void
setParent(java.lang.String parent)
Set parent of module.
-
-
-
Field Detail
-
properties
private final java.util.List<ModulePropertyDetails> properties
List of properties of the module.
-
violationMessageKeys
private final java.util.List<java.lang.String> violationMessageKeys
List of violation message keys of the module.
-
name
private java.lang.String name
Name of the module.
-
fullQualifiedName
private java.lang.String fullQualifiedName
Fully qualified name of the module.
-
parent
private java.lang.String parent
Parent module.
-
description
private java.lang.String description
Description of the module.
-
moduleType
private ModuleType moduleType
Type of the module(check/filter/filefilter).
-
-
Constructor Detail
-
ModuleDetails
public ModuleDetails()
-
-
Method Detail
-
getName
public java.lang.String getName()
Get name of module.- Returns:
- name of module
-
setName
public void setName(java.lang.String name)
Set name of module.- Parameters:
name
- module name
-
getFullQualifiedName
public java.lang.String getFullQualifiedName()
Get fully qualified name of module.- Returns:
- fully qualified name of module
-
setFullQualifiedName
public void setFullQualifiedName(java.lang.String fullQualifiedName)
Set fully qualified name of module.- Parameters:
fullQualifiedName
- fully qualified name of module
-
getParent
public java.lang.String getParent()
Get parent of module.- Returns:
- parent of module
-
setParent
public void setParent(java.lang.String parent)
Set parent of module.- Parameters:
parent
- parent of module
-
getDescription
public java.lang.String getDescription()
Get description of module.- Returns:
- description of module
-
setDescription
public void setDescription(java.lang.String description)
Set description of module.- Parameters:
description
- description of module
-
getProperties
public java.util.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(java.util.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 java.util.List<java.lang.String> getViolationMessageKeys()
Get violation message keys of the module.- Returns:
- violation message keys of module
-
addToViolationMessages
public void addToViolationMessages(java.lang.String msg)
Add a key to the violation message key list of the module.- Parameters:
msg
- violation message key
-
addToViolationMessages
public void addToViolationMessages(java.util.List<java.lang.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
-
-