Modifier and Type | Class and Description |
---|---|
pack-priv static class |
Modifier and Type | Field and Description |
---|---|
private int | |
protected Location | |
private static DummyEvent. |
Access | Constructor and Description |
---|---|
public | |
public |
Modifier and Type | Method and Description |
---|---|
public Characters | asCharacters()
Implements javax. Returns this event as Characters, may result in a class cast exception if this event is not Characters. |
public EndElement | asEndElement()
Implements javax. Returns this event as an end element event, may result in a class cast exception if this event is not a end element. |
public StartElement | asStartElement()
Implements javax. Returns this event as a start element event, may result in a class cast exception if this event is not a start element. |
protected void | charEncode(Writer writer, String data)
Helper method to escape < > & for characters event and quotes, lt and amps for Entity |
public int | getEventType()
Implements javax. Returns an integer code for this event. |
public Location | getLocation()
Implements javax. Return the location of this event. |
public QName | getSchemaType()
Implements javax. This method is provided for implementations to provide optional type information about the associated event. |
public boolean | isAttribute()
Implements javax. A utility function to check if this event is an Attribute. |
public boolean | |
public boolean | isCharacters()
Implements javax. A utility function to check if this event is Characters. |
public boolean | isEndDocument()
Implements javax. A utility function to check if this event is an EndDocument. |
public boolean | isEndElement()
Implements javax. A utility function to check if this event is a EndElement. |
public boolean | isEntityReference()
Implements javax. A utility function to check if this event is an EntityReference. |
public boolean | isNamespace()
Implements javax. A utility function to check if this event is a Namespace. |
public boolean | isProcessingInstruction()
Implements javax. A utility function to check if this event is a ProcessingInstruction. |
public boolean | isStartDocument()
Implements javax. A utility function to check if this event is a StartDocument. |
public boolean | isStartElement()
Implements javax. A utility function to check if this event is a StartElement. |
protected void | |
pack-priv void | |
public void | writeAsEncodedUnicode(Writer
The writer that will output the data writer)Implements javax. This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. |
protected abstract void | writeAsEncodedUnicodeEx(Writer
The writer that will output the data writer)Helper method in order to expose IOException. |
fEventType | back to summary |
---|---|
private int fEventType |
fLocation | back to summary |
---|---|
protected Location fLocation |
nowhere | back to summary |
---|---|
private static DummyEvent. |
DummyEvent | back to summary |
---|---|
public DummyEvent() |
DummyEvent | back to summary |
---|---|
public DummyEvent(int i) |
asCharacters | back to summary |
---|---|
public Characters asCharacters() Implements javax. Returns this event as Characters, may result in a class cast exception if this event is not Characters.
|
asEndElement | back to summary |
---|---|
public EndElement asEndElement() Implements javax. Returns this event as an end element event, may result in a class cast exception if this event is not a end element.
|
asStartElement | back to summary |
---|---|
public StartElement asStartElement() Implements javax. Returns this event as a start element event, may result in a class cast exception if this event is not a start element.
|
charEncode | back to summary |
---|---|
protected void charEncode(Writer writer, String data) throws IOException Helper method to escape < > & for characters event and quotes, lt and amps for Entity |
getEventType | back to summary |
---|---|
public int getEventType() Implements javax. Doc from javax. Returns an integer code for this event.
|
getLocation | back to summary |
---|---|
public Location getLocation() Implements javax. Doc from javax. Return the location of this event. The Location returned from this method is non-volatile and will retain its information.
|
getSchemaType | back to summary |
---|---|
public QName getSchemaType() Implements javax. This method is provided for implementations to provide optional type information about the associated event. It is optional and will return null if no information is available.
|
isAttribute | back to summary |
---|---|
public boolean isAttribute() Implements javax. A utility function to check if this event is an Attribute.
|
isCharacterData | back to summary |
---|---|
public boolean isCharacterData() |
isCharacters | back to summary |
---|---|
public boolean isCharacters() Implements javax. A utility function to check if this event is Characters.
|
isEndDocument | back to summary |
---|---|
public boolean isEndDocument() Implements javax. Doc from javax. A utility function to check if this event is an EndDocument.
|
isEndElement | back to summary |
---|---|
public boolean isEndElement() Implements javax. Doc from javax. A utility function to check if this event is a EndElement.
|
isEntityReference | back to summary |
---|---|
public boolean isEntityReference() Implements javax. Doc from javax. A utility function to check if this event is an EntityReference.
|
isNamespace | back to summary |
---|---|
public boolean isNamespace() Implements javax. A utility function to check if this event is a Namespace.
|
isProcessingInstruction | back to summary |
---|---|
public boolean isProcessingInstruction() Implements javax. Doc from javax. A utility function to check if this event is a ProcessingInstruction.
|
isStartDocument | back to summary |
---|---|
public boolean isStartDocument() Implements javax. Doc from javax. A utility function to check if this event is a StartDocument.
|
isStartElement | back to summary |
---|---|
public boolean isStartElement() Implements javax. Doc from javax. A utility function to check if this event is a StartElement.
|
setEventType | back to summary |
---|---|
protected void setEventType(int eventType) |
setLocation | back to summary |
---|---|
pack-priv void setLocation(Location loc) |
writeAsEncodedUnicode | back to summary |
---|---|
public void writeAsEncodedUnicode(Writer writer) throws XMLStreamException Implements javax. This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. No indentation or whitespace should be outputted. Any user defined event type SHALL have this method called when being written to on an output stream. Built in Event types MUST implement this method, but implementations MAY choose not call these methods for optimizations reasons when writing out built in Events to an output stream. The output generated MUST be equivalent in terms of the infoset expressed.
|
writeAsEncodedUnicodeEx | back to summary |
---|---|
protected abstract void writeAsEncodedUnicodeEx(Writer writer) throws IOException, XMLStreamException Helper method in order to expose IOException.
|
Access | Constructor and Description |
---|---|
public |
Modifier and Type | Method and Description |
---|---|
public int | getCharacterOffset()
Implements javax. Return the byte or character offset into the input source this location is pointing to. |
public int | getColumnNumber()
Implements javax. Return the column number where the current event ends, returns -1 if none is available. |
public int | getLineNumber()
Implements javax. Return the line number where the current event ends, returns -1 if none is available. |
public String | |
public String |
DummyLocation | back to summary |
---|---|
public DummyLocation() |
getCharacterOffset | back to summary |
---|---|
public int getCharacterOffset() Implements javax. Doc from javax. Return the byte or character offset into the input source this location is pointing to. If the input source is a file or a byte stream then this is the byte offset into that stream, but if the input source is a character media then the offset is the character offset. Returns -1 if there is no offset available.
|
getColumnNumber | back to summary |
---|---|
public int getColumnNumber() Implements javax. Doc from javax. Return the column number where the current event ends, returns -1 if none is available.
|
getLineNumber | back to summary |
---|---|
public int getLineNumber() Implements javax. Doc from javax. Return the line number where the current event ends, returns -1 if none is available.
|
getPublicId | back to summary |
---|---|
public String getPublicId() Implements javax. Doc from javax. Returns the public ID of the XML
|
getSystemId | back to summary |
---|---|
public String getSystemId() Implements javax. Doc from javax. Returns the system ID of the XML
|