org.eth.cyril.settings

Class SelectionSetting

java.lang.Object

org.eth.cyril.settings.SchemaSetting

org.eth.cyril.settings.SelectionSetting

All Implemented Interfaces:

Setting, Validator

public class SelectionSetting
extends SchemaSetting

A setting which allows to select from a fixed set of objects.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eth.cyril.settings.Setting

Setting.DataType

Field Summary

Fields inherited from class org.eth.cyril.settings.SchemaSetting

owner

Constructor Summary

Constructors

Constructor and Description
SelectionSetting(java.lang.String fullName, java.lang.String nameToShow, boolean requiresRestart, java.lang.String... selection)
SelectionSetting(java.lang.String fullName, java.lang.String nameToShow, java.lang.String tooltip, boolean requiresRestart, java.lang.String... selection)

Method Summary

Modifier and Type	Method and Description
Setting.DataType	getDataType() The data type which this setting represents.
java.lang.String[]	getSelection() Gets the selection of strings that this setting may take.
boolean	validate(java.lang.Object input)

Methods inherited from class org.eth.cyril.settings.SchemaSetting

apply, getCurrentValue, getId, getName, getTooltip, requiresRestart

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionSetting

public SelectionSetting(java.lang.String fullName,
                        java.lang.String nameToShow,
                        boolean requiresRestart,
                        java.lang.String... selection)

SelectionSetting

public SelectionSetting(java.lang.String fullName,
                        java.lang.String nameToShow,
                        java.lang.String tooltip,
                        boolean requiresRestart,
                        java.lang.String... selection)

Method Detail

getSelection

public java.lang.String[] getSelection()

Description copied from interface: Setting

Gets the selection of strings that this setting may take. This method is only called if the Setting.getDataType() returns Setting.DataType.SELECTION. The default implementation therefore returns an empty array.

Returns:

The selection of strings for this setting. Meaningful only if this is a Setting.DataType.SELECTION.

validate

public boolean validate(java.lang.Object input)

Specified by:

validate in interface Validator

Overrides:

validate in class SchemaSetting

getDataType

public Setting.DataType getDataType()

Description copied from interface: Setting

The data type which this setting represents.

Specified by:

getDataType in interface Setting

Overrides:

getDataType in class SchemaSetting

Returns:

The data type represented by this setting.