net.lecousin.framework.xml

Class XMLStreamEvents

java.lang.Object

net.lecousin.framework.xml.XMLStreamEvents

Direct Known Subclasses:

XMLStreamEventsAsync, XMLStreamEventsSync

public abstract class XMLStreamEvents
extends Object

Base class to parse XML raising an event each time a new element (comment, text, node... is found).
It is used by synchronous (XMLStreamEventsSync) and asynchronous (XMLStreamEventsAsync) implementations.
This class defines the different types of event, and the available information for each event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLStreamEvents.Attribute An attribute on an element node.
static class	XMLStreamEvents.ElementContext Information about an Element node.
static class	XMLStreamEvents.Event Parsing event.
protected static class	XMLStreamEvents.Starter Helper class to start parsing the XML file and detect the encoding, either with a BOM or with the XML declaration tag.

Field Summary

Fields

Modifier and Type	Field and Description
XMLStreamEvents.Event	event
protected int	maxCDataSize
protected int	maxTextSize
protected ICharacterStream.Readable.Buffered	stream

Constructor Summary

Constructors

Constructor and Description
XMLStreamEvents()

Method Summary

Modifier and Type	Method and Description
XMLStreamEvents.Attribute	getAttributeByFullName(CharSequence name) Shortcut to get the attribute for the given full name.
XMLStreamEvents.Attribute	getAttributeByLocalName(CharSequence name) Shortcut to get the attibute for the given local name.
UnprotectedStringBuffer	getAttributeValueByFullName(CharSequence name) Shortcut to get the value of the given attribute name.
UnprotectedStringBuffer	getAttributeValueByLocalName(CharSequence name) Shortcut to get the value of the given attribute name.
UnprotectedStringBuffer	getAttributeValueWithNamespaceURI(CharSequence uri, CharSequence name) Shortcut to get the value of the given attribute name.
UnprotectedStringBuffer	getAttributeValueWithPrefix(CharSequence prefix, CharSequence name) Shortcut to get the value of the given attribute name.
XMLStreamEvents.Attribute	getAttributeWithNamespaceURI(CharSequence uri, CharSequence name) Shortcut to get the attribute for the given namespace URI and local name.
XMLStreamEvents.Attribute	getAttributeWithPrefix(CharSequence prefix, CharSequence name) Shortcut to get the attribute for the given namespace prefix and local name.
ICharacterStream.Readable.Buffered	getCharacterStream()
int	getMaximumCDataSize()
int	getMaximumTextSize()
UnprotectedStringBuffer	getNamespaceURI(CharSequence namespacePrefix) Get the namespace URI for a prefix, or empty string if the prefix is not defined.
static boolean	isNameChar(char c) Return true if the given character is a valid character for a name.
static boolean	isNameStartChar(char c) Return true if the given character is a valid starting character for a name.
static boolean	isSpaceChar(char c) Return true if the given character is considered as a white space.
protected void	onStartElement(int i)
protected void	readNamespaces(XMLStreamEvents.ElementContext ctx)
XMLStreamEvents.Attribute	removeAttributeByFullName(CharSequence name) Remove and return the attribute for the given full name if it exists.
XMLStreamEvents.Attribute	removeAttributeByLocalName(CharSequence name) Remove and return the attibute for the given local name if it exists.
XMLStreamEvents.Attribute	removeAttributeWithNamespaceURI(CharSequence uri, CharSequence name) Remove and return the attribute for the given namespace URI and local name if it exists.
XMLStreamEvents.Attribute	removeAttributeWithPrefix(CharSequence prefix, CharSequence name) Remove and return the attribute for the given namespace prefix and local name if it exists.
protected void	reset()
void	setMaximumCDataSize(int max)
void	setMaximumTextSize(int max)

Methods inherited from class java.lang.Object

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

Field Detail

event

public XMLStreamEvents.Event event

maxTextSize

protected int maxTextSize

maxCDataSize

protected int maxCDataSize

stream

protected ICharacterStream.Readable.Buffered stream

Constructor Detail

XMLStreamEvents

public XMLStreamEvents()

Method Detail

getCharacterStream

public final ICharacterStream.Readable.Buffered getCharacterStream()

getMaximumTextSize

public int getMaximumTextSize()

setMaximumTextSize

public void setMaximumTextSize(int max)

getMaximumCDataSize

public int getMaximumCDataSize()

setMaximumCDataSize

public void setMaximumCDataSize(int max)

getNamespaceURI

public UnprotectedStringBuffer getNamespaceURI(CharSequence namespacePrefix)

Get the namespace URI for a prefix, or empty string if the prefix is not defined.

getAttributeByFullName

public XMLStreamEvents.Attribute getAttributeByFullName(CharSequence name)

Shortcut to get the attribute for the given full name.

getAttributeByLocalName

public XMLStreamEvents.Attribute getAttributeByLocalName(CharSequence name)

Shortcut to get the attibute for the given local name.

getAttributeWithPrefix

public XMLStreamEvents.Attribute getAttributeWithPrefix(CharSequence prefix,
                                                        CharSequence name)

Shortcut to get the attribute for the given namespace prefix and local name.

getAttributeWithNamespaceURI

public XMLStreamEvents.Attribute getAttributeWithNamespaceURI(CharSequence uri,
                                                              CharSequence name)

Shortcut to get the attribute for the given namespace URI and local name.

getAttributeValueByFullName

public UnprotectedStringBuffer getAttributeValueByFullName(CharSequence name)

Shortcut to get the value of the given attribute name.

getAttributeValueByLocalName

public UnprotectedStringBuffer getAttributeValueByLocalName(CharSequence name)

Shortcut to get the value of the given attribute name.

getAttributeValueWithPrefix

public UnprotectedStringBuffer getAttributeValueWithPrefix(CharSequence prefix,
                                                           CharSequence name)

Shortcut to get the value of the given attribute name.

getAttributeValueWithNamespaceURI

public UnprotectedStringBuffer getAttributeValueWithNamespaceURI(CharSequence uri,
                                                                 CharSequence name)

Shortcut to get the value of the given attribute name.

removeAttributeByFullName

public XMLStreamEvents.Attribute removeAttributeByFullName(CharSequence name)

Remove and return the attribute for the given full name if it exists.

removeAttributeByLocalName

public XMLStreamEvents.Attribute removeAttributeByLocalName(CharSequence name)

Remove and return the attibute for the given local name if it exists.

removeAttributeWithPrefix

public XMLStreamEvents.Attribute removeAttributeWithPrefix(CharSequence prefix,
                                                           CharSequence name)

Remove and return the attribute for the given namespace prefix and local name if it exists.

removeAttributeWithNamespaceURI

public XMLStreamEvents.Attribute removeAttributeWithNamespaceURI(CharSequence uri,
                                                                 CharSequence name)

Remove and return the attribute for the given namespace URI and local name if it exists.

reset

protected void reset()

onStartElement

protected void onStartElement(int i)

readNamespaces

protected void readNamespaces(XMLStreamEvents.ElementContext ctx)

isSpaceChar

public static boolean isSpaceChar(char c)

Return true if the given character is considered as a white space.

isNameStartChar

public static boolean isNameStartChar(char c)

Return true if the given character is a valid starting character for a name.

isNameChar

public static boolean isNameChar(char c)

Return true if the given character is a valid character for a name.