com.exalead.mercury.component.config.descriptor

Class Field

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BooleanField, ConnectorField, DataModelClassField, DateField, DateTimeField, LongField, PathField, StringField

public class Field
extends Item
implements com.exalead.util.Checkable, java.io.Serializable

Field (leaf)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowEmpty
static boolean	DEFAULT_ALLOW_EMPTY
java.lang.String	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
Field()
Field(Field o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Field.
static Field	fromString(java.lang.String s) String representation of this Field.
java.lang.String	getDefaultValue() Field default value serialized as a String
boolean	isAllowEmpty() Empty serialized string is allowed ?
Field	makeCopy() Creates and returns a deep copy of this Field.
static Field	readFrom(java.io.InputStream is) Read this Field from an XML fragment.
void	setAllowEmpty(boolean allowEmpty) Empty serialized string is allowed ?
void	setDefaultValue(java.lang.String defaultValue) Field default value serialized as a String
java.lang.String	toString() String representation of this Field.
Field	withAllowEmpty(boolean allowEmpty)
Field	withAllowEmpty(java.lang.Boolean allowEmpty)
Field	withDefaultValue(java.lang.String defaultValue)
Field	withDescription(java.lang.String description)
Field	withIsHidden(boolean isHidden)
Field	withIsHidden(java.lang.Boolean isHidden)
Field	withIsMandatory(boolean isMandatory)
Field	withIsMandatory(java.lang.Boolean isMandatory)
Field	withName(java.lang.String name)
Field	withOrdering(int ordering)
Field	withOrdering(java.lang.Integer ordering)
Field	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os) Write this Field as an XML fragment

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

defaultValue

public java.lang.String defaultValue

allowEmpty

public boolean allowEmpty

DEFAULT_ALLOW_EMPTY

public static final boolean DEFAULT_ALLOW_EMPTY

See Also:

Constant Field Values

Constructor Detail

Field

public Field()

Field

public Field(Field o)

Copy constructor

Method Detail

withName

public Field withName(java.lang.String name)

Overrides:

withName in class Item

withTitle

public Field withTitle(java.lang.String title)

Overrides:

withTitle in class Item

withDescription

public Field withDescription(java.lang.String description)

Overrides:

withDescription in class Item

withIsMandatory

public Field withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Item

withIsMandatory

public Field withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Item

withIsHidden

public Field withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Item

withIsHidden

public Field withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Item

withOrdering

public Field withOrdering(int ordering)

Overrides:

withOrdering in class Item

withOrdering

public Field withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class Item

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Field default value serialized as a String

getDefaultValue

public java.lang.String getDefaultValue()

Field default value serialized as a String

withDefaultValue

public Field withDefaultValue(java.lang.String defaultValue)

setAllowEmpty

public void setAllowEmpty(boolean allowEmpty)

Empty serialized string is allowed ?

isAllowEmpty

public boolean isAllowEmpty()

Empty serialized string is allowed ?

withAllowEmpty

public Field withAllowEmpty(boolean allowEmpty)

withAllowEmpty

public Field withAllowEmpty(java.lang.Boolean allowEmpty)

makeCopy

public Field makeCopy()

Creates and returns a deep copy of this Field.

Overrides:

makeCopy in class Item

readFrom

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

Read this Field 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 Field as an XML fragment

Overrides:

writeTo in class Item

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Field.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Field.

Overrides:

toString in class Item

check

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

Checks this Field.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Item

Throws:

com.exalead.util.TypedException