com.exalead.mercury.component.config.descriptor

Class MultiLineStringField

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

All Implemented Interfaces:

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

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

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

Method Summary

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

MultiLineStringField

public MultiLineStringField()

MultiLineStringField

public MultiLineStringField(MultiLineStringField o)

Copy constructor

Method Detail

withDefaultValue

public MultiLineStringField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class StringField

withAllowEmpty

public MultiLineStringField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class StringField

withAllowEmpty

public MultiLineStringField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class StringField

withName

public MultiLineStringField withName(java.lang.String name)

Overrides:

withName in class StringField

withTitle

public MultiLineStringField withTitle(java.lang.String title)

Overrides:

withTitle in class StringField

withDescription

public MultiLineStringField withDescription(java.lang.String description)

Overrides:

withDescription in class StringField

withIsMandatory

public MultiLineStringField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class StringField

withIsMandatory

public MultiLineStringField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class StringField

withIsHidden

public MultiLineStringField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class StringField

withIsHidden

public MultiLineStringField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class StringField

withOrdering

public MultiLineStringField withOrdering(int ordering)

Overrides:

withOrdering in class StringField

withOrdering

public MultiLineStringField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class StringField

makeCopy

public MultiLineStringField makeCopy()

Creates and returns a deep copy of this MultiLineStringField.

Overrides:

makeCopy in class StringField

readFrom

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

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

Overrides:

writeTo in class StringField

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MultiLineStringField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MultiLineStringField.

Overrides:

toString in class StringField

check

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

Checks this MultiLineStringField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class StringField

Throws:

com.exalead.util.TypedException