com.exalead.mercury.component.config.descriptor

Class DateField

java.lang.Object

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

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

com.exalead.mercury.component.config.descriptor.DateField

All Implemented Interfaces:

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

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

Field (leaf)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FORMAT
java.lang.String	format

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
DateField()
DateField(DateField o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this DateField.
static DateField	fromString(java.lang.String s) String representation of this DateField.
java.lang.String	getFormat()
DateField	makeCopy() Creates and returns a deep copy of this DateField.
static DateField	readFrom(java.io.InputStream is) Read this DateField from an XML fragment.
void	setFormat(java.lang.String format)
java.lang.String	toString() String representation of this DateField.
DateField	withAllowEmpty(boolean allowEmpty)
DateField	withAllowEmpty(java.lang.Boolean allowEmpty)
DateField	withDefaultValue(java.lang.String defaultValue)
DateField	withDescription(java.lang.String description)
DateField	withFormat(java.lang.String format)
DateField	withIsHidden(boolean isHidden)
DateField	withIsHidden(java.lang.Boolean isHidden)
DateField	withIsMandatory(boolean isMandatory)
DateField	withIsMandatory(java.lang.Boolean isMandatory)
DateField	withName(java.lang.String name)
DateField	withOrdering(int ordering)
DateField	withOrdering(java.lang.Integer ordering)
DateField	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os) Write this DateField 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

format

public java.lang.String format

DEFAULT_FORMAT

public static final java.lang.String DEFAULT_FORMAT

See Also:

Constant Field Values

Constructor Detail

DateField

public DateField()

DateField

public DateField(DateField o)

Copy constructor

Method Detail

withDefaultValue

public DateField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class Field

withAllowEmpty

public DateField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withAllowEmpty

public DateField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withName

public DateField withName(java.lang.String name)

Overrides:

withName in class Field

withTitle

public DateField withTitle(java.lang.String title)

Overrides:

withTitle in class Field

withDescription

public DateField withDescription(java.lang.String description)

Overrides:

withDescription in class Field

withIsMandatory

public DateField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsMandatory

public DateField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsHidden

public DateField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Field

withIsHidden

public DateField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Field

withOrdering

public DateField withOrdering(int ordering)

Overrides:

withOrdering in class Field

withOrdering

public DateField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class Field

setFormat

public void setFormat(java.lang.String format)

getFormat

public java.lang.String getFormat()

withFormat

public DateField withFormat(java.lang.String format)

makeCopy

public DateField makeCopy()

Creates and returns a deep copy of this DateField.

Overrides:

makeCopy in class Field

readFrom

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

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

Overrides:

writeTo in class Field

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DateField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DateField.

Overrides:

toString in class Field

check

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

Checks this DateField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Field

Throws:

com.exalead.util.TypedException