org.somox.configuration

Class ConfigurationDefinition

java.lang.Object

org.somox.configuration.ConfigurationDefinition

public class ConfigurationDefinition
extends Object

Configuration Object defining a configuration Element

Author:

Benjamin Klatt

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationDefinition.Type The available types for configuration fields

Field Summary

Fields

Modifier and Type	Field and Description
static int	MULIPLICITY_UNLIMITED Indicator for an unlimited multiplicity

Constructor Summary

Constructors

Constructor and Description
ConfigurationDefinition(String id, String name, ConfigurationDefinition.Type type) Constructor requiring the minimum of definitions
ConfigurationDefinition(String id, String name, ConfigurationDefinition.Type type, String defaultValue) Constructor requiring the basic information and the default value
ConfigurationDefinition(String id, String name, ConfigurationDefinition.Type type, String defaultValue, boolean required) Constructor requiring the basic information and the default value
ConfigurationDefinition(String id, String name, ConfigurationDefinition.Type type, String defaultValue, List<String> possibleValues, int multiplicity, boolean required) Constructor requiring the complete set of definitions

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultValue()
String	getId()
int	getMultiplicity()
String	getName()
List<String>	getPossibleValues()
ConfigurationDefinition.Type	getType()
boolean	isRequired()
void	setDefaultValue(String defaultValue)
void	setId(String id)
void	setMultiplicity(int multiplicity)
void	setName(String name)
void	setPossibleValues(List<String> possibleValues)
void	setRequired(boolean required)
void	setType(ConfigurationDefinition.Type type)

Methods inherited from class java.lang.Object

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

Field Detail

MULIPLICITY_UNLIMITED

public static int MULIPLICITY_UNLIMITED

Indicator for an unlimited multiplicity

Constructor Detail

ConfigurationDefinition

public ConfigurationDefinition(String id,
                       String name,
                       ConfigurationDefinition.Type type,
                       String defaultValue,
                       List<String> possibleValues,
                       int multiplicity,
                       boolean required)

Constructor requiring the complete set of definitions

Parameters:

id - The identifier for the parameter

name - The name of the parameter

type - The type of the parameter

defaultValue - The defaultValue

possibleValues - The possible values for this configuration

multiplicity - The maximum number of possibleValues for this configuration

required - Flag whether this configuration is required

ConfigurationDefinition

public ConfigurationDefinition(String id,
                       String name,
                       ConfigurationDefinition.Type type,
                       String defaultValue)

Constructor requiring the basic information and the default value

Parameters:

id - The identifier for the parameter

name - The name of the parameter

type - The type of the parameter

defaultValue - The defaultValue

ConfigurationDefinition

public ConfigurationDefinition(String id,
                       String name,
                       ConfigurationDefinition.Type type,
                       String defaultValue,
                       boolean required)

Constructor requiring the basic information and the default value

Parameters:

id - The identifier for the parameter

name - The name of the parameter

type - The type of the parameter

defaultValue - The defaultValue

required - Flag whether this configuration is required

ConfigurationDefinition

public ConfigurationDefinition(String id,
                       String name,
                       ConfigurationDefinition.Type type)

Constructor requiring the minimum of definitions

Parameters:

id - The identifier for the parameter

name - The name of the parameter

type - The type of the parameter

Method Detail

getId

public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - the id to set

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getType

public ConfigurationDefinition.Type getType()

Returns:

the type

setType

public void setType(ConfigurationDefinition.Type type)

Parameters:

type - the type to set

getDefaultValue

public String getDefaultValue()

Returns:

the defaultValue

setDefaultValue

public void setDefaultValue(String defaultValue)

Parameters:

defaultValue - the defaultValue to set

setPossibleValues

public void setPossibleValues(List<String> possibleValues)

Parameters:

possibleValues - the possibleValues to set

getPossibleValues

public List<String> getPossibleValues()

Returns:

the possibleValues

setMultiplicity

public void setMultiplicity(int multiplicity)

Parameters:

multiplicity - the multiplicity to set

getMultiplicity

public int getMultiplicity()

Returns:

the multiplicity

setRequired

public void setRequired(boolean required)

Parameters:

required - the required to set

isRequired

public boolean isRequired()

Returns:

the required