com.exalead.mercury.component.config.descriptor

Class DateTimeField

java.lang.Object

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

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

com.exalead.mercury.component.config.descriptor.DateTimeField

All Implemented Interfaces:

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

public class DateTimeField
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
DateTimeField()
DateTimeField(DateTimeField o) Copy constructor

Method Summary

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

DateTimeField

public DateTimeField()

DateTimeField

public DateTimeField(DateTimeField o)

Copy constructor

Method Detail

withDefaultValue

public DateTimeField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class Field

withAllowEmpty

public DateTimeField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withAllowEmpty

public DateTimeField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withName

public DateTimeField withName(java.lang.String name)

Overrides:

withName in class Field

withTitle

public DateTimeField withTitle(java.lang.String title)

Overrides:

withTitle in class Field

withDescription

public DateTimeField withDescription(java.lang.String description)

Overrides:

withDescription in class Field

withIsMandatory

public DateTimeField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsMandatory

public DateTimeField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsHidden

public DateTimeField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Field

withIsHidden

public DateTimeField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Field

withOrdering

public DateTimeField withOrdering(int ordering)

Overrides:

withOrdering in class Field

withOrdering

public DateTimeField 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 DateTimeField withFormat(java.lang.String format)

makeCopy

public DateTimeField makeCopy()

Creates and returns a deep copy of this DateTimeField.

Overrides:

makeCopy in class Field

readFrom

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

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

Overrides:

writeTo in class Field

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DateTimeField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DateTimeField.

Overrides:

toString in class Field

check

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

Checks this DateTimeField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Field

Throws:

com.exalead.util.TypedException