org.waarp.common.xml

Class XmlValue

java.lang.Object

org.waarp.common.xml.XmlValue

public class XmlValue
extends Object

XmlValue base element

Constructor Summary

Constructors

Constructor and Description
XmlValue(XmlDecl decl)
XmlValue(XmlValue from)

Method Summary

Modifier and Type	Method and Description
void	addFromString(String valueOrig) Add a value into the Multiple values from the String (not compatible with subXml)
void	addValue(Object value) Add a value into the Multiple values from the Object
protected static Object	convert(Class<?> type, String value) Convert String value to the specified type.
boolean	getBoolean()
byte	getByte()
char	getCharacter()
Class<?>	getClassType()
Object	getCloneValue()
static Object	getCloneValue(XmlType type, Object value) Utility function to get a clone of a value
Date	getDate()
XmlDecl	getDecl()
double	getDouble()
float	getFloat()
int	getInteger()
String	getIntoString() Get a value into a String
List<?>	getList()
long	getLong()
String	getName() Get Java field name
short	getShort()
String	getString()
XmlValue[]	getSubXml()
Timestamp	getTimestamp()
XmlType	getType()
Object	getValue()
String	getXmlPath()
boolean	isEmpty() Test if the Value is empty.
boolean	isMultiple()
boolean	isSubXml()
void	setFromString(String value) Set a value from String
void	setValue(Object value)
String	toFullString()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlValue

public XmlValue(XmlDecl decl)

XmlValue

public XmlValue(XmlValue from)

Method Detail

getDecl

public final XmlDecl getDecl()

Returns:

the decl

getName

public final String getName()

Get Java field name

Returns:

the field name

getClassType

public final Class<?> getClassType()

Returns:

the type

getType

public final XmlType getType()

Returns:

the type

getXmlPath

public final String getXmlPath()

Returns:

the xmlPath

isSubXml

public final boolean isSubXml()

Returns:

True if this Value is a subXml

getSubXml

public final XmlValue[] getSubXml()

Returns:

the associated SubXML with the XmlValue (might be null if singleton or Multiple)

isMultiple

public final boolean isMultiple()

Returns:

True if the Value are list of values

getList

public final List<?> getList()

Returns:

the associated list with the XmlValues (might be null if singleton or SubXml)

addFromString

public final void addFromString(String valueOrig)
                         throws InvalidObjectException,
                                InvalidArgumentException

Add a value into the Multiple values from the String (not compatible with subXml)

Parameters:

valueOrig -

Throws:

InvalidObjectException

InvalidArgumentException

addValue

public final void addValue(Object value)
                    throws InvalidObjectException

Add a value into the Multiple values from the Object

Parameters:

value -

Throws:

InvalidObjectException

getValue

public final Object getValue()

Returns:

the value as Object (might be null if multiple)

getCloneValue

public static Object getCloneValue(XmlType type,
                                   Object value)
                            throws InvalidObjectException

Utility function to get a clone of a value

Parameters:

type -

value -

Returns:

the clone Object

Throws:

InvalidObjectException

getCloneValue

public final Object getCloneValue()
                           throws InvalidObjectException

Returns:

a clone of the value as Object (might be null if multiple)

Throws:

InvalidObjectException

getString

public final String getString()

Returns:

the value as a string

getInteger

public final int getInteger()

Returns:

the value as an integer

getBoolean

public final boolean getBoolean()

Returns:

the value as a boolean

getLong

public final long getLong()

Returns:

the value as a long

getFloat

public final float getFloat()

Returns:

the value as a float

getCharacter

public final char getCharacter()

Returns:

the value as a float

getByte

public final byte getByte()

Returns:

the value as a float

getDouble

public final double getDouble()

Returns:

the value as a float

getShort

public final short getShort()

Returns:

the value as a float

getDate

public final Date getDate()

Returns:

the value as a float

getTimestamp

public final Timestamp getTimestamp()

Returns:

the value as a float

setFromString

public final void setFromString(String value)
                         throws InvalidArgumentException

Set a value from String

Parameters:

value -

Throws:

InvalidArgumentException

isEmpty

public final boolean isEmpty()

Test if the Value is empty. If it is a SubXml or isMultiple, check if subnodes are present but not if those nodes are empty.

Returns:

True if the Value is Empty

getIntoString

public final String getIntoString()

Get a value into a String

Returns:

the value in String format

setValue

public final void setValue(Object value)
                    throws InvalidObjectException

Parameters:

value - the value to set

Throws:

InvalidObjectException

NumberFormatException

convert

protected static Object convert(Class<?> type,
                                String value)
                         throws InvalidArgumentException

Convert String value to the specified type. Throws InvalidArgumentException if type is unrecognized.

Throws:

InvalidArgumentException

toString

public String toString()

Overrides:

toString in class Object

toFullString

public final String toFullString()