io.georocket.util

Class XMLStartElement

java.lang.Object

io.georocket.util.XMLStartElement

public class XMLStartElement
extends Object

A simple class describing an XML start element with optional prefix, namespaces and attributes.

Since:

1.0.0

Author:

Michel Kraemer

Constructor Summary

Constructors

Constructor and Description
XMLStartElement(String localName) Create a new start element with a given name
XMLStartElement(String prefix, String localName) Create a new start element with a given prefix and name
XMLStartElement(String prefix, String localName, String[] namespacePrefixes, String[] namespaceUris) Create a new start element with a given prefix, name and namespaces
XMLStartElement(String prefix, String localName, String[] attributePrefixes, String[] attributeLocalNames, String[] attributeValues) Create a new start element with a given prefix, name and attributes
XMLStartElement(String prefix, String localName, String[] namespacePrefixes, String[] namespaceUris, String[] attributePrefixes, String[] attributeLocalNames, String[] attributeValues) Create a new start element with a given prefix, name and namespaces

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static XMLStartElement	fromJsonObject(JsonObject obj) Converts a JsonObject to a XMLStartElement
int	getAttributeCount()
String	getAttributeLocalName(int i) Get the local name of an attribute at a given position
String	getAttributePrefix(int i) Get an attribute prefix at a given position
String	getAttributeValue(int i) Get an attribute value at a given position
String	getLocalName()
String	getName()
int	getNamespaceCount()
String	getNamespacePrefix(int i) Get a namespace prefix at a given position
String	getNamespaceUri(int i) Get a namespace URI at a given position
String	getPrefix()
int	hashCode()
JsonObject	toJsonObject()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLStartElement

public XMLStartElement(String localName)

Create a new start element with a given name

Parameters:

localName - the name

XMLStartElement

public XMLStartElement(String prefix,
                       String localName)

Create a new start element with a given prefix and name

Parameters:

prefix - the prefix (may be null)

localName - the name

XMLStartElement

public XMLStartElement(String prefix,
                       String localName,
                       String[] namespacePrefixes,
                       String[] namespaceUris)

Create a new start element with a given prefix, name and namespaces

Parameters:

prefix - the prefix (may be null)

localName - the name

namespacePrefixes - the namespace prefixes (may be null)

namespaceUris - the namespace URIs (may be null)

XMLStartElement

public XMLStartElement(String prefix,
                       String localName,
                       String[] attributePrefixes,
                       String[] attributeLocalNames,
                       String[] attributeValues)

Create a new start element with a given prefix, name and attributes

Parameters:

prefix - the prefix (may be null)

localName - the name

attributePrefixes - the attribute prefixes (may be null)

attributeLocalNames - the attribute names (may be null)

attributeValues - the attribute values (may be null)

XMLStartElement

public XMLStartElement(String prefix,
                       String localName,
                       String[] namespacePrefixes,
                       String[] namespaceUris,
                       String[] attributePrefixes,
                       String[] attributeLocalNames,
                       String[] attributeValues)

Create a new start element with a given prefix, name and namespaces

Parameters:

prefix - the prefix (may be null)

localName - the name

namespacePrefixes - the namespace prefixes (may be null)

namespaceUris - the namespace URIs (may be null)

attributePrefixes - the attribute prefixes (may be null)

attributeLocalNames - the attribute names (may be null)

attributeValues - the attribute values (may be null)

Method Detail

getPrefix

public String getPrefix()

Returns:

the element's prefix or null if it doesn't have one

getLocalName

public String getLocalName()

Returns:

the element's local name

getName

public String getName()

Returns:

the elements name consisting of the prefix and the local name

getNamespaceCount

public int getNamespaceCount()

Returns:

the number of namespaces attached to this element

getNamespacePrefix

public String getNamespacePrefix(int i)

Get a namespace prefix at a given position

Parameters:

i - the position

Returns:

the prefix

getNamespaceUri

public String getNamespaceUri(int i)

Get a namespace URI at a given position

Parameters:

i - the position

Returns:

the URI

getAttributeCount

public int getAttributeCount()

Returns:

the number of attributes attached to this element

getAttributePrefix

public String getAttributePrefix(int i)

Get an attribute prefix at a given position

Parameters:

i - the position

Returns:

the prefix

getAttributeLocalName

public String getAttributeLocalName(int i)

Get the local name of an attribute at a given position

Parameters:

i - the position

Returns:

the local name

getAttributeValue

public String getAttributeValue(int i)

Get an attribute value at a given position

Parameters:

i - the position

Returns:

the value

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toJsonObject

public JsonObject toJsonObject()

Returns:

this object as a JsonObject

fromJsonObject

public static XMLStartElement fromJsonObject(JsonObject obj)

Converts a JsonObject to a XMLStartElement

Parameters:

obj - the JsonObject to convert

Returns:

the XMLStartElement