com.exalead.mercury.component.config.descriptor

Class HiddenStringField

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.HiddenStringField

All Implemented Interfaces:

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

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

Hidden String 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
HiddenStringField()
HiddenStringField(HiddenStringField o) Copy constructor

Method Summary

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

HiddenStringField

public HiddenStringField()

HiddenStringField

public HiddenStringField(HiddenStringField o)

Copy constructor

Method Detail

withDefaultValue

public HiddenStringField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class StringField

withAllowEmpty

public HiddenStringField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class StringField

withAllowEmpty

public HiddenStringField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class StringField

withName

public HiddenStringField withName(java.lang.String name)

Overrides:

withName in class StringField

withTitle

public HiddenStringField withTitle(java.lang.String title)

Overrides:

withTitle in class StringField

withDescription

public HiddenStringField withDescription(java.lang.String description)

Overrides:

withDescription in class StringField

withIsMandatory

public HiddenStringField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class StringField

withIsMandatory

public HiddenStringField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class StringField

withIsHidden

public HiddenStringField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class StringField

withIsHidden

public HiddenStringField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class StringField

withOrdering

public HiddenStringField withOrdering(int ordering)

Overrides:

withOrdering in class StringField

withOrdering

public HiddenStringField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class StringField

makeCopy

public HiddenStringField makeCopy()

Creates and returns a deep copy of this HiddenStringField.

Overrides:

makeCopy in class StringField

readFrom

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

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

Overrides:

writeTo in class StringField

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this HiddenStringField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this HiddenStringField.

Overrides:

toString in class StringField

check

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

Checks this HiddenStringField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class StringField

Throws:

com.exalead.util.TypedException