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

public Class NotationDeclarationEventImpl

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

Field Summary

Modifier and TypeField and Description
pack-priv final String
mName

Name/id of the notation, used to reference declaration.

pack-priv final String
mPublicId

pack-priv final String
mSystemId

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

Constructor Summary

AccessConstructor and Description
public
NotationDeclarationEventImpl(Location loc, String name, String pubId, String sysId)

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
getBaseURI()

Implements org.codehaus.stax2.evt.NotationDeclaration2.getBaseURI.

Empty base implementation: sub-classes should implement
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
getName()

Implements javax.xml.stream.events.NotationDeclaration.getName.

The notation name.
public String
getPublicId()

Implements javax.xml.stream.events.NotationDeclaration.getPublicId.

The notation's public identifier, or null if none was given.
public String
getSystemId()

Implements javax.xml.stream.events.NotationDeclaration.getSystemId.

The notation's system identifier, or null if none was given.
public int
hashCode()

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

Declared abstract to force redefinition by sub-classes
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.

This method does not make much sense for this event type -- the reason being that the notation declarations can only be written as part of a DTD (internal or external subset), not separately.
Inherited from org.codehaus.stax2.ri.evt.BaseEventImpl:
addHashasCharactersasEndElementasStartElementgetLocationgetSchemaTypeisAttributeisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisProcessingInstructionisStartDocumentisStartElementiteratedEqualsstringsWithNullsEqualthrowFromIOEtoString

Field Detail

mNameback to summary
pack-priv final String mName

Name/id of the notation, used to reference declaration.

mPublicIdback to summary
pack-priv final String mPublicId
mSystemIdback to summary
pack-priv final String mSystemId

Constructor Detail

NotationDeclarationEventImplback to summary
public NotationDeclarationEventImpl(Location loc, String name, String pubId, String sysId)

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
getBaseURIback to summary
public String getBaseURI()

Implements org.codehaus.stax2.evt.NotationDeclaration2.getBaseURI.

Empty base implementation: sub-classes should implement

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
getNameback to summary
public String getName()

Implements javax.xml.stream.events.NotationDeclaration.getName.

Doc from javax.xml.stream.events.NotationDeclaration.getName.

The notation name.

Returns:String

the notation name

Annotations
@Override
getPublicIdback to summary
public String getPublicId()

Implements javax.xml.stream.events.NotationDeclaration.getPublicId.

Doc from javax.xml.stream.events.NotationDeclaration.getPublicId.

The notation's public identifier, or null if none was given.

Returns:String

the public identifier

Annotations
@Override
getSystemIdback to summary
public String getSystemId()

Implements javax.xml.stream.events.NotationDeclaration.getSystemId.

Doc from javax.xml.stream.events.NotationDeclaration.getSystemId.

The notation's system identifier, or null if none was given.

Returns:String

the system identifier

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
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.

This method does not make much sense for this event type -- the reason being that the notation declarations can only be written as part of a DTD (internal or external subset), not separately. Can basically choose to either skip silently (output nothing), or throw an exception.

Annotations
@Override