Package org.apache.sis.xml

Class TransformedEvent<E extends XMLEvent>

java.lang.Object

org.apache.sis.xml.TransformedEvent<E>

All Implemented Interfaces:

XMLEvent, XMLStreamConstants

Direct Known Subclasses:

TransformedEvent.Attr, TransformedEvent.End, TransformedEvent.NS, TransformedEvent.Start

abstract class TransformedEvent<E extends XMLEvent>
extends Object
implements XMLEvent

Base class of events that are wrappers over the events emitted during the reading or writing of an XML document. Those wrappers are used for changing the namespace and sometimes the name of XML elements or attributes.

Since:

1.0

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TransformedEvent.Attr	Wrapper over an attribute emitted during the reading or writing of an XML document.
(package private) static final class	TransformedEvent.End	Wrapper over an element emitted during the reading or writing of an XML document.
(package private) static final class	TransformedEvent.NS	Wrapper over a namespace emitted during the reading or writing of an XML document.
(package private) static class	TransformedEvent.Start	Wrapper over an element emitted during the reading or writing of an XML document.
(package private) static final class	TransformedEvent.Type	The "xsi:type" attribute.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final E	event	The event to be exported in a different namespace.
(package private) final QName	name	Exported name of the attribute or element.

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

Constructors

Constructor	Description
TransformedEvent(E event, QName name)	Exports a new event.

Method Summary

Modifier and Type	Method	Description
Characters	asCharacters()
EndElement	asEndElement()
StartElement	asStartElement()
Location	getLocation()
final QName	getName()
QName	getSchemaType()
boolean	isAttribute()
boolean	isCharacters()
boolean	isEndDocument()
boolean	isEndElement()
boolean	isEntityReference()
boolean	isNamespace()
boolean	isProcessingInstruction()
boolean	isStartDocument()
boolean	isStartElement()
(package private) final Appendable	name(Appendable out)	Appends the name to the given output.
final String	toString()	Returns the event as per the XML 1.0 without indentation or whitespace.
(package private) abstract void	write(Appendable out)	Implementation of writeAsEncodedUnicode(Writer) and toString().
final void	writeAsEncodedUnicode(Writer writer)	Writes the event as per the XML 1.0 without indentation or whitespace.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.stream.events.XMLEvent

getEventType

Field Details

event

final E extends XMLEvent event

The event to be exported in a different namespace.

name

final QName name

Exported name of the attribute or element. Will often (but not necessarily) have the same local part than event.getName() but a different namespace.

Constructor Details

TransformedEvent

TransformedEvent(E event,
 QName name)

Exports a new event.

Parameters:

event - the event to be exported in a different namespace.

name - the exported name of the attribute or element.

Method Details

isStartElement

public boolean isStartElement()

Specified by:

isStartElement in interface XMLEvent

isAttribute

public boolean isAttribute()

Specified by:

isAttribute in interface XMLEvent

isNamespace

public boolean isNamespace()

Specified by:

isNamespace in interface XMLEvent

isEndElement

public boolean isEndElement()

Specified by:

isEndElement in interface XMLEvent

isEntityReference

public boolean isEntityReference()

Specified by:

isEntityReference in interface XMLEvent

isProcessingInstruction

public boolean isProcessingInstruction()

Specified by:

isProcessingInstruction in interface XMLEvent

isCharacters

public boolean isCharacters()

Specified by:

isCharacters in interface XMLEvent

isStartDocument

public boolean isStartDocument()

Specified by:

isStartDocument in interface XMLEvent

isEndDocument

public boolean isEndDocument()

Specified by:

isEndDocument in interface XMLEvent

asStartElement

public StartElement asStartElement()

Specified by:

asStartElement in interface XMLEvent

asEndElement

public EndElement asEndElement()

Specified by:

asEndElement in interface XMLEvent

asCharacters

public Characters asCharacters()

Specified by:

asCharacters in interface XMLEvent

getLocation

public Location getLocation()

Specified by:

getLocation in interface XMLEvent

getSchemaType

public QName getSchemaType()

Specified by:

getSchemaType in interface XMLEvent

getName

public final QName getName()

name

final Appendable name(Appendable out)
               throws IOException

Appends the name to the given output. This is a convenience method for write(Appendable) implementations.

Throws:

IOException

write

abstract void write(Appendable out)
             throws IOException

Implementation of writeAsEncodedUnicode(Writer) and toString().

Throws:

IOException

writeAsEncodedUnicode

public final void writeAsEncodedUnicode(Writer writer)
                                 throws XMLStreamException

Writes the event as per the XML 1.0 without indentation or whitespace. This implementation delegates to write(Appendable).

Specified by:

writeAsEncodedUnicode in interface XMLEvent

Throws:

XMLStreamException

toString

public final String toString()

Returns the event as per the XML 1.0 without indentation or whitespace. This implementation delegates to write(Appendable).

Overrides:

toString in class Object