helix.util.ui.parameters
Class ListParameter

java.lang.Object
  |
  +--helix.util.ui.parameters.ObjectParameter
        |
        +--helix.util.ui.parameters.ListParameter

All Implemented Interfaces:

Parameter

public class ListParameter

extends ObjectParameter

Represents a Parameter whose value is a list of string. Each objects of the list value must belong to the domain.

Field Summary

Fields inherited from interface helix.util.ui.parameters.Parameter

BOOLEAN_TYPE, LIST_TYPE, OBJECT_TYPE, STRING_TYPE

Constructor Summary

ListParameter(String key, String label, List value, List defaultValue, Object[] listDomainValues, boolean isPrefSaved)
Constructor.

Method Summary

Set	getDomainElements() Returns the domain values that list elements must respect.
List	getListValue() Returns List value.
boolean	hasDomainElements()
void	setValue(Object value) Set the value of this parameter.

Methods inherited from class helix.util.ui.parameters.ObjectParameter

addListener, getConstraint, getDefaultValue, getInitialValue, getKey, getLabel, getType, getValue, getValues, hasConstraints, hasDomainValues, isEnable, isPreferenceSaved, removeListener, setEnable

Methods inherited from class java.lang.Object

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

Constructor Detail

ListParameter

public ListParameter(String key,
                     String label,
                     List value,
                     List defaultValue,
                     Object[] listDomainValues,
                     boolean isPrefSaved)
              throws IllegalArgumentException

Constructor.

Parameters:

key - identifier of Parameter (can not be null)

label - label which present the parameter

value - initial List value (can not be null)

defaultValue - default List value (can not be null)

listDomainValues - domain value for List element (if not null must contains value)

isPrefSaved - indicates if value could be store in Preferences

Method Detail

setValue

public void setValue(Object value)
              throws IllegalArgumentException

Description copied from class: ObjectParameter

Set the value of this parameter.

Specified by:

setValue in interface Parameter

Overrides:

setValue in class ObjectParameter

Throws:

IllegalArgumentException - if new value is null or does not respect constraint or domain values

getListValue

public List getListValue()

Returns List value.

Returns:

java.util.List

getDomainElements

public Set getDomainElements()

Returns the domain values that list elements must respect.

hasDomainElements

public boolean hasDomainElements()