org.jvnet.fastinfoset.sax.PrimitiveTypeContentHandler Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004, 2022 Oracle and/or its affiliates. All rights reserved.
*
* Oracle licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jvnet.fastinfoset.sax;
import org.xml.sax.SAXException;
/**
* SAX2 extention handler to receive notification of character data as
* primtive types.
*
* 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 data encoded using the
* following built-in encoding algorithms specified in ITU-T Rec. X.891 | ISO/IEC 24824-1
* (Fast Infoset), clause 10: "boolean", "base64", "short", "int", "long",
* "float", "double" and "uuid" encoding algorithms.
*
* To set the PrimitiveTypeContentHandler for an XML reader, use the
* {@link org.xml.sax.XMLReader#setProperty 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
* {@link org.xml.sax.SAXNotRecognizedException SAXNotRecognizedException}
*
* To set the PrimitiveTypeContentHandler for an Fast Infoset reader, use
* {@link org.jvnet.fastinfoset.sax.FastInfosetReader#setPrimitiveTypeContentHandler
* setPrimitiveTypeContentHandler} method.
* The Parser will call methods of this interface to report each
* chunk of character data that has been converted to an array of primitive
* types, for example an array of integer or an array of float. Parsers may
* return all contiguous primtive types in a single chunk, or they may split
* it into several chunks
*
* The application must not attempt to read from the array
* outside of the specified range.
*
* @see org.jvnet.fastinfoset.sax.EncodingAlgorithmContentHandler
* @see org.jvnet.fastinfoset.sax.FastInfosetReader
* @see org.xml.sax.XMLReader
*/
public interface PrimitiveTypeContentHandler {
/**
* Receive notification of character data as an array of boolean.
*
* 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 data encoded using the "boolean" encoding
* algorithm, see subclause 10.7
.
*
* @param b the array of boolean
* @param start the start position in the array
* @param length the number of boolean to read from the array
* @throws org.xml.sax.SAXException any SAX exception, possibly
* wrapping another exception
*/
public void booleans(boolean [] b, int start, int length) throws SAXException;
/**
* Receive notification of character 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 data encoded using the "base64" encoding
* algorithm, see subclause 10.3, or the "hexadecimal" encoding
* algorithm, see subclause 10.2.
*
*
Such a notification may occur for binary data that would
* normally require base 64 encoding and reported as character data
* using the {@link org.xml.sax.ContentHandler#characters characters}
* method
.
*
* @param b the array of byte
* @param start the start position in the array
* @param length the number of byte to read from the array
* @throws org.xml.sax.SAXException any SAX exception, possibly
* wrapping another exception
*/
public void bytes(byte[] b, int start, int length) throws SAXException;
/**
* Receive notification of character data as an array of short.
*
*
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 data encoded using the "short" encoding
* algorithm, see subclause 10.4
.
*
* @param s the array of short
* @param start the start position in the array
* @param length the number of short to read from the array
* @throws org.xml.sax.SAXException any SAX exception, possibly
* wrapping another exception
*/
public void shorts(short[] s, int start, int length) throws SAXException;
/**
* Receive notification of character data as an array of int.
*
*
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 data encoded using the "int" encoding
* algorithm, see subclause 10.5
.
*
* @param i the array of int
* @param start the start position in the array
* @param length the number of int to read from the array
* @throws org.xml.sax.SAXException any SAX exception, possibly
* wrapping another exception
*/
public void ints(int [] i, int start, int length) throws SAXException;
/**
* Receive notification of character data as an array of long.
*
*
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 data encoded using the "long" encoding
* algorithm, see subclause 10.6
.
*
* @param l the array of long
* @param start the start position in the array
* @param length the number of long to read from the array
* @throws org.xml.sax.SAXException any SAX exception, possibly
* wrapping another exception
*/
public void longs(long [] l, int start, int length) throws SAXException;
/**
* Receive notification of character data as an array of float.
*
*
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 data encoded using the "float" encoding
* algorithm, see subclause 10.8
.
*
* @param f the array of float
* @param start the start position in the array
* @param length the number of float to read from the array
* @throws org.xml.sax.SAXException any SAX exception, possibly
* wrapping another exception
*/
public void floats(float [] f, int start, int length) throws SAXException;
/**
* Receive notification of character data as an array of double.
*
*
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 data encoded using the "double" encoding
* algorithm, see subclause 10.9
.
*
* @param d the array of double
* @param start the start position in the array
* @param length the number of double to read from the array
* @throws org.xml.sax.SAXException any SAX exception, possibly
* wrapping another exception
*/
public void doubles(double [] d, int start, int length) throws SAXException;
/**
* Receive notification of character data as an two array of UUID.
*
*
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 data encoded using the "uuid" encoding
* algorithm, see subclause 10.10
.
*
* @param msblsb the array of long containing pairs of most signficant
* bits and least significant bits of the UUIDs
* @param start the start position in the array
* @param length the number of long to read from the array. This will
* be twice the number of UUIDs, which are pairs of two long values
* @throws org.xml.sax.SAXException any SAX exception, possibly
* wrapping another exception
*/
public void uuids(long[] msblsb, int start, int length) throws SAXException;
}