com.exalead.mercury.component.config.descriptor

Class StringField

java.lang.Object

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

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

com.exalead.mercury.component.config.descriptor.StringField

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildGroupField, EmbeddedCodeField, EmbeddedJavaField, EncryptedStringField, EnumField, HiddenStringField, MultiLineStringField, SecuritySourceField, SuggestedField

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

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

Method Summary

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

StringField

public StringField()

StringField

public StringField(StringField o)

Copy constructor

Method Detail

withDefaultValue

public StringField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class Field

withAllowEmpty

public StringField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withAllowEmpty

public StringField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withName

public StringField withName(java.lang.String name)

Overrides:

withName in class Field

withTitle

public StringField withTitle(java.lang.String title)

Overrides:

withTitle in class Field

withDescription

public StringField withDescription(java.lang.String description)

Overrides:

withDescription in class Field

withIsMandatory

public StringField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsMandatory

public StringField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsHidden

public StringField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Field

withIsHidden

public StringField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Field

withOrdering

public StringField withOrdering(int ordering)

Overrides:

withOrdering in class Field

withOrdering

public StringField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class Field

makeCopy

public StringField makeCopy()

Creates and returns a deep copy of this StringField.

Overrides:

makeCopy in class Field

readFrom

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

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

Overrides:

writeTo in class Field

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this StringField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this StringField.

Overrides:

toString in class Field

check

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

Checks this StringField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Field

Throws:

com.exalead.util.TypedException