com.exalead.mercury.component.config.descriptor

Class EnumField

java.lang.Object

com.exalead.mercury.component.config.descriptor.Item

com.exalead.mercury.component.config.descriptor.Field

com.exalead.mercury.component.config.descriptor.StringField

com.exalead.mercury.component.config.descriptor.EnumField

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class EnumField
extends StringField
implements com.exalead.util.Checkable, java.io.Serializable

Enum field

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_MULTIPLE_SELECTION
boolean	multipleSelection
java.util.List<PossibleValue>	possibleValue

Fields inherited from class com.exalead.mercury.component.config.descriptor.Field

allowEmpty, DEFAULT_ALLOW_EMPTY, defaultValue

Fields inherited from class com.exalead.mercury.component.config.descriptor.Item

DEFAULT_IS_HIDDEN, DEFAULT_IS_MANDATORY, description, isHidden, isMandatory, name, ordering, title

Constructor Summary

Constructors

Constructor and Description
EnumField()
EnumField(EnumField o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this EnumField.
static EnumField	fromString(java.lang.String s) String representation of this EnumField.
java.util.List<PossibleValue>	getPossibleValue() Allowed values in the field
boolean	isMultipleSelection() Can several values be picked?
EnumField	makeCopy() Creates and returns a deep copy of this EnumField.
static EnumField	readFrom(java.io.InputStream is) Read this EnumField from an XML fragment.
void	setMultipleSelection(boolean multipleSelection) Can several values be picked?
java.lang.String	toString() String representation of this EnumField.
EnumField	withAllowEmpty(boolean allowEmpty)
EnumField	withAllowEmpty(java.lang.Boolean allowEmpty)
EnumField	withDefaultValue(java.lang.String defaultValue)
EnumField	withDescription(java.lang.String description)
EnumField	withIsHidden(boolean isHidden)
EnumField	withIsHidden(java.lang.Boolean isHidden)
EnumField	withIsMandatory(boolean isMandatory)
EnumField	withIsMandatory(java.lang.Boolean isMandatory)
EnumField	withMultipleSelection(boolean multipleSelection)
EnumField	withMultipleSelection(java.lang.Boolean multipleSelection)
EnumField	withName(java.lang.String name)
EnumField	withOrdering(int ordering)
EnumField	withOrdering(java.lang.Integer ordering)
EnumField	withPossibleValue(java.util.Collection<PossibleValue> __values)
EnumField	withPossibleValue(PossibleValue... __values) Allowed values in the field
EnumField	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os) Write this EnumField as an XML fragment

Methods inherited from class com.exalead.mercury.component.config.descriptor.Field

getDefaultValue, isAllowEmpty, setAllowEmpty, setDefaultValue

Methods inherited from class com.exalead.mercury.component.config.descriptor.Item

getDescription, getName, getOrdering, getTitle, isIsHidden, isIsMandatory, setDescription, setIsHidden, setIsMandatory, setName, setOrdering, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

possibleValue

public java.util.List<PossibleValue> possibleValue

multipleSelection

public boolean multipleSelection

DEFAULT_MULTIPLE_SELECTION

public static final boolean DEFAULT_MULTIPLE_SELECTION

See Also:

Constant Field Values

Constructor Detail

EnumField

public EnumField()

EnumField

public EnumField(EnumField o)

Copy constructor

Method Detail

withDefaultValue

public EnumField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class StringField

withAllowEmpty

public EnumField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class StringField

withAllowEmpty

public EnumField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class StringField

withName

public EnumField withName(java.lang.String name)

Overrides:

withName in class StringField

withTitle

public EnumField withTitle(java.lang.String title)

Overrides:

withTitle in class StringField

withDescription

public EnumField withDescription(java.lang.String description)

Overrides:

withDescription in class StringField

withIsMandatory

public EnumField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class StringField

withIsMandatory

public EnumField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class StringField

withIsHidden

public EnumField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class StringField

withIsHidden

public EnumField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class StringField

withOrdering

public EnumField withOrdering(int ordering)

Overrides:

withOrdering in class StringField

withOrdering

public EnumField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class StringField

getPossibleValue

public java.util.List<PossibleValue> getPossibleValue()

Allowed values in the field

withPossibleValue

public EnumField withPossibleValue(PossibleValue... __values)

Allowed values in the field

withPossibleValue

public EnumField withPossibleValue(java.util.Collection<PossibleValue> __values)

setMultipleSelection

public void setMultipleSelection(boolean multipleSelection)

Can several values be picked?

isMultipleSelection

public boolean isMultipleSelection()

Can several values be picked?

withMultipleSelection

public EnumField withMultipleSelection(boolean multipleSelection)

withMultipleSelection

public EnumField withMultipleSelection(java.lang.Boolean multipleSelection)

makeCopy

public EnumField makeCopy()

Creates and returns a deep copy of this EnumField.

Overrides:

makeCopy in class StringField

readFrom

public static EnumField readFrom(java.io.InputStream is)
                          throws javax.xml.bind.JAXBException

Read this EnumField from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this EnumField as an XML fragment

Overrides:

writeTo in class StringField

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static EnumField fromString(java.lang.String s)
                            throws javax.xml.bind.JAXBException,
                                   java.io.UnsupportedEncodingException

String representation of this EnumField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this EnumField.

Overrides:

toString in class StringField

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this EnumField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class StringField

Throws:

com.exalead.util.TypedException