core

Class XMLFieldEntry

java.lang.Object

core.XMLFieldEntry

All Implemented Interfaces:

java.lang.Cloneable

public class XMLFieldEntry
extends java.lang.Object
implements java.lang.Cloneable

Represents an entry loaded from component XML descriptor files. Each XMLFieldEntry contains a variable type, the variable value stored in String objects.

If the type is an enumeration (Enum), a base enum class is also required.

Author:

Istvan Fehervari

Constructor Summary

Constructors

Constructor and Description
XMLFieldEntry(java.lang.String value, XMLFieldType type, java.lang.String description) Constructs a new entry with the given parameters.
XMLFieldEntry(java.lang.String value, XMLFieldType type, java.lang.String enumName, java.lang.String description) Constructs a new entry with the given parameters.

Method Summary

Methods

Modifier and Type	Method and Description
XMLFieldEntry	clone() Creates a deep copy of this object.
java.lang.String	getDescription() Returns a short description of this entry.
java.lang.String	getEnumName() Returns the base enum name used for enumeration types.
XMLFieldType	getType() Returns the type of this entry.
java.lang.String	getValue() Returns the value associated to this entry.
void	setValue(java.lang.String value) Sets the value of this entry to a new value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLFieldEntry

public XMLFieldEntry(java.lang.String value,
             XMLFieldType type,
             java.lang.String description)

Constructs a new entry with the given parameters.

Parameters:

value - The value of this entry

type - The type of this entry

description - A short description of this entry

XMLFieldEntry

public XMLFieldEntry(java.lang.String value,
             XMLFieldType type,
             java.lang.String enumName,
             java.lang.String description)
              throws java.lang.IllegalArgumentException

Constructs a new entry with the given parameters. The entry must be of type enum or and exception is thrown.

Parameters:

value - The value of this entry

type - The type of this entry

description - A short description of this entry

Throws:

java.lang.IllegalArgumentException - if the type is not enum

Method Detail

getType

public XMLFieldType getType()

Returns the type of this entry.

Returns:

The type of this entry.

getValue

public java.lang.String getValue()

Returns the value associated to this entry.

Returns:

the value of this entry.

setValue

public void setValue(java.lang.String value)

Sets the value of this entry to a new value.

Parameters:

value - The value to be used.

getEnumName

public java.lang.String getEnumName()
                             throws java.lang.IllegalStateException

Returns the base enum name used for enumeration types. Throws and exception if this entry is not of type enum.

Returns:

The name of the base enum class of this entry.

Throws:

java.lang.IllegalStateException - if this entry is not of type enum

getDescription

public java.lang.String getDescription()

Returns a short description of this entry.

Returns:

A short description of the entry.

clone

public XMLFieldEntry clone()

Creates a deep copy of this object. All fields within will be re-instantiated and their values will be set according to the source object.

Overrides:

clone in class java.lang.Object

Returns:

a deep copy of this object.