com.exalead.mercury.component.config.descriptor

Class Item

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Field, Node

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

Configuration descriptor item (field or node)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_IS_HIDDEN
static boolean	DEFAULT_IS_MANDATORY
java.lang.String	description
boolean	isHidden
boolean	isMandatory
java.lang.String	name
int	ordering
java.lang.String	title

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Item.
static Item	fromString(java.lang.String s) String representation of this Item.
java.lang.String	getDescription() Item description
java.lang.String	getName() Item name
int	getOrdering() Used to order items within the same level (cosmetic only)
java.lang.String	getTitle() Item title
boolean	isIsHidden() Is hidden by default
boolean	isIsMandatory() Is mandatory
Item	makeCopy()
static Item	readFrom(java.io.InputStream is) Read this Item from an XML fragment.
void	setDescription(java.lang.String description) Item description
void	setIsHidden(boolean isHidden) Is hidden by default
void	setIsMandatory(boolean isMandatory) Is mandatory
void	setName(java.lang.String name) Item name
void	setOrdering(int ordering) Used to order items within the same level (cosmetic only)
void	setTitle(java.lang.String title) Item title
java.lang.String	toString() String representation of this Item.
Item	withDescription(java.lang.String description)
Item	withIsHidden(boolean isHidden)
Item	withIsHidden(java.lang.Boolean isHidden)
Item	withIsMandatory(boolean isMandatory)
Item	withIsMandatory(java.lang.Boolean isMandatory)
Item	withName(java.lang.String name)
Item	withOrdering(int ordering)
Item	withOrdering(java.lang.Integer ordering)
Item	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

title

public java.lang.String title

description

public java.lang.String description

isMandatory

public boolean isMandatory

DEFAULT_IS_MANDATORY

public static final boolean DEFAULT_IS_MANDATORY

See Also:

Constant Field Values

isHidden

public boolean isHidden

DEFAULT_IS_HIDDEN

public static final boolean DEFAULT_IS_HIDDEN

See Also:

Constant Field Values

ordering

public int ordering

Constructor Detail

Item

public Item()

Item

public Item(Item o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

Item name

getName

public java.lang.String getName()

Item name

withName

public Item withName(java.lang.String name)

setTitle

public void setTitle(java.lang.String title)

Item title

getTitle

public java.lang.String getTitle()

Item title

withTitle

public Item withTitle(java.lang.String title)

setDescription

public void setDescription(java.lang.String description)

Item description

getDescription

public java.lang.String getDescription()

Item description

withDescription

public Item withDescription(java.lang.String description)

setIsMandatory

public void setIsMandatory(boolean isMandatory)

Is mandatory

isIsMandatory

public boolean isIsMandatory()

Is mandatory

withIsMandatory

public Item withIsMandatory(boolean isMandatory)

withIsMandatory

public Item withIsMandatory(java.lang.Boolean isMandatory)

setIsHidden

public void setIsHidden(boolean isHidden)

Is hidden by default

isIsHidden

public boolean isIsHidden()

Is hidden by default

withIsHidden

public Item withIsHidden(boolean isHidden)

withIsHidden

public Item withIsHidden(java.lang.Boolean isHidden)

setOrdering

public void setOrdering(int ordering)

Used to order items within the same level (cosmetic only)

getOrdering

public int getOrdering()

Used to order items within the same level (cosmetic only)

withOrdering

public Item withOrdering(int ordering)

withOrdering

public Item withOrdering(java.lang.Integer ordering)

makeCopy

public Item makeCopy()

readFrom

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

Read this Item 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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Item.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Item.

Overrides:

toString in class java.lang.Object

check

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

Checks this Item.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException