JAXB OSGI 4.0.9 · com.sun.xml.fastinfoset.stax.events.EventBase

Modifier and Type	Field and Description
protected int	_eventType
protected Location	_location

Access	Constructor and Description
protected	EventBase()
protected	EventBase(int eventType)

Method Summary

Modifier and Type	Method and Description
public Characters	asCharacters() Implements javax.xml.stream.events.XMLEvent.asCharacters. Returns this event as Characters, may result in a class cast exception if this event is not Characters.
public EndElement	asEndElement() Implements javax.xml.stream.events.XMLEvent.asEndElement. 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.xml.stream.events.XMLEvent.asStartElement. Returns this event as a start element event, may result in a class cast exception if this event is not a start element.
public int	getEventType() Implements javax.xml.stream.events.XMLEvent.getEventType. Returns an integer code for this event.
private String	getEventTypeString()
public Location	getLocation() Implements javax.xml.stream.events.XMLEvent.getLocation. Return the location of this event.
public QName	getSchemaType() Implements javax.xml.stream.events.XMLEvent.getSchemaType. This method is provided for implementations to provide optional type information about the associated event.
public String	getSystemId()
public boolean	isAttribute() Implements javax.xml.stream.events.XMLEvent.isAttribute. A utility function to check if this event is an Attribute.
public boolean	isCharacters() Implements javax.xml.stream.events.XMLEvent.isCharacters. A utility function to check if this event is Characters.
public boolean	isEndDocument() Implements javax.xml.stream.events.XMLEvent.isEndDocument. A utility function to check if this event is an EndDocument.
public boolean	isEndElement() Implements javax.xml.stream.events.XMLEvent.isEndElement. A utility function to check if this event is a EndElement.
public boolean	isEntityReference() Implements javax.xml.stream.events.XMLEvent.isEntityReference. A utility function to check if this event is an EntityReference.
public boolean	isNamespace() Implements javax.xml.stream.events.XMLEvent.isNamespace. A utility function to check if this event is a Namespace.
public boolean	isProcessingInstruction() Implements javax.xml.stream.events.XMLEvent.isProcessingInstruction. A utility function to check if this event is a ProcessingInstruction.
public boolean	isStartDocument() Implements javax.xml.stream.events.XMLEvent.isStartDocument. A utility function to check if this event is a StartDocument.
public boolean	isStartElement() Implements javax.xml.stream.events.XMLEvent.isStartElement. A utility function to check if this event is a StartElement.
protected final void	setEventType(int eventType)
public void	setLocation(Location loc)
public void	writeAsEncodedUnicode(Writer The writer that will output the data writer) Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode. This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_eventType	back to summary
protected int _eventType

_location	back to summary
protected Location _location

EventBase	back to summary
protected EventBase()

EventBase	back to summary
protected EventBase(int eventType)

Method Detail

asCharacters	back to summary
public Characters asCharacters() Implements javax.xml.stream.events.XMLEvent.asCharacters. Returns this event as Characters, may result in a class cast exception if this event is not Characters. Annotations @Override

asCharacters

back to summary

public Characters asCharacters()

Implements javax.xml.stream.events.XMLEvent.asCharacters.

Returns this event as Characters, may result in a class cast exception if this event is not Characters.

Annotations

@Override

asEndElement	back to summary
public EndElement asEndElement() Implements javax.xml.stream.events.XMLEvent.asEndElement. Returns this event as an end element event, may result in a class cast exception if this event is not a end element. Annotations @Override

asEndElement

back to summary

public EndElement asEndElement()

Implements javax.xml.stream.events.XMLEvent.asEndElement.

Returns this event as an end element event, may result in a class cast exception if this event is not a end element.

Annotations

@Override

asStartElement	back to summary
public StartElement asStartElement() Implements javax.xml.stream.events.XMLEvent.asStartElement. Returns this event as a start element event, may result in a class cast exception if this event is not a start element. Annotations @Override

asStartElement

back to summary

public StartElement asStartElement()

Implements javax.xml.stream.events.XMLEvent.asStartElement.

Returns this event as a start element event, may result in a class cast exception if this event is not a start element.

Annotations

@Override

getEventType	back to summary
public int getEventType() Implements javax.xml.stream.events.XMLEvent.getEventType. Returns an integer code for this event. Annotations @Override

getEventType

back to summary

public int getEventType()

Implements javax.xml.stream.events.XMLEvent.getEventType.

Returns an integer code for this event.

Annotations

@Override

getEventTypeString	back to summary
private String getEventTypeString()

getLocation back to summary

getLocation	back to summary
public Location getLocation() Implements javax.xml.stream.events.XMLEvent.getLocation. Return the location of this event. The Location returned from this method is non-volatile and will retain its information. Annotations @Override See Also `javax.xml.stream.Location`

public Location getLocation()

Implements javax.xml.stream.events.XMLEvent.getLocation.

Return the location of this event. The Location returned from this method is non-volatile and will retain its information.

Annotations

@Override

See Also

javax.xml.stream.Location

getSchemaType	back to summary
public QName getSchemaType() Implements javax.xml.stream.events.XMLEvent.getSchemaType. 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. Annotations @Override

getSchemaType

back to summary

public QName getSchemaType()

Implements javax.xml.stream.events.XMLEvent.getSchemaType.

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.

Annotations

@Override

getSystemId	back to summary
public String getSystemId()

isAttribute back to summary

isAttribute	back to summary
public boolean isAttribute() Implements javax.xml.stream.events.XMLEvent.isAttribute. A utility function to check if this event is an Attribute. Annotations @Override See Also `javax.xml.stream.events.Attribute`

public boolean isAttribute()

Implements javax.xml.stream.events.XMLEvent.isAttribute.

A utility function to check if this event is an Attribute.

Annotations

@Override

See Also

javax.xml.stream.events.Attribute

isCharacters back to summary

isCharacters	back to summary
public boolean isCharacters() Implements javax.xml.stream.events.XMLEvent.isCharacters. A utility function to check if this event is Characters. Annotations @Override See Also `javax.xml.stream.events.Characters`

public boolean isCharacters()

Implements javax.xml.stream.events.XMLEvent.isCharacters.

A utility function to check if this event is Characters.

Annotations

@Override

See Also

javax.xml.stream.events.Characters

isEndDocument	back to summary
public boolean isEndDocument() Implements javax.xml.stream.events.XMLEvent.isEndDocument. Doc from javax.xml.stream.events.XMLEvent.isEndDocument. A utility function to check if this event is an EndDocument. Annotations @Override

isEndDocument

back to summary

public boolean isEndDocument()

Implements javax.xml.stream.events.XMLEvent.isEndDocument.

Doc from javax.xml.stream.events.XMLEvent.isEndDocument.

A utility function to check if this event is an EndDocument.

Annotations

@Override

isEndElement	back to summary
public boolean isEndElement() Implements javax.xml.stream.events.XMLEvent.isEndElement. Doc from javax.xml.stream.events.XMLEvent.isEndElement. A utility function to check if this event is a EndElement. Annotations @Override

isEndElement

back to summary

public boolean isEndElement()

Implements javax.xml.stream.events.XMLEvent.isEndElement.

Doc from javax.xml.stream.events.XMLEvent.isEndElement.

A utility function to check if this event is a EndElement.

Annotations

@Override

isEntityReference	back to summary
public boolean isEntityReference() Implements javax.xml.stream.events.XMLEvent.isEntityReference. Doc from javax.xml.stream.events.XMLEvent.isEntityReference. A utility function to check if this event is an EntityReference. Annotations @Override

isEntityReference

back to summary

public boolean isEntityReference()

Implements javax.xml.stream.events.XMLEvent.isEntityReference.

Doc from javax.xml.stream.events.XMLEvent.isEntityReference.

A utility function to check if this event is an EntityReference.

Annotations

@Override

isNamespace back to summary

isNamespace	back to summary
public boolean isNamespace() Implements javax.xml.stream.events.XMLEvent.isNamespace. A utility function to check if this event is a Namespace. Annotations @Override See Also `javax.xml.stream.events.Namespace`

public boolean isNamespace()

Implements javax.xml.stream.events.XMLEvent.isNamespace.

A utility function to check if this event is a Namespace.

Annotations

@Override

See Also

javax.xml.stream.events.Namespace

isProcessingInstruction	back to summary
public boolean isProcessingInstruction() Implements javax.xml.stream.events.XMLEvent.isProcessingInstruction. Doc from javax.xml.stream.events.XMLEvent.isProcessingInstruction. A utility function to check if this event is a ProcessingInstruction. Annotations @Override

isProcessingInstruction

back to summary

public boolean isProcessingInstruction()

Implements javax.xml.stream.events.XMLEvent.isProcessingInstruction.

Doc from javax.xml.stream.events.XMLEvent.isProcessingInstruction.

A utility function to check if this event is a ProcessingInstruction.

Annotations

@Override

isStartDocument	back to summary
public boolean isStartDocument() Implements javax.xml.stream.events.XMLEvent.isStartDocument. Doc from javax.xml.stream.events.XMLEvent.isStartDocument. A utility function to check if this event is a StartDocument. Annotations @Override

isStartDocument

back to summary

public boolean isStartDocument()

Implements javax.xml.stream.events.XMLEvent.isStartDocument.

Doc from javax.xml.stream.events.XMLEvent.isStartDocument.

A utility function to check if this event is a StartDocument.

Annotations

@Override

isStartElement	back to summary
public boolean isStartElement() Implements javax.xml.stream.events.XMLEvent.isStartElement. Doc from javax.xml.stream.events.XMLEvent.isStartElement. A utility function to check if this event is a StartElement. Annotations @Override

isStartElement

back to summary

public boolean isStartElement()

Implements javax.xml.stream.events.XMLEvent.isStartElement.

Doc from javax.xml.stream.events.XMLEvent.isStartElement.

A utility function to check if this event is a StartElement.

Annotations

@Override

setEventType	back to summary
protected final void setEventType(int eventType)

setLocation	back to summary
public void setLocation(Location loc)

writeAsEncodedUnicode	back to summary
public void writeAsEncodedUnicode(Writer writer) throws XMLStreamException Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode. 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. Parameters writer:Writer The writer that will output the data Annotations @Override Exceptions XMLStreamException: if there is a fatal error writing the event

writeAsEncodedUnicode

back to summary

public void writeAsEncodedUnicode(Writer writer) throws XMLStreamException

Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode.

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.

Parameters

writer:Writer: The writer that will output the data

Annotations

@Override

Exceptions

XMLStreamException:: if there is a fatal error writing the event

public abstract Class EventBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail