javolution.xml.stream

Interface XMLInputFactory

All Superinterfaces:

Cloneable

@Parallelizable(comment="Factory configuration should be performed sequentially.")
public interface XMLInputFactory
extends Cloneable

The OSGi factory service to create XMLStreamReader instances. For each bundle, a distinct factory instance is returned and can be individually configured (if not enough the factory can be cloned).

 import javolution.xml.stream.*;
 public class Activator implements BundleActivator { 
     public void start(BundleContext bc) throws Exception {
     
         // Configures factory. 
         ServiceTracker<XMLInputFactory, XMLInputFactory> tracker 
             = new ServiceTracker<>(bc, XMLInputFactory.class, null);
         tracker.open();
         tracker.getService().setProperty(IS_COALESCING, true);
         
         // Instantiates a reader.
         String xml = "<test>This is a test</test>";
         CharSequenceReader in = new CharSequenceReader().setInput(xml);
         XMLStreamReader reader = tracker.getService().createXMLStreamReader(in);
     
         // Parses XML.
         while (reader.hasNext()) {
              int eventType = reader.next();
              if (eventType == XMLStreamConstants.CHARACTERS) {
                  System.out.println(reader.getText());
              }
         }
         
         // Closes the reader which may be recycled back to the factory.
         reader.close();
     }
 }

Version:

6.0 December 12, 2012

Author:

Jean-Marie Dautelle

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITIES Property used to specify additional entities to be recognized by the readers (type: java.util.Map, default: null).
static String	IS_COALESCING The property that requires the parser to coalesce adjacent character data sections.
static String	IS_VALIDATING The property that requires the parser to validate the input data.

Method Summary

Methods

Modifier and Type	Method and Description
XMLInputFactory	clone() Returns a clone of this factory which can be independently configured.
XMLStreamReader	createXMLStreamReader(InputStream stream) Returns a XML stream reader for the specified input stream (encoding autodetected).
XMLStreamReader	createXMLStreamReader(InputStream stream, String encoding) Returns a XML stream reader for the specified input stream using the specified encoding.
XMLStreamReader	createXMLStreamReader(Reader reader) Returns a XML stream reader for the specified I/O reader.
Object	getProperty(String name) Gets the value of a feature/property from the underlying implementation.
boolean	isPropertySupported(String name) Queries the set of properties that this factory supports.
void	setProperty(String name, Object value) Allows the user to set specific feature/property on the underlying implementation.

Field Detail

IS_COALESCING

static final String IS_COALESCING

The property that requires the parser to coalesce adjacent character data sections.

See Also:

Constant Field Values

IS_VALIDATING

static final String IS_VALIDATING

The property that requires the parser to validate the input data.

See Also:

Constant Field Values

ENTITIES

static final String ENTITIES

Property used to specify additional entities to be recognized by the readers (type: java.util.Map, default: null). For example:

     FastMap<String, String> HTML_ENTITIES = new FastMap<String, String>();
     HTML_ENTITIES.put("nbsp", " ");
     HTML_ENTITIES.put("copy", "©");
     HTML_ENTITIES.put("eacute", "é");
     ...
     XMLInputFactory factory = factoryRef.getService();
     factory.setProperty(ENTITIES, HTML_ENTITIES);
 

See Also:

Constant Field Values

Method Detail

createXMLStreamReader

XMLStreamReader createXMLStreamReader(Reader reader)
                                      throws XMLStreamException

Returns a XML stream reader for the specified I/O reader.

Parameters:

reader - the XML data to read from.

Throws:

XMLStreamException

createXMLStreamReader

XMLStreamReader createXMLStreamReader(InputStream stream)
                                      throws XMLStreamException

Returns a XML stream reader for the specified input stream (encoding autodetected).

Parameters:

stream - the input stream to read from.

Returns:

a xml stream reader possibly recycled.

Throws:

XMLStreamException

createXMLStreamReader

XMLStreamReader createXMLStreamReader(InputStream stream,
                                    String encoding)
                                      throws XMLStreamException

Returns a XML stream reader for the specified input stream using the specified encoding.

Parameters:

stream - the input stream to read from.

encoding - the character encoding of the stream.

Returns:

a xml stream reader possibly recycled.

Throws:

XMLStreamException

setProperty

void setProperty(String name,
               Object value)
                 throws IllegalArgumentException

Allows the user to set specific feature/property on the underlying implementation. The underlying implementation is not required to support every setting of every property in the specification and may use IllegalArgumentException to signal that an unsupported property may not be set with the specified value.

Parameters:

name - the name of the property.

value - the value of the property

Throws:

IllegalArgumentException - if the property is not supported.

getProperty

Object getProperty(String name)
                   throws IllegalArgumentException

Gets the value of a feature/property from the underlying implementation.

Parameters:

name - the name of the property (may not be null).

Returns:

the value of the property.

Throws:

IllegalArgumentException - if the property is not supported.

isPropertySupported

boolean isPropertySupported(String name)

Queries the set of properties that this factory supports.

Parameters:

name - the name of the property.

Returns:

true if the property is supported; false otherwise.

clone

XMLInputFactory clone()

Returns a clone of this factory which can be independently configured.