org.eclipse.higgins.configuration.common
Class SettingDescriptor

java.lang.Object
  org.eclipse.higgins.configuration.common.SettingDescriptor

All Implemented Interfaces:

org.eclipse.higgins.configuration.api.ISettingDescriptor

public class SettingDescriptor

extends Object

implements org.eclipse.higgins.configuration.api.ISettingDescriptor

Describes the properties of a setting used to configure a component. (See IConfigurableComponent.)

Author:

gbyrd

Field Summary

static String	CONSTRAINT_CONFIGURABLE_STRING For object settings, set true if IConfigurableComponent.
static String	CONSTRAINT_DEFAULT_VALUE_STRING For any setting, default value.
static String	CONSTRAINT_ELEMENT_TYPE_STRING For list/map settings, type of subsettings (if not explicitly listed).
static String	CONSTRAINT_MAX_ELEMENTS_STRING For list/map settings, maximum number of subsettings.
static String	CONSTRAINT_MAX_VALUE_STRING For integer/float settings, maximum allowable value.
static String	CONSTRAINT_MAX_WIDTH_STRING For string-like settings, maximum width (characters).
static String	CONSTRAINT_MIN_ELEMENTS_STRING For list/map settings, minimum number of subsettings.
static String	CONSTRAINT_MIN_VALUE_STRING For integer/float settings, minimum allowable value.
static String	CONSTRAINT_MIN_WIDTH_STRING For string-like settings, minimum width (characters).
static String	CONSTRAINT_REQUIRED_STRING For any setting, set true if setting is required.
static String	CONSTRAINT_SINGLETON_STRING For component settings, set true if should be created as a singleton.

Constructor Summary

SettingDescriptor()

SettingDescriptor(String name, Class type, String displayString, String docString)

Method Summary

void	addConstraint(String name, Object value)
void	addSubSetting(int index, org.eclipse.higgins.configuration.api.ISettingDescriptor sub)
void	addSubSetting(org.eclipse.higgins.configuration.api.ISettingDescriptor sub)
Object	getConstraint(String key)
String	getDisplayString()
String	getDocString()
String	getName()
List	getSubSettings()
Class	getType()
void	removeConstraint(String name)
org.eclipse.higgins.configuration.api.ISettingDescriptor	removeSubSetting(int index)
boolean	removeSubSetting(org.eclipse.higgins.configuration.api.ISettingDescriptor sub)
void	setDisplayString(String display)
void	setDocString(String doc)
void	setName(String name)
void	setType(Class type)

Methods inherited from class java.lang.Object

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

Field Detail

CONSTRAINT_MIN_VALUE_STRING

public static final String CONSTRAINT_MIN_VALUE_STRING

For integer/float settings, minimum allowable value.

See Also:

Constant Field Values

CONSTRAINT_MAX_VALUE_STRING

public static final String CONSTRAINT_MAX_VALUE_STRING

For integer/float settings, maximum allowable value.

See Also:

Constant Field Values

CONSTRAINT_DEFAULT_VALUE_STRING

public static final String CONSTRAINT_DEFAULT_VALUE_STRING

For any setting, default value.

See Also:

Constant Field Values

CONSTRAINT_MIN_WIDTH_STRING

public static final String CONSTRAINT_MIN_WIDTH_STRING

For string-like settings, minimum width (characters).

See Also:

Constant Field Values

CONSTRAINT_MAX_WIDTH_STRING

public static final String CONSTRAINT_MAX_WIDTH_STRING

For string-like settings, maximum width (characters).

See Also:

Constant Field Values

CONSTRAINT_REQUIRED_STRING

public static final String CONSTRAINT_REQUIRED_STRING

For any setting, set true if setting is required.

See Also:

Constant Field Values

CONSTRAINT_MIN_ELEMENTS_STRING

public static final String CONSTRAINT_MIN_ELEMENTS_STRING

For list/map settings, minimum number of subsettings.

See Also:

Constant Field Values

CONSTRAINT_MAX_ELEMENTS_STRING

public static final String CONSTRAINT_MAX_ELEMENTS_STRING

For list/map settings, maximum number of subsettings.

See Also:

Constant Field Values

CONSTRAINT_ELEMENT_TYPE_STRING

public static final String CONSTRAINT_ELEMENT_TYPE_STRING

For list/map settings, type of subsettings (if not explicitly listed).

See Also:

Constant Field Values

CONSTRAINT_CONFIGURABLE_STRING

public static final String CONSTRAINT_CONFIGURABLE_STRING

For object settings, set true if IConfigurableComponent.

See Also:

Constant Field Values

CONSTRAINT_SINGLETON_STRING

public static final String CONSTRAINT_SINGLETON_STRING

For component settings, set true if should be created as a singleton.

See Also:

Constant Field Values

Constructor Detail

SettingDescriptor

public SettingDescriptor(String name,
                         Class type,
                         String displayString,
                         String docString)

SettingDescriptor

public SettingDescriptor()

Method Detail

getName

public String getName()

Specified by:

getName in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

getType

public Class getType()

Specified by:

getType in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

getDisplayString

public String getDisplayString()

Specified by:

getDisplayString in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

getDocString

public String getDocString()

Specified by:

getDocString in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

getSubSettings

public List getSubSettings()

Specified by:

getSubSettings in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

getConstraint

public Object getConstraint(String key)

Specified by:

getConstraint in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

setName

public void setName(String name)

Specified by:

setName in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

setType

public void setType(Class type)

Specified by:

setType in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

setDisplayString

public void setDisplayString(String display)

Specified by:

setDisplayString in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

setDocString

public void setDocString(String doc)

Specified by:

setDocString in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

addConstraint

public void addConstraint(String name,
                          Object value)

Specified by:

addConstraint in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

removeConstraint

public void removeConstraint(String name)

Specified by:

removeConstraint in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

addSubSetting

public void addSubSetting(org.eclipse.higgins.configuration.api.ISettingDescriptor sub)

Specified by:

addSubSetting in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

addSubSetting

public void addSubSetting(int index,
                          org.eclipse.higgins.configuration.api.ISettingDescriptor sub)

Specified by:

addSubSetting in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

removeSubSetting

public boolean removeSubSetting(org.eclipse.higgins.configuration.api.ISettingDescriptor sub)

Specified by:

removeSubSetting in interface org.eclipse.higgins.configuration.api.ISettingDescriptor

removeSubSetting

public org.eclipse.higgins.configuration.api.ISettingDescriptor removeSubSetting(int index)

Specified by:

removeSubSetting in interface org.eclipse.higgins.configuration.api.ISettingDescriptor