io.jbotsim.io.format.xml

Enum XMLKeys

java.lang.Object

java.lang.Enum<XMLKeys>

io.jbotsim.io.format.xml.XMLKeys

All Implemented Interfaces:

Serializable, Comparable<XMLKeys>

public enum XMLKeys
extends Enum<XMLKeys>

This enumeration lists all names of elements and attributes used in JBotSim XML documents. By convention we suffixed attributes with _ATTR. The class also offers some helper methods used by parsers and builders.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XMLKeys.Function<IType,RType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_NODE
CLASS_ATTR
CLASSES
CLOCKCLASS
COLOR_ATTR
COMMUNICATION_RANGE_ATTR
DELETE_NODE
DESTINATION_ATTR
DIRECTED_ATTR
DIRECTION_ATTR
GRAPH
HEIGHT_ATTR
ICON_ATTR
IDENTIFIER_ATTR
JBOTSIM
LINK
LINK_RESOLVER
LOCATION_X_ATTR
LOCATION_Y_ATTR
LOCATION_Z_ATTR
MESSAGE_ENGINE
MOVE_NODE
NODE
NODECLASS
NODECLASS_ATTR
SCHEDULER
SELECT_NODE
SENSING_RANGE_ATTR
SIZE_ATTR
SOURCE_ATTR
START_TOPOLOGY
TIME_ATTR
TIME_UNIT_ATTR
TOPOLOGY
TRACE
VERSION_ATTR
WIDTH_ATTR
WIRELESS_ENABLED_ATTR

Field Summary

Fields

Modifier and Type	Field and Description
static XMLKeys.Function<String,Boolean>	BooleanFromString
static XMLKeys.Function<String,Double>	DoubleFromString
static XMLKeys.Function<String,Integer>	IntegerFromString

Method Summary

Modifier and Type	Method and Description
Element	createElement(Document doc) Builds an Element of the given Document doc.
Element	createElement(Document doc, Element parent) Creates an element for the given Document doc and adds it to the list of children of the node parent.
boolean	equals(String val) Checks if this enum is labelled by the given String val.
Double	getDoubleValueFor(Element el) Gets the value of this attribute as an Double.
Integer	getIntegerValueFor(Element el) Gets the value of this attribute as an Integer.
String	getValueFor(Element el) Returns the value of the attribute labelled by this enum (if it exists).
Boolean	getValueFor(Element el, Boolean default_value) Gets the value of this attribute as an Boolean.
Double	getValueFor(Element el, Double default_value) Gets the value of this attribute as an Double.
Integer	getValueFor(Element el, Integer default_value) Gets the value of this attribute as an Integer.
String	getValueFor(Element el, String default_value) Gets the value of this attribute for the given Element if the attribute exists.
<R> R	getValueFor(Element el, XMLKeys.Function<String,R> translate) Gets the value of this attribute converted to R type.
<R> R	getValueFor(Element el, XMLKeys.Function<String,R> translate, R default_value) Gets the value of this attribute converted to R type.
boolean	isAttributeOf(Element el) Checks if this enum is an attribute of the given Element el.
boolean	labelsElement(Element e) Checks if this enum labels the given Element.
void	setAttribute(Element el, String value) Sets an attribute labelled by this enum with the given value.
<T> void	setAttribute(Element el, T value) Sets an attribute labelled by this enum.
<T> void	setNotDefaultAttribute(Element el, T value, T default_value) Sets an attribute if its value is not equal to a default one.
static XMLKeys	valueOf(String name) Returns the enum constant of this type with the specified name.
static XMLKeys[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JBOTSIM

public static final XMLKeys JBOTSIM

TOPOLOGY

public static final XMLKeys TOPOLOGY

CLASSES

public static final XMLKeys CLASSES

NODECLASS

public static final XMLKeys NODECLASS

NODE

public static final XMLKeys NODE

LINK

public static final XMLKeys LINK

GRAPH

public static final XMLKeys GRAPH

LINK_RESOLVER

public static final XMLKeys LINK_RESOLVER

MESSAGE_ENGINE

public static final XMLKeys MESSAGE_ENGINE

SCHEDULER

public static final XMLKeys SCHEDULER

CLOCKCLASS

public static final XMLKeys CLOCKCLASS

VERSION_ATTR

public static final XMLKeys VERSION_ATTR

IDENTIFIER_ATTR

public static final XMLKeys IDENTIFIER_ATTR

DIRECTED_ATTR

public static final XMLKeys DIRECTED_ATTR

CLASS_ATTR

public static final XMLKeys CLASS_ATTR

SENSING_RANGE_ATTR

public static final XMLKeys SENSING_RANGE_ATTR

COMMUNICATION_RANGE_ATTR

public static final XMLKeys COMMUNICATION_RANGE_ATTR

WIRELESS_ENABLED_ATTR

public static final XMLKeys WIRELESS_ENABLED_ATTR

SOURCE_ATTR

public static final XMLKeys SOURCE_ATTR

DESTINATION_ATTR

public static final XMLKeys DESTINATION_ATTR

DIRECTION_ATTR

public static final XMLKeys DIRECTION_ATTR

TIME_UNIT_ATTR

public static final XMLKeys TIME_UNIT_ATTR

NODECLASS_ATTR

public static final XMLKeys NODECLASS_ATTR

WIDTH_ATTR

public static final XMLKeys WIDTH_ATTR

HEIGHT_ATTR

public static final XMLKeys HEIGHT_ATTR

COLOR_ATTR

public static final XMLKeys COLOR_ATTR

ICON_ATTR

public static final XMLKeys ICON_ATTR

SIZE_ATTR

public static final XMLKeys SIZE_ATTR

LOCATION_X_ATTR

public static final XMLKeys LOCATION_X_ATTR

LOCATION_Y_ATTR

public static final XMLKeys LOCATION_Y_ATTR

LOCATION_Z_ATTR

public static final XMLKeys LOCATION_Z_ATTR

TRACE

public static final XMLKeys TRACE

ADD_NODE

public static final XMLKeys ADD_NODE

DELETE_NODE

public static final XMLKeys DELETE_NODE

SELECT_NODE

public static final XMLKeys SELECT_NODE

MOVE_NODE

public static final XMLKeys MOVE_NODE

START_TOPOLOGY

public static final XMLKeys START_TOPOLOGY

TIME_ATTR

public static final XMLKeys TIME_ATTR

Field Detail

BooleanFromString

public static final XMLKeys.Function<String,Boolean> BooleanFromString

IntegerFromString

public static final XMLKeys.Function<String,Integer> IntegerFromString

DoubleFromString

public static final XMLKeys.Function<String,Double> DoubleFromString

Method Detail

values

public static XMLKeys[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (XMLKeys c : XMLKeys.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static XMLKeys valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

equals

public boolean equals(String val)

Checks if this enum is labelled by the given String val.

Parameters:

val - the String for which the enum is checked for equality.

Returns:

true if val is equal to the value of this enum.

createElement

public Element createElement(Document doc)

Builds an Element of the given Document doc. The element is labelled with the String value of this enum.

Parameters:

doc - the Document for which the element is created

Returns:

an Element labelled with this enum value.

createElement

public Element createElement(Document doc,
                             Element parent)

Creates an element for the given Document doc and adds it to the list of children of the node parent. The created element is labelled with the String that labels this enum.

Parameters:

doc - the Document for which the element is created

parent - the parent Element the created element.

Returns:

an Element labelled with this enum value.

labelsElement

public boolean labelsElement(Element e)

Checks if this enum labels the given Element.

Parameters:

e - the checked Element

Returns:

true if the name of e is the value of this enum.

setAttribute

public void setAttribute(Element el,
                         String value)

Sets an attribute labelled by this enum with the given value.

Parameters:

el - the Element for which the attribute is set.

value - of the attribute

setAttribute

public <T> void setAttribute(Element el,
                             T value)

Sets an attribute labelled by this enum. This generic method sets the attribute labelled by this enum with the given value. The type of value must be supported by a valueOf method of String.

Type Parameters:

T - the type of the value assigned to the attribute

Parameters:

el - the Element for which the attribute is set.

value - of the attribute

See Also:

String.valueOf(java.lang.Object)

setNotDefaultAttribute

public <T> void setNotDefaultAttribute(Element el,
                                       T value,
                                       T default_value)

Sets an attribute if its value is not equal to a default one.

Type Parameters:

T - the type of the value assigned to the attribute

Parameters:

el - the Element for which the attribute is set.

value - of the attribute

default_value - the default value against which value is checked for equality.

getValueFor

public String getValueFor(Element el)

Returns the value of the attribute labelled by this enum (if it exists).

Parameters:

el - the Element

Returns:

the value of the attribute labelled by this enum of null if it does noe exists.

isAttributeOf

public boolean isAttributeOf(Element el)

Checks if this enum is an attribute of the given Element el.

Parameters:

el - the checked Element

Returns:

true if el has an attribute labelled with this enum.

getValueFor

public String getValueFor(Element el,
                          String default_value)

Gets the value of this attribute for the given Element if the attribute exists. If element has an attribute with the name of this enum its (String) value is returned. If the attribute does not exists the default_value is returned.

Parameters:

el - the Element for which the attribute is read

default_value - the default value returned if the attribute is not present

Returns:

the value of this attribute.

getValueFor

public Integer getValueFor(Element el,
                           Integer default_value)

Gets the value of this attribute as an Integer. If the element has this attribute its String value is converted into an Integer using Integer.valueOf(java.lang.String, int).

Parameters:

el - the Element for which the attribute is retrieved.

default_value - the default value of the attribute if not present

Returns:

the value of this attribute.

getIntegerValueFor

public Integer getIntegerValueFor(Element el)
                           throws NoSuchElementException

Gets the value of this attribute as an Integer. If this attribute does not exists a NoSuchElementException is raised.

Parameters:

el - the Element for which the attribute is retrieved.

Returns:

the value of this attribute if present

Throws:

NoSuchElementException - if this attribute does not exists for el.

getValueFor

public Double getValueFor(Element el,
                          Double default_value)

Gets the value of this attribute as an Double. If the element has this attribute its String value is converted into an Double using Double.valueOf(java.lang.String).

Parameters:

el - the Element from which the attribute is retrieved.

default_value - the value returned if this attribute is not present.

Returns:

the value of this attribute if present or default_value if not.

getDoubleValueFor

public Double getDoubleValueFor(Element el)
                         throws NoSuchElementException

Gets the value of this attribute as an Double. If this attribute does not exists a NoSuchElementException is raised.

Parameters:

el - the Element for which the attribute is retrieved.

Returns:

the value of this attribute if present

Throws:

NoSuchElementException - if this attribute does not exists for el.

getValueFor

public Boolean getValueFor(Element el,
                           Boolean default_value)

Gets the value of this attribute as an Boolean. If the element has this attribute its String value is converted into an Boolean using Boolean.valueOf(boolean).

Parameters:

el - the Element from which the attribute is retrieved.

default_value - the value returned if this attribute is not present.

Returns:

the value of this attribute if present or default_value if not.

getValueFor

public <R> R getValueFor(Element el,
                         XMLKeys.Function<String,R> translate,
                         R default_value)

Gets the value of this attribute converted to R type. If element el has this enum as attribute, its String value is translated into an R object using the function translate. If the attribute does not exists default_value is returned.

Type Parameters:

R - the class used to store the value of this attribute.

Parameters:

el - the Element from which the attribute is retrieved.

translate - a XMLKeys.Function used to translate the String value of the attribute into R type.

default_value - the value returned if this attribute is not present.

Returns:

the value of this attribute converted using translate.

getValueFor

public <R> R getValueFor(Element el,
                         XMLKeys.Function<String,R> translate)
                  throws NoSuchElementException

Gets the value of this attribute converted to R type. If element el has this enum as attribute, its String value is translated into an R object using the function translate. If the attribute does not exists an exception is raised.

Type Parameters:

R - the class used to store the value of this attribute.

Parameters:

el - the Element from which the attribute is retrieved.

translate - a XMLKeys.Function used to translate the String value of the attribute into R type.

Returns:

the value of this attribute converted using translate.

Throws:

NoSuchElementException - if this attribute does not exists for el.