org.sonar.sslr.toolkit

Class ConfigurationProperty

java.lang.Object

org.sonar.sslr.toolkit.ConfigurationProperty

public class ConfigurationProperty
extends Object

This class represents a configuration property, which is made of a name, a description (which may be empty), a default value, and optionnally a validation callback.

Since:

1.17

Constructor Summary

Constructors

Constructor and Description
ConfigurationProperty(String name, String description, String defaultValue)
ConfigurationProperty(String name, String description, String defaultValue, ValidationCallback validationCallback)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
String	getName()
String	getValue()
void	setValue(String value)
String	validate(String newValueCandidate)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationProperty

public ConfigurationProperty(String name,
                     String description,
                     String defaultValue)

ConfigurationProperty

public ConfigurationProperty(String name,
                     String description,
                     String defaultValue,
                     ValidationCallback validationCallback)

Parameters:

name -

description -

defaultValue -

validationCallback - The validation callback. Note that handy ones are available out-of-the-box by the Validators class.

Method Detail

getName

public String getName()

getDescription

public String getDescription()

validate

public String validate(String newValueCandidate)

setValue

public void setValue(String value)

getValue

public String getValue()