public interface FastInfosetReader extends XMLReader, FastInfosetParser
FastInfosetReader is the interface that a Fast Infoset parser's SAX2 driver must implement. This interface allows an application to to register Fast Infoset specific event handlers for encoding algorithms.
The reception of encoding algorithm events is determined by the registration of:
PrimitiveTypeContentHandler
, for the recieving of events,
associated with built-in encoding algorithms, for decoded data that
can be reported as Java primitive types.EncodingAlgorithmContentHandler
, for the recieving of events,
associated with built-in and application-defined encoding algorithms, for
decoded data that can be reported as an array of octets or as a Java
Object.EncodingAlgorithm
implementations, for
the receiving of events, associated with application defined algorithms.
for decoded data that shall be reported as a Java Object by way of the
registered EncodingAlgorithmContentHandler.The reporting of element content events for built-in algorithms is determimed by the following:
EncodingAlgorithmContentHandler.object(String, int, Object)
.
An Object shall correspond to the Java primitive type that
would otherwise be reported using the PrimitiveContentHandler.The reporting of element content events for application-defined algorithms is determimed by the following:
EncodingAlgorithmContentHandler.octets(String, int, byte[], int, int)
;
otherwiseEncodingAlgorithmContentHandler.object(String, int, Object)
.The reporting of attribute values for encoding algorithms is achieved using
EncodingAlgorithmAttributes
that extends Attributes
.
The registered ContentHandler may cast the attr paramter of the
ContentHandler.startElement(String, String, String, org.xml.sax.Attributes)
to the EncodingAlgorithmAttributes interface to access to encoding algorithm information.
The reporting of attribute values for built-in algorithms is determimed by the following:
EncodingAlgorithmAttributes.getAlgorithmData(int)
.
The reporting of attribute values for application-defined algorithms is determimed by the following:
byte[]
,
using EncodingAlgorithmAttributes.getAlgorithmData(int)
;
otherwiseEncodingAlgorithmAttributes.getAlgorithmData(int)
.Modifier and Type | Field and Description |
---|---|
static String |
ENCODING_ALGORITHM_CONTENT_HANDLER_PROPERTY
The property name to be used for getting and setting the
EncodingAlgorithmContentHandler.
|
static String |
PRIMITIVE_TYPE_CONTENT_HANDLER_PROPERTY
The property name to be used for getting and setting the
PrimtiveTypeContentHandler.
|
BUFFER_SIZE_PROPERTY, EXTERNAL_VOCABULARIES_PROPERTY, FORCE_STREAM_CLOSE_PROPERTY, REGISTERED_ENCODING_ALGORITHMS_PROPERTY, STRING_INTERNING_PROPERTY
Modifier and Type | Method and Description |
---|---|
DeclHandler |
getDeclHandler()
Return the current DTD declaration handler.
|
EncodingAlgorithmContentHandler |
getEncodingAlgorithmContentHandler()
Return the current encoding algorithm handler.
|
LexicalHandler |
getLexicalHandler()
Return the current lexical handler.
|
PrimitiveTypeContentHandler |
getPrimitiveTypeContentHandler()
Return the current primitive type handler.
|
void |
parse(InputStream s)
Parse a fast infoset document from an InputStream.
|
void |
setDeclHandler(DeclHandler handler)
Allow an application to register a DTD declaration handler.
|
void |
setEncodingAlgorithmContentHandler(EncodingAlgorithmContentHandler handler)
Allow an application to register an encoding algorithm handler.
|
void |
setLexicalHandler(LexicalHandler handler)
Allow an application to register a lexical handler.
|
void |
setPrimitiveTypeContentHandler(PrimitiveTypeContentHandler handler)
Allow an application to register a primitive type handler.
|
getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getProperty, parse, parse, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setProperty
getBufferSize, getExternalVocabularies, getForceStreamClose, getParseFragments, getRegisteredEncodingAlgorithms, getStringInterning, setBufferSize, setExternalVocabularies, setForceStreamClose, setParseFragments, setRegisteredEncodingAlgorithms, setStringInterning
static final String ENCODING_ALGORITHM_CONTENT_HANDLER_PROPERTY
static final String PRIMITIVE_TYPE_CONTENT_HANDLER_PROPERTY
void parse(InputStream s) throws IOException, FastInfosetException, SAXException
The application can use this method to instruct the Fast Infoset reader to begin parsing a fast infoset document from a byte stream.
Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same FastInfosetReader object, possibly with a different byte stream.
During the parse, the FastInfosetReader will provide information about the fast infoset document through the registered event handlers.
This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.
s
- The byte stream to parse from.IOException
FastInfosetException
SAXException
void setLexicalHandler(LexicalHandler handler)
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
handler
- The lexical handler.getLexicalHandler()
LexicalHandler getLexicalHandler()
setLexicalHandler(org.xml.sax.ext.LexicalHandler)
void setDeclHandler(DeclHandler handler)
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
handler
- The DTD declaration handler.getLexicalHandler()
DeclHandler getDeclHandler()
setLexicalHandler(org.xml.sax.ext.LexicalHandler)
void setEncodingAlgorithmContentHandler(EncodingAlgorithmContentHandler handler)
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
handler
- The encoding algorithm handler.getEncodingAlgorithmContentHandler()
EncodingAlgorithmContentHandler getEncodingAlgorithmContentHandler()
setEncodingAlgorithmContentHandler(org.jvnet.fastinfoset.sax.EncodingAlgorithmContentHandler)
void setPrimitiveTypeContentHandler(PrimitiveTypeContentHandler handler)
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
handler
- The primitive type handler.getPrimitiveTypeContentHandler()
PrimitiveTypeContentHandler getPrimitiveTypeContentHandler()
setPrimitiveTypeContentHandler(org.jvnet.fastinfoset.sax.PrimitiveTypeContentHandler)
Copyright © 2015 Oracle Corpration. All rights reserved.