com.exalead.mercury.component.config.descriptor

Class Descriptor

java.lang.Object

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

com.exalead.mercury.component.config.descriptor.Node

com.exalead.mercury.component.config.descriptor.SetterNode

com.exalead.mercury.component.config.descriptor.Descriptor

All Implemented Interfaces:

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

public class Descriptor
extends SetterNode
implements com.exalead.util.Checkable, java.io.Serializable

Top-level config node

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.component.config.descriptor.Node

Node.DefaultFieldValue, Node.DefaultNodeValue

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	componentClassId
java.lang.String	componentConfigClassId

Fields inherited from class com.exalead.mercury.component.config.descriptor.Node

defaultFieldValue, defaultNodeValue, field, node

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Descriptor.
static Descriptor	fromString(java.lang.String s) String representation of this Descriptor.
java.lang.String	getComponentClassId() Class ID
java.lang.String	getComponentConfigClassId() Class id of the associated config
Descriptor	makeCopy() Creates and returns a deep copy of this Descriptor.
static Descriptor	readFrom(java.io.InputStream is) Read this Descriptor from an XML fragment.
void	setComponentClassId(java.lang.String componentClassId) Class ID
void	setComponentConfigClassId(java.lang.String componentConfigClassId) Class id of the associated config
java.lang.String	toString() String representation of this Descriptor.
Descriptor	withComponentClassId(java.lang.String componentClassId)
Descriptor	withComponentConfigClassId(java.lang.String componentConfigClassId)
Descriptor	withDefaultFieldValue(java.util.Collection<Field> __values)
Descriptor	withDefaultFieldValue(Field... __values) Field default values
Descriptor	withDefaultNodeValue(java.util.Collection<Node> __values)
Descriptor	withDefaultNodeValue(Node... __values) Node default values (recursive)
Descriptor	withDescription(java.lang.String description)
Descriptor	withField(java.util.Collection<Field> __values)
Descriptor	withField(Field... __values) Sub-fields
Descriptor	withIsHidden(boolean isHidden)
Descriptor	withIsHidden(java.lang.Boolean isHidden)
Descriptor	withIsMandatory(boolean isMandatory)
Descriptor	withIsMandatory(java.lang.Boolean isMandatory)
Descriptor	withName(java.lang.String name)
Descriptor	withNode(java.util.Collection<Node> __values)
Descriptor	withNode(Node... __values) Sub-nodes
Descriptor	withOrdering(int ordering)
Descriptor	withOrdering(java.lang.Integer ordering)
Descriptor	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os) Write this Descriptor as an XML fragment

Methods inherited from class com.exalead.mercury.component.config.descriptor.Node

getDefaultFieldValue, getDefaultNodeValue, getField, getNode, setDefaultFieldValue, setDefaultNodeValue, withDefaultFieldValue, withDefaultNodeValue

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

componentClassId

public java.lang.String componentClassId

componentConfigClassId

public java.lang.String componentConfigClassId

Constructor Detail

Descriptor

public Descriptor()

Descriptor

public Descriptor(Descriptor o)

Copy constructor

Method Detail

withField

public Descriptor withField(Field... __values)

Sub-fields

Overrides:

withField in class SetterNode

withField

public Descriptor withField(java.util.Collection<Field> __values)

Overrides:

withField in class SetterNode

withNode

public Descriptor withNode(Node... __values)

Sub-nodes

Overrides:

withNode in class SetterNode

withNode

public Descriptor withNode(java.util.Collection<Node> __values)

Overrides:

withNode in class SetterNode

withDefaultFieldValue

public Descriptor withDefaultFieldValue(Field... __values)

Field default values

Overrides:

withDefaultFieldValue in class SetterNode

withDefaultFieldValue

public Descriptor withDefaultFieldValue(java.util.Collection<Field> __values)

Overrides:

withDefaultFieldValue in class SetterNode

withDefaultNodeValue

public Descriptor withDefaultNodeValue(Node... __values)

Node default values (recursive)

Overrides:

withDefaultNodeValue in class SetterNode

withDefaultNodeValue

public Descriptor withDefaultNodeValue(java.util.Collection<Node> __values)

Overrides:

withDefaultNodeValue in class SetterNode

withName

public Descriptor withName(java.lang.String name)

Overrides:

withName in class SetterNode

withTitle

public Descriptor withTitle(java.lang.String title)

Overrides:

withTitle in class SetterNode

withDescription

public Descriptor withDescription(java.lang.String description)

Overrides:

withDescription in class SetterNode

withIsMandatory

public Descriptor withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class SetterNode

withIsMandatory

public Descriptor withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class SetterNode

withIsHidden

public Descriptor withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class SetterNode

withIsHidden

public Descriptor withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class SetterNode

withOrdering

public Descriptor withOrdering(int ordering)

Overrides:

withOrdering in class SetterNode

withOrdering

public Descriptor withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class SetterNode

setComponentClassId

public void setComponentClassId(java.lang.String componentClassId)

Class ID

getComponentClassId

public java.lang.String getComponentClassId()

Class ID

withComponentClassId

public Descriptor withComponentClassId(java.lang.String componentClassId)

setComponentConfigClassId

public void setComponentConfigClassId(java.lang.String componentConfigClassId)

Class id of the associated config

getComponentConfigClassId

public java.lang.String getComponentConfigClassId()

Class id of the associated config

withComponentConfigClassId

public Descriptor withComponentConfigClassId(java.lang.String componentConfigClassId)

makeCopy

public Descriptor makeCopy()

Creates and returns a deep copy of this Descriptor.

Overrides:

makeCopy in class SetterNode

readFrom

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

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

Overrides:

writeTo in class SetterNode

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Descriptor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Descriptor.

Overrides:

toString in class SetterNode

check

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

Checks this Descriptor.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SetterNode

Throws:

com.exalead.util.TypedException