Package com.puppycrawl.tools.checkstyle.meta

Class ModulePropertyDetails

java.lang.Object

com.puppycrawl.tools.checkstyle.meta.ModulePropertyDetails

public final class ModulePropertyDetails
extends Object

Simple POJO class module's property details.

Field Summary

Fields

Modifier and Type	Field	Description
private String	defaultValue	Default value of property.
private String	description	Description of property.
private String	name	Name of property.
private String	type	Type of property.
private String	validationType	This property is java type that plugins can use to validate user input, it is used when 'type' field is "String".

Constructor Summary

Constructors

Constructor	Description
ModulePropertyDetails()	No-argument constructor.
ModulePropertyDetails(String name, String type, String defaultValue, String validationType, String description)	All-argument constructor.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Get default value of property.
String	getDescription()	Get description of property.
String	getName()	Get name of property.
String	getType()	Get type of property.
String	getValidationType()	Get validation type of property.
void	setDefaultValue(String defaultValue)	Set default value of property.
void	setDescription(String description)	Set description of property.
void	setName(String name)	Set name of property.
void	setType(String type)	Set property type.
void	setValidationType(String validationType)	Set validation type of property.

Methods inherited from class java.lang.Object

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

Field Details

name

private String name

Name of property.

type

private String type

Type of property.

defaultValue

private String defaultValue

Default value of property.

validationType

private String validationType

This property is java type that plugins can use to validate user input, it is used when 'type' field is "String". It is used for special cases such as regexp and tokenSet.

description

private String description

Description of property.

Constructor Details

ModulePropertyDetails

public ModulePropertyDetails()

No-argument constructor.

ModulePropertyDetails

public ModulePropertyDetails(String name,
 String type,
 String defaultValue,
 String validationType,
 String description)

All-argument constructor.

Parameters:

name - name.

type - type.

defaultValue - default value.

validationType - validation type.

description - description.

Method Details

getName

public String getName()

Get name of property.

Returns:

name of property

setName

public void setName(String name)

Set name of property.

Parameters:

name - name of property

getType

public String getType()

Get type of property.

Returns:

property type

setType

public void setType(String type)

Set property type.

Parameters:

type - property type

getDefaultValue

public String getDefaultValue()

Get default value of property.

Returns:

default value of property

setDefaultValue

public void setDefaultValue(String defaultValue)

Set default value of property.

Parameters:

defaultValue - default value of property

getValidationType

public String getValidationType()

Get validation type of property.

Returns:

validation type of property

setValidationType

public void setValidationType(String validationType)

Set validation type of property.

Parameters:

validationType - validation type of property

getDescription

public String getDescription()

Get description of property.

Returns:

property description

setDescription

public void setDescription(String description)

Set description of property.

Parameters:

description - property description