com.exalead.mercury.component.config.descriptor

Class SuggestedField

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

All Implemented Interfaces:

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

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

Field with suggested values

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LIMIT
int	limit

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

Method Summary

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

limit

public int limit

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

Constant Field Values

Constructor Detail

SuggestedField

public SuggestedField()

SuggestedField

public SuggestedField(SuggestedField o)

Copy constructor

Method Detail

withDefaultValue

public SuggestedField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class StringField

withAllowEmpty

public SuggestedField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class StringField

withAllowEmpty

public SuggestedField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class StringField

withName

public SuggestedField withName(java.lang.String name)

Overrides:

withName in class StringField

withTitle

public SuggestedField withTitle(java.lang.String title)

Overrides:

withTitle in class StringField

withDescription

public SuggestedField withDescription(java.lang.String description)

Overrides:

withDescription in class StringField

withIsMandatory

public SuggestedField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class StringField

withIsMandatory

public SuggestedField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class StringField

withIsHidden

public SuggestedField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class StringField

withIsHidden

public SuggestedField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class StringField

withOrdering

public SuggestedField withOrdering(int ordering)

Overrides:

withOrdering in class StringField

withOrdering

public SuggestedField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class StringField

setLimit

public void setLimit(int limit)

Maximum number of suggestions. 0 means all.

getLimit

public int getLimit()

Maximum number of suggestions. 0 means all.

withLimit

public SuggestedField withLimit(int limit)

withLimit

public SuggestedField withLimit(java.lang.Integer limit)

makeCopy

public SuggestedField makeCopy()

Creates and returns a deep copy of this SuggestedField.

Overrides:

makeCopy in class StringField

readFrom

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

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

Overrides:

writeTo in class StringField

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SuggestedField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SuggestedField.

Overrides:

toString in class StringField

check

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

Checks this SuggestedField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class StringField

Throws:

com.exalead.util.TypedException