Top Description Methods
org.jvnet.fastinfoset.sax

public Interface EncodingAlgorithmContentHandler

Known Direct Subinterfaces
org.jvnet.fastinfoset.sax.FastInfosetWriter
Known Direct Implementers
org.jvnet.fastinfoset.sax.helpers.FastInfosetDefaultHandler
Imports
org.xml.sax.SAXException

SAX2 extention handler to receive notification of encoding algorithm data.

This is an optional extension handler for SAX2. XML readers are not required to recognize this handler, and it is not part of core-only SAX2 distributions.

This interface may be used with with a Fast Infoset SAX parser to receive notification of encoding algorithm data specified in ITU-T Rec. X.891 | ISO/IEC 24824-1 (Fast Infoset) clause 10 and for application defined encoding algorithms specified as part of the initial vocabulary of a fast infoset document.

To set the EncodingAlgorithmContentHandler for an XML reader, use the setProperty method with the property name URI TO BE DEFINED and an object implementing this interface (or null) as the value. If the reader does not report primitive data types, it will throw a SAXNotRecognizedException

To set the EncodingAlgorithmContentHandler for an Fast Infoset reader, use setEncodingAlgorithmContentHandler method.

See Also
org.jvnet.fastinfoset.sax.PrimitiveTypeContentHandler, org.jvnet.fastinfoset.sax.FastInfosetReader, org.xml.sax.XMLReader

Method Summary

Modifier and TypeMethod and Description
public void
object(String
the URI of the encoding algorithm
URI
,
int
the encoding algorithm index
algorithm
,
Object
the encoding algorithm object
o
)

Receive notification of encoding algorithm data as an object.

public void
octets(String
the URI of the encoding algorithm
URI
,
int
the encoding algorithm index
algorithm
,
byte[]
the array of byte
b
,
int
the start position in the array
start
,
int
the number of byte to read from the array
length
)

Receive notification of encoding algorithm data as an array of byte.

Method Detail

objectback to summary
public void object(String URI, int algorithm, Object o) throws SAXException

Receive notification of encoding algorithm data as an object.

Such notifications will occur for a Fast Infoset SAX parser when processing encoding algorithm data that is converted from an array of byte to an object more suitable for processing.

Parameters
URI:String

the URI of the encoding algorithm

algorithm:int

the encoding algorithm index

o:Object

the encoding algorithm object

Exceptions
SAXException:
any SAX exception, possibly wrapping another exception
See Also
org.jvnet.fastinfoset.EncodingAlgorithmIndexes
octetsback to summary
public void octets(String URI, int algorithm, byte[] b, int start, int length) throws SAXException

Receive notification of encoding algorithm data as an array of byte.

The application must not attempt to read from the array outside of the specified range.

Such notifications will occur for a Fast Infoset SAX parser when processing encoding algorithm data.

The Parser will call the method of this interface to report each encoding algorithm data. Parsers MUST return all contiguous characters in a single chunk

Parsers may return all contiguous bytes in a single chunk, or they may split it into several chunks providing that the length of each chunk is of the required length to successfully apply the encoding algorithm to the chunk.

Parameters
URI:String

the URI of the encoding algorithm

algorithm:int

the encoding algorithm index

b:byte[]

the array of byte

start:int

the start position in the array

length:int

the number of byte to read from the array

Exceptions
SAXException:
any SAX exception, possibly wrapping another exception
See Also
org.jvnet.fastinfoset.EncodingAlgorithmIndexes