Save This Page
Home » openjdk-7 » javax » xml » stream » [javadoc | source]
javax.xml.stream
abstract public class: XMLInputFactory [javadoc | source]
java.lang.Object
   javax.xml.stream.XMLInputFactory
Defines an abstract implementation of a factory for getting streams. The following table defines the standard properties of this specification. Each property varies in the level of support required by each implementation. The level of support required is described in the 'Required' column.
Configuration parameters
Property Name Behavior Return type Default Value Required
javax.xml.stream.isValidatingTurns on/off implementation specific DTD validationBooleanFalseNo
javax.xml.stream.isNamespaceAwareTurns on/off namespace processing for XML 1.0 supportBooleanTrueTrue (required) / False (optional)
javax.xml.stream.isCoalescingRequires the processor to coalesce adjacent character dataBooleanFalseYes
javax.xml.stream.isReplacingEntityReferencesreplace internal entity references with their replacement text and report them as charactersBooleanTrueYes
javax.xml.stream.isSupportingExternalEntitiesResolve external parsed entitiesBooleanUnspecifiedYes
javax.xml.stream.supportDTDUse this property to request processors that do not support DTDsBooleanTrueYes
javax.xml.stream.reportersets/gets the impl of the XMLReporter javax.xml.stream.XMLReporterNullYes
javax.xml.stream.resolversets/gets the impl of the XMLResolver interfacejavax.xml.stream.XMLResolverNullYes
javax.xml.stream.allocatorsets/gets the impl of the XMLEventAllocator interfacejavax.xml.stream.util.XMLEventAllocatorNullYes
Field Summary
public static final  String IS_NAMESPACE_AWARE    The property used to turn on/off namespace support, this is to support XML 1.0 documents, only the true setting must be supported 
public static final  String IS_VALIDATING    The property used to turn on/off implementation specific validation 
public static final  String IS_COALESCING    The property that requires the parser to coalesce adjacent character data sections 
public static final  String IS_REPLACING_ENTITY_REFERENCES    Requires the parser to replace internal entity references with their replacement text and report them as characters 
public static final  String IS_SUPPORTING_EXTERNAL_ENTITIES    The property that requires the parser to resolve external parsed entities 
public static final  String SUPPORT_DTD    The property that requires the parser to support DTDs 
public static final  String REPORTER    The property used to set/get the implementation of the XMLReporter interface 
public static final  String RESOLVER    The property used to set/get the implementation of the XMLResolver 
public static final  String ALLOCATOR    The property used to set/get the implementation of the allocator 
Constructor:
 protected XMLInputFactory() 
Method from javax.xml.stream.XMLInputFactory Summary:
createFilteredReader,   createFilteredReader,   createXMLEventReader,   createXMLEventReader,   createXMLEventReader,   createXMLEventReader,   createXMLEventReader,   createXMLEventReader,   createXMLEventReader,   createXMLStreamReader,   createXMLStreamReader,   createXMLStreamReader,   createXMLStreamReader,   createXMLStreamReader,   createXMLStreamReader,   getEventAllocator,   getProperty,   getXMLReporter,   getXMLResolver,   isPropertySupported,   newInstance,   newInstance,   setEventAllocator,   setProperty,   setXMLReporter,   setXMLResolver
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.stream.XMLInputFactory Detail:
 abstract public XMLStreamReader createFilteredReader(XMLStreamReader reader,
    StreamFilter filter) throws XMLStreamException
    Create a filtered reader that wraps the filter around the reader
 abstract public XMLEventReader createFilteredReader(XMLEventReader reader,
    EventFilter filter) throws XMLStreamException
    Create a filtered event reader that wraps the filter around the event reader
 abstract public XMLEventReader createXMLEventReader(Reader reader) throws XMLStreamException
    Create a new XMLEventReader from a reader
 abstract public XMLEventReader createXMLEventReader(XMLStreamReader reader) throws XMLStreamException
    Create a new XMLEventReader from an XMLStreamReader. After being used to construct the XMLEventReader instance returned from this method the XMLStreamReader must not be used.
 abstract public XMLEventReader createXMLEventReader(Source source) throws XMLStreamException
    Create a new XMLEventReader from a JAXP source. Support of this method is optional.
 abstract public XMLEventReader createXMLEventReader(InputStream stream) throws XMLStreamException
    Create a new XMLEventReader from a java.io.InputStream
 abstract public XMLEventReader createXMLEventReader(String systemId,
    Reader reader) throws XMLStreamException
    Create a new XMLEventReader from a reader
 abstract public XMLEventReader createXMLEventReader(InputStream stream,
    String encoding) throws XMLStreamException
    Create a new XMLEventReader from a java.io.InputStream
 abstract public XMLEventReader createXMLEventReader(String systemId,
    InputStream stream) throws XMLStreamException
    Create a new XMLEventReader from a java.io.InputStream
 abstract public XMLStreamReader createXMLStreamReader(Reader reader) throws XMLStreamException
    Create a new XMLStreamReader from a reader
 abstract public XMLStreamReader createXMLStreamReader(Source source) throws XMLStreamException
    Create a new XMLStreamReader from a JAXP source. This method is optional.
 abstract public XMLStreamReader createXMLStreamReader(InputStream stream) throws XMLStreamException
    Create a new XMLStreamReader from a java.io.InputStream
 abstract public XMLStreamReader createXMLStreamReader(InputStream stream,
    String encoding) throws XMLStreamException
    Create a new XMLStreamReader from a java.io.InputStream
 abstract public XMLStreamReader createXMLStreamReader(String systemId,
    InputStream stream) throws XMLStreamException
    Create a new XMLStreamReader from a java.io.InputStream
 abstract public XMLStreamReader createXMLStreamReader(String systemId,
    Reader reader) throws XMLStreamException
    Create a new XMLStreamReader from a java.io.InputStream
 abstract public XMLEventAllocator getEventAllocator()
    Gets the allocator used by streams created with this factory
 abstract public Object getProperty(String name) throws IllegalArgumentException
    Get the value of a feature/property from the underlying implementation
 abstract public XMLReporter getXMLReporter()
    The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
 abstract public XMLResolver getXMLResolver()
    The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
 abstract public boolean isPropertySupported(String name)
    Query the set of properties that this factory supports.
 public static XMLInputFactory newInstance() throws FactoryConfigurationError 
    Create a new instance of the factory. This static method creates a new factory instance. This method uses the following ordered lookup procedure to determine the XMLInputFactory implementation class to load: Use the javax.xml.stream.XMLInputFactory system property. Use the properties file "lib/stax.properties" in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above. Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.stream.XMLInputFactory in jars available to the runtime. Platform default XMLInputFactory instance. Once an application has obtained a reference to a XMLInputFactory it can use the factory to configure and obtain stream instances.
 public static XMLInputFactory newInstance(String factoryId,
    ClassLoader classLoader) throws FactoryConfigurationError 
    Create a new instance of the factory
 abstract public  void setEventAllocator(XMLEventAllocator allocator)
    Set a user defined event allocator for events
 abstract public  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.
 abstract public  void setXMLReporter(XMLReporter reporter)
    The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
 abstract public  void setXMLResolver(XMLResolver resolver)
    The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.