JAXB OSGI 4.0.9 · org.jvnet.fastinfoset.sax.FastInfosetReader

Interface for reading an Fast Infoset document using callbacks.

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:

A PrimitiveTypeContentHandler, for the recieving of events, associated with built-in encoding algorithms, for decoded data that can be reported as Java primitive types.
A 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.
org.jvnet.fastinfoset.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:

If a PrimitiveContentHandler is registered then decoded data is reported as Java primitive types using the corresponding methods on the PrimitiveContentHandler interface.
If a PrimitiveContentHandler is not registered and a EncodingAlgorithmContentHandler is registered then decoded data is reported as Java Objects using EncodingAlgorithmContentHandler#object(String, int, Object). An Object shall correspond to the Java primitive type that would otherwise be reported using the PrimitiveContentHandler.
If neither is registered then then decoded data is reported as characters.

The reporting of element content events for application-defined algorithms is determimed by the following:

If an EncodingAlgorithmContentHandler is registered and there is no EncodingAlgorithm registered for an application-defined encoding algorithm then decoded data for such an algoroithm is reported as an array of octets using EncodingAlgorithmContentHandler#octets(String, int, byte[], int, int); otherwise
If there is an EncodingAlgorithm registered for the application-defined encoding algorithm then the decoded data is reported as a Java Object, returned by decoding according to the EncodingAlgorithm, using EncodingAlgorithmContentHandler#object(String, int, Object).

The reporting of attribute values for encoding algorithms is achieved using EncodingAlgorithmAttributes that extends org.xml.sax.Attributes. The registered ContentHandler may cast the attr paramter of the org.xml.sax.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:

If a PrimitiveContentHandler or EncodingAlgorithmContentHandler is registered then decoded data is reported as Java Objects corresponding to the Java primitive types. The Java Objects may be obtained using EncodingAlgorithmAttributes#getAlgorithmData(int).
If neither is registered then then decoded data is reported as characters.

The reporting of attribute values for application-defined algorithms is determimed by the following:

If an EncodingAlgorithmContentHandler is registered and there is no EncodingAlgorithm registered for an application-defined encoding algorithm then decoded data for such an algoroithm is reported as Java Object, that is an instance of byte[], using EncodingAlgorithmAttributes#getAlgorithmData(int); otherwise
If there is an EncodingAlgorithm registered for the application-defined encoding algorithm then the decoded data is reported as a Java Object, returned by decoding according to the EncodingAlgorithm, using EncodingAlgorithmAttributes#getAlgorithmData(int).

Field Summary

Modifier and Type	Field and Description
public static final String	ENCODING_ALGORITHM_CONTENT_HANDLER_PROPERTY The property name to be used for getting and setting the EncodingAlgorithmContentHandler.
public static final String	PRIMITIVE_TYPE_CONTENT_HANDLER_PROPERTY The property name to be used for getting and setting the PrimtiveTypeContentHandler.

Inherited from org.jvnet.fastinfoset.FastInfosetParser:: BUFFER_SIZE_PROPERTY EXTERNAL_VOCABULARIES_PROPERTY FORCE_STREAM_CLOSE_PROPERTY REGISTERED_ENCODING_ALGORITHMS_PROPERTY STRING_INTERNING_PROPERTY

Method Summary

Modifier and Type	Method and Description
public DeclHandler	Returns: The current DTD declaration handler, or null if none has been registered. getDeclHandler() Return the current DTD declaration handler.
public EncodingAlgorithmContentHandler	Returns: The current encoding algorithm handler, or null if none has been registered. getEncodingAlgorithmContentHandler() Return the current encoding algorithm handler.
public LexicalHandler	Returns: The current lexical handler, or null if none has been registered. getLexicalHandler() Return the current lexical handler.
public PrimitiveTypeContentHandler	Returns: The current primitive type handler, or null if none has been registered. getPrimitiveTypeContentHandler() Return the current primitive type handler.
public void	parse(InputStream The byte stream to parse from. s) Parse a fast infoset document from an InputStream.
public void	setDeclHandler(DeclHandler The DTD declaration handler. handler) Allow an application to register a DTD declaration handler.
public void	setEncodingAlgorithmContentHandler(EncodingAlgorithmContentHandler The encoding algorithm handler. handler) Allow an application to register an encoding algorithm handler.
public void	setLexicalHandler(LexicalHandler The lexical handler. handler) Allow an application to register a lexical handler.
public void	setPrimitiveTypeContentHandler(PrimitiveTypeContentHandler The primitive type handler. handler) Allow an application to register a primitive type handler.

Field Detail

ENCODING_ALGORITHM_CONTENT_HANDLER_PROPERTY	back to summary
public static final String ENCODING_ALGORITHM_CONTENT_HANDLER_PROPERTY The property name to be used for getting and setting the EncodingAlgorithmContentHandler.

PRIMITIVE_TYPE_CONTENT_HANDLER_PROPERTY	back to summary
public static final String PRIMITIVE_TYPE_CONTENT_HANDLER_PROPERTY The property name to be used for getting and setting the PrimtiveTypeContentHandler.

Method Detail

getDeclHandler back to summary

getDeclHandler	back to summary
public DeclHandler getDeclHandler() Return the current DTD declaration handler. Returns:DeclHandler The current DTD declaration handler, or null if none has been registered. See Also `setLexicalHandler`

public DeclHandler getDeclHandler()

Return the current DTD declaration handler.

Returns:DeclHandler: The current DTD declaration handler, or null if none has been registered.
See Also: setLexicalHandler

getEncodingAlgorithmContentHandler back to summary

getEncodingAlgorithmContentHandler	back to summary
public EncodingAlgorithmContentHandler getEncodingAlgorithmContentHandler() Return the current encoding algorithm handler. Returns:EncodingAlgorithmContentHandler The current encoding algorithm handler, or null if none has been registered. See Also `setEncodingAlgorithmContentHandler`

public EncodingAlgorithmContentHandler getEncodingAlgorithmContentHandler()

Return the current encoding algorithm handler.

Returns:EncodingAlgorithmContentHandler: The current encoding algorithm handler, or null if none has been registered.
See Also: setEncodingAlgorithmContentHandler

getLexicalHandler back to summary

getLexicalHandler	back to summary
public LexicalHandler getLexicalHandler() Return the current lexical handler. Returns:LexicalHandler The current lexical handler, or null if none has been registered. See Also `setLexicalHandler`

public LexicalHandler getLexicalHandler()

Return the current lexical handler.

Returns:LexicalHandler: The current lexical handler, or null if none has been registered.
See Also: setLexicalHandler

getPrimitiveTypeContentHandler back to summary

getPrimitiveTypeContentHandler	back to summary
public PrimitiveTypeContentHandler getPrimitiveTypeContentHandler() Return the current primitive type handler. Returns:PrimitiveTypeContentHandler The current primitive type handler, or null if none has been registered. See Also `setPrimitiveTypeContentHandler`

public PrimitiveTypeContentHandler getPrimitiveTypeContentHandler()

Return the current primitive type handler.

Returns:PrimitiveTypeContentHandler: The current primitive type handler, or null if none has been registered.
See Also: setPrimitiveTypeContentHandler

parse	back to summary
public void parse(InputStream s) throws IOException, FastInfosetException, SAXException Parse a fast infoset document from an InputStream. 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. Parameters s:InputStream The byte stream to parse from.

parse

back to summary

public void parse(InputStream s) throws IOException, FastInfosetException, SAXException

Parse a fast infoset document from an InputStream.

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.

Parameters

s:InputStream: The byte stream to parse from.

setDeclHandler back to summary

setDeclHandler	back to summary
public void setDeclHandler(DeclHandler handler) Allow an application to register a DTD declaration 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. Parameters handler:DeclHandler The DTD declaration handler. See Also `getLexicalHandler`

public void setDeclHandler(DeclHandler handler)

Allow an application to register a DTD declaration 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.

Parameters

handler:DeclHandler: The DTD declaration handler.

See Also

getLexicalHandler

setEncodingAlgorithmContentHandler back to summary

setEncodingAlgorithmContentHandler	back to summary
public void setEncodingAlgorithmContentHandler(EncodingAlgorithmContentHandler handler) Allow an application to register an encoding algorithm 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. Parameters handler:EncodingAlgorithmContentHandler The encoding algorithm handler. See Also `getEncodingAlgorithmContentHandler`

public void setEncodingAlgorithmContentHandler(EncodingAlgorithmContentHandler handler)

Allow an application to register an encoding algorithm 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.

Parameters

handler:EncodingAlgorithmContentHandler: The encoding algorithm handler.

See Also

getEncodingAlgorithmContentHandler

setLexicalHandler back to summary

setLexicalHandler	back to summary
public void setLexicalHandler(LexicalHandler handler) Allow an application to register a lexical 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. Parameters handler:LexicalHandler The lexical handler. See Also `getLexicalHandler`

public void setLexicalHandler(LexicalHandler handler)

Allow an application to register a lexical 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.

Parameters

handler:LexicalHandler: The lexical handler.

See Also

getLexicalHandler

setPrimitiveTypeContentHandler back to summary

setPrimitiveTypeContentHandler	back to summary
public void setPrimitiveTypeContentHandler(PrimitiveTypeContentHandler handler) Allow an application to register a primitive type 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. Parameters handler:PrimitiveTypeContentHandler The primitive type handler. See Also `getPrimitiveTypeContentHandler`

public void setPrimitiveTypeContentHandler(PrimitiveTypeContentHandler handler)

Allow an application to register a primitive type 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.

Parameters

handler:PrimitiveTypeContentHandler: The primitive type handler.

See Also

getPrimitiveTypeContentHandler

public Interface FastInfosetReader

Field Summary

Method Summary

Field Detail

Method Detail