Top Fields Constructors Methods
org.codehaus.stax2.ri.evt

public Class ProcInstrEventImpl

extends BaseEventImpl
implements ProcessingInstruction
Class Inheritance
All Implemented Interfaces
javax.xml.stream.events.ProcessingInstruction, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants
Imports
java.io.IOException, .Writer, javax.xml.stream.*, javax.xml.stream.events.ProcessingInstruction, org.codehaus.stax2.*

Field Summary

Modifier and TypeField and Description
pack-priv final String
mData

pack-priv final String
mTarget

Inherited from org.codehaus.stax2.ri.evt.BaseEventImpl:
mLocation

Constructor Summary

AccessConstructor and Description
public
ProcInstrEventImpl(Location loc, String target, String data)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.equals.

Declared abstract to force redefinition by sub-classes
public String
getData()

Implements javax.xml.stream.events.ProcessingInstruction.getData.

The data section of the processing instruction
public int
getEventType()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.getEventType.

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

Returns an integer code for this event.
public String
getTarget()

Implements javax.xml.stream.events.ProcessingInstruction.getTarget.

The target section of the processing instruction
public int
hashCode()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode.

Declared abstract to force redefinition by sub-classes
public boolean
isProcessingInstruction()

Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.isProcessingInstruction.

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

A utility function to check if this event is a ProcessingInstruction.
public void
writeAsEncodedUnicode(Writer
The writer that will output the data
w)

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeAsEncodedUnicode.

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

This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
public void
writeUsing(XMLStreamWriter2 w)

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeUsing.

Implements org.codehaus.stax2.evt.XMLEvent2.writeUsing.

Inherited from org.codehaus.stax2.ri.evt.BaseEventImpl:
addHashasCharactersasEndElementasStartElementgetLocationgetSchemaTypeisAttributeisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisStartDocumentisStartElementiteratedEqualsstringsWithNullsEqualthrowFromIOEtoString

Field Detail

mDataback to summary
pack-priv final String mData
mTargetback to summary
pack-priv final String mTarget

Constructor Detail

ProcInstrEventImplback to summary
public ProcInstrEventImpl(Location loc, String target, String data)

Method Detail

equalsback to summary
public boolean equals(Object o)

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.equals.

Doc from org.codehaus.stax2.ri.evt.BaseEventImpl.equals.

Declared abstract to force redefinition by sub-classes

Parameters
o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getDataback to summary
public String getData()

Implements javax.xml.stream.events.ProcessingInstruction.getData.

Doc from javax.xml.stream.events.ProcessingInstruction.getData.

The data section of the processing instruction

Returns:String

the String value of the PI's data or null

Annotations
@Override
getEventTypeback to summary
public int getEventType()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.getEventType.

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

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

Returns an integer code for this event.

Returns:int

the event type

Annotations
@Override
getTargetback to summary
public String getTarget()

Implements javax.xml.stream.events.ProcessingInstruction.getTarget.

Doc from javax.xml.stream.events.ProcessingInstruction.getTarget.

The target section of the processing instruction

Returns:String

the String value of the PI or null

Annotations
@Override
hashCodeback to summary
public int hashCode()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode.

Doc from org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode.

Declared abstract to force redefinition by sub-classes

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations
@Override
isProcessingInstructionback to summary
public boolean isProcessingInstruction()

Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.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.

Returns:boolean

true if the event is ProcessingInstruction, false otherwise

Annotations
@Override
writeAsEncodedUnicodeback to summary
public void writeAsEncodedUnicode(Writer w) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeAsEncodedUnicode.

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

Doc from 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
w:Writer

The writer that will output the data

Annotations
@Override
Exceptions
XMLStreamException:
if there is a fatal error writing the event
writeUsingback to summary
public void writeUsing(XMLStreamWriter2 w) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeUsing.

Implements org.codehaus.stax2.evt.XMLEvent2.writeUsing.

Annotations
@Override