hu.akarnokd.xml

Class XElementBase

java.lang.Object

hu.akarnokd.xml.XElementBase

Direct Known Subclasses:

XElement, XNElement

public abstract class XElementBase
extends java.lang.Object

The base interface for XElement and XNElement's common methods.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	content The content of a simple node.
java.lang.String	name The element name.
protected java.lang.Object	userObject The user object to tag along.
static java.lang.String	XSD The XSD namespace.
static java.lang.String	XSI The XSD instance URI.

Constructor Summary

Constructors

Constructor and Description
XElementBase(java.lang.String name) Constructor, sets the element name.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	childValue(java.lang.String name) Returns the content of the first child which has the given name.
abstract XElementBase	copy()
double	doubleValue(java.lang.String name) Returns a double value of the supplied child or throws an exception if missing.
double	doubleValue(java.lang.String name, double defaultValue) Returns a double value or the default value if the element is missing or empty.
static java.lang.String	formatDateTime(java.util.Date date) Convert the given date to string.
static java.lang.String	formatDateTime(java.time.temporal.TemporalAccessor temporal) Convert the given date to string.
int	intValue(java.lang.String name) Returns an integer value of the supplied child or throws an exception if missing.
int	intValue(java.lang.String name, int defaultValue) Returns an integer value or the default value if the element is missing or empty.
long	longValue(java.lang.String name) Returns a long value of the supplied child or throws an exception if missing.
long	longValue(java.lang.String name, long defaultValue) Returns a long value or the default value if the element is missing or empty.
static java.time.OffsetDateTime	parseDateTime(java.lang.String date) Parse an XSD dateTime.
static java.lang.String	sanitize(java.lang.String s) Converts all sensitive characters to its HTML entity equivalent.
void	setValue(java.lang.Object value) Sets or clears the content of this element.

Methods inherited from class java.lang.Object

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

Field Detail

XSD

public static final java.lang.String XSD

The XSD namespace.

See Also:

Constant Field Values

XSI

public static final java.lang.String XSI

The XSD instance URI.

See Also:

Constant Field Values

content

public java.lang.String content

The content of a simple node.

name

public final java.lang.String name

The element name.

userObject

protected java.lang.Object userObject

The user object to tag along.

Constructor Detail

XElementBase

public XElementBase(java.lang.String name)

Constructor, sets the element name.

Parameters:

name - the element name

Method Detail

formatDateTime

public static java.lang.String formatDateTime(java.util.Date date)

Convert the given date to string. Always contains the milliseconds and timezone.

Parameters:

date - the date, not null

Returns:

the formatted date

formatDateTime

public static java.lang.String formatDateTime(java.time.temporal.TemporalAccessor temporal)

Convert the given date to string. Always contains the milliseconds and timezone.

Parameters:

temporal - temporal accessible

Returns:

the formatted date

parseDateTime

public static java.time.OffsetDateTime parseDateTime(java.lang.String date)
                                              throws java.text.ParseException

Parse an XSD dateTime.

Parameters:

date - the date string

Returns:

the date

Throws:

java.text.ParseException - format exception

sanitize

public static java.lang.String sanitize(java.lang.String s)

Converts all sensitive characters to its HTML entity equivalent.

Parameters:

s - the string to convert, can be null

Returns:

the converted string, or an empty string

intValue

public int intValue(java.lang.String name)

Returns an integer value of the supplied child or throws an exception if missing.

Parameters:

name - the child element name

Returns:

the value

intValue

public int intValue(java.lang.String name,
                    int defaultValue)

Returns an integer value or the default value if the element is missing or empty.

Parameters:

name - the element name

defaultValue - the default value

Returns:

the value

longValue

public long longValue(java.lang.String name)

Returns a long value of the supplied child or throws an exception if missing.

Parameters:

name - the child element name

Returns:

the value

longValue

public long longValue(java.lang.String name,
                      long defaultValue)

Returns a long value or the default value if the element is missing or empty.

Parameters:

name - the element name

defaultValue - the default value

Returns:

the value

doubleValue

public double doubleValue(java.lang.String name)

Returns a double value of the supplied child or throws an exception if missing.

Parameters:

name - the child element name

Returns:

the value

doubleValue

public double doubleValue(java.lang.String name,
                          double defaultValue)

Returns a double value or the default value if the element is missing or empty.

Parameters:

name - the element name

defaultValue - the default value

Returns:

the value

childValue

public abstract java.lang.String childValue(java.lang.String name)

Returns the content of the first child which has the given name.

Parameters:

name - the child name

Returns:

the content or null if no such child

setValue

public final void setValue(java.lang.Object value)

Sets or clears the content of this element.

Parameters:

value - the value set or null to clear

copy

public abstract XElementBase copy()

Returns:

Creates a deep copy of this element.