com.exalead.mercury.component.config.descriptor

Class BooleanField

java.lang.Object

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

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

com.exalead.mercury.component.config.descriptor.BooleanField

All Implemented Interfaces:

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

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

Boolean field

See Also:

Serialized Form

Field Summary

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

Method Summary

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

Constructor Detail

BooleanField

public BooleanField()

BooleanField

public BooleanField(BooleanField o)

Copy constructor

Method Detail

withDefaultValue

public BooleanField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class Field

withAllowEmpty

public BooleanField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withAllowEmpty

public BooleanField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withName

public BooleanField withName(java.lang.String name)

Overrides:

withName in class Field

withTitle

public BooleanField withTitle(java.lang.String title)

Overrides:

withTitle in class Field

withDescription

public BooleanField withDescription(java.lang.String description)

Overrides:

withDescription in class Field

withIsMandatory

public BooleanField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsMandatory

public BooleanField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsHidden

public BooleanField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Field

withIsHidden

public BooleanField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Field

withOrdering

public BooleanField withOrdering(int ordering)

Overrides:

withOrdering in class Field

withOrdering

public BooleanField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class Field

makeCopy

public BooleanField makeCopy()

Creates and returns a deep copy of this BooleanField.

Overrides:

makeCopy in class Field

readFrom

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

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

Overrides:

writeTo in class Field

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this BooleanField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this BooleanField.

Overrides:

toString in class Field

check

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

Checks this BooleanField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Field

Throws:

com.exalead.util.TypedException