com.exalead.mercury.component.config.descriptor

Class SetterNode

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Descriptor

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

Setter node (contains Item and 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 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
SetterNode()
SetterNode(SetterNode o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SetterNode.
static SetterNode	fromString(java.lang.String s) String representation of this SetterNode.
SetterNode	makeCopy() Creates and returns a deep copy of this SetterNode.
static SetterNode	readFrom(java.io.InputStream is) Read this SetterNode from an XML fragment.
java.lang.String	toString() String representation of this SetterNode.
SetterNode	withDefaultFieldValue(java.util.Collection<Field> __values)
SetterNode	withDefaultFieldValue(Field... __values) Field default values
SetterNode	withDefaultNodeValue(java.util.Collection<Node> __values)
SetterNode	withDefaultNodeValue(Node... __values) Node default values (recursive)
SetterNode	withDescription(java.lang.String description)
SetterNode	withField(java.util.Collection<Field> __values)
SetterNode	withField(Field... __values) Sub-fields
SetterNode	withIsHidden(boolean isHidden)
SetterNode	withIsHidden(java.lang.Boolean isHidden)
SetterNode	withIsMandatory(boolean isMandatory)
SetterNode	withIsMandatory(java.lang.Boolean isMandatory)
SetterNode	withName(java.lang.String name)
SetterNode	withNode(java.util.Collection<Node> __values)
SetterNode	withNode(Node... __values) Sub-nodes
SetterNode	withOrdering(int ordering)
SetterNode	withOrdering(java.lang.Integer ordering)
SetterNode	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os) Write this SetterNode 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

Constructor Detail

SetterNode

public SetterNode()

SetterNode

public SetterNode(SetterNode o)

Copy constructor

Method Detail

withField

public SetterNode withField(Field... __values)

Sub-fields

Overrides:

withField in class Node

withField

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

Overrides:

withField in class Node

withNode

public SetterNode withNode(Node... __values)

Sub-nodes

Overrides:

withNode in class Node

withNode

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

Overrides:

withNode in class Node

withDefaultFieldValue

public SetterNode withDefaultFieldValue(Field... __values)

Field default values

Overrides:

withDefaultFieldValue in class Node

withDefaultFieldValue

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

Overrides:

withDefaultFieldValue in class Node

withDefaultNodeValue

public SetterNode withDefaultNodeValue(Node... __values)

Node default values (recursive)

Overrides:

withDefaultNodeValue in class Node

withDefaultNodeValue

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

Overrides:

withDefaultNodeValue in class Node

withName

public SetterNode withName(java.lang.String name)

Overrides:

withName in class Node

withTitle

public SetterNode withTitle(java.lang.String title)

Overrides:

withTitle in class Node

withDescription

public SetterNode withDescription(java.lang.String description)

Overrides:

withDescription in class Node

withIsMandatory

public SetterNode withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Node

withIsMandatory

public SetterNode withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Node

withIsHidden

public SetterNode withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Node

withIsHidden

public SetterNode withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Node

withOrdering

public SetterNode withOrdering(int ordering)

Overrides:

withOrdering in class Node

withOrdering

public SetterNode withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class Node

makeCopy

public SetterNode makeCopy()

Creates and returns a deep copy of this SetterNode.

Overrides:

makeCopy in class Node

readFrom

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

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

Overrides:

writeTo in class Node

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SetterNode.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SetterNode.

Overrides:

toString in class Node

check

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

Checks this SetterNode.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Node

Throws:

com.exalead.util.TypedException