com.exalead.mercury.component.config.descriptor

Class PossibleValue

java.lang.Object

com.exalead.mercury.component.config.descriptor.PossibleValue

All Implemented Interfaces:

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

public class PossibleValue
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Allowed field value

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	description
java.lang.String	value

Constructor Summary

Constructors

Constructor and Description
PossibleValue()
PossibleValue(PossibleValue o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this PossibleValue.
static PossibleValue	fromString(java.lang.String s) String representation of this PossibleValue.
java.lang.String	getDescription() Description (may be used as a tooltip)
java.lang.String	getValue() Value
PossibleValue	makeCopy() Creates and returns a deep copy of this PossibleValue.
static PossibleValue	readFrom(java.io.InputStream is) Read this PossibleValue from an XML fragment.
void	setDescription(java.lang.String description) Description (may be used as a tooltip)
void	setValue(java.lang.String value) Value
java.lang.String	toString() String representation of this PossibleValue.
PossibleValue	withDescription(java.lang.String description)
PossibleValue	withValue(java.lang.String value)
void	writeTo(java.io.OutputStream os) Write this PossibleValue as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

value

public java.lang.String value

description

public java.lang.String description

Constructor Detail

PossibleValue

public PossibleValue()

PossibleValue

public PossibleValue(PossibleValue o)

Copy constructor

Method Detail

setValue

public void setValue(java.lang.String value)

Value

getValue

public java.lang.String getValue()

Value

withValue

public PossibleValue withValue(java.lang.String value)

setDescription

public void setDescription(java.lang.String description)

Description (may be used as a tooltip)

getDescription

public java.lang.String getDescription()

Description (may be used as a tooltip)

withDescription

public PossibleValue withDescription(java.lang.String description)

makeCopy

public PossibleValue makeCopy()

Creates and returns a deep copy of this PossibleValue.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this PossibleValue.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PossibleValue.

Overrides:

toString in class java.lang.Object

check

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

Checks this PossibleValue.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException