Movatterモバイル変換

public abstract classXMLInputFactoryextendsObject

Since:

1.6

Version:

1.2

See Also:

XMLOutputFactory,XMLEventReader,XMLStreamReader,EventFilter,XMLReporter,XMLResolver,XMLEventAllocator

• Field Summary

  Fields 

  Modifier and Type	Field	Description
  staticString	ALLOCATOR	The property used to set/get the implementation of the allocator
  staticString	IS_COALESCING	The property that requires the parser to coalesce adjacent character data sections
  staticString	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
  staticString	IS_REPLACING_ENTITY_REFERENCES	Requires the parser to replace internal entity references with their replacement text and report them as characters
  staticString	IS_SUPPORTING_EXTERNAL_ENTITIES	The property that requires the parser to resolve external parsed entities
  staticString	IS_VALIDATING	The property used to turn on/off implementation specific validation
  staticString	REPORTER	The property used to set/get the implementation of the XMLReporter interface
  staticString	RESOLVER	The property used to set/get the implementation of the XMLResolver
  staticString	SUPPORT_DTD	The property that requires the parser to support DTDs

• Constructor Summary

  Constructors 

  Modifier	Constructor	Description
  protected	XMLInputFactory()

• Method Summary

  All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 

  Modifier and Type	Method	Description
  abstractXMLEventReader	createFilteredReader(XMLEventReader reader,EventFilter filter)	Create a filtered event reader that wraps the filter around the event reader
  abstractXMLStreamReader	createFilteredReader(XMLStreamReader reader,StreamFilter filter)	Create a filtered reader that wraps the filter around the reader
  abstractXMLEventReader	createXMLEventReader(InputStream stream)	Create a new XMLEventReader from a java.io.InputStream
  abstractXMLEventReader	createXMLEventReader(InputStream stream,String encoding)	Create a new XMLEventReader from a java.io.InputStream
  abstractXMLEventReader	createXMLEventReader(Reader reader)	Create a new XMLEventReader from a reader
  abstractXMLEventReader	createXMLEventReader(Source source)	Create a new XMLEventReader from a JAXP source.
  abstractXMLEventReader	createXMLEventReader(String systemId,InputStream stream)	Create a new XMLEventReader from a java.io.InputStream
  abstractXMLEventReader	createXMLEventReader(String systemId,Reader reader)	Create a new XMLEventReader from a reader
  abstractXMLEventReader	createXMLEventReader(XMLStreamReader reader)	Create a new XMLEventReader from an XMLStreamReader.
  abstractXMLStreamReader	createXMLStreamReader(InputStream stream)	Create a new XMLStreamReader from a java.io.InputStream
  abstractXMLStreamReader	createXMLStreamReader(InputStream stream,String encoding)	Create a new XMLStreamReader from a java.io.InputStream
  abstractXMLStreamReader	createXMLStreamReader(Reader reader)	Create a new XMLStreamReader from a reader
  abstractXMLStreamReader	createXMLStreamReader(Source source)	Create a new XMLStreamReader from a JAXP source.
  abstractXMLStreamReader	createXMLStreamReader(String systemId,InputStream stream)	Create a new XMLStreamReader from a java.io.InputStream
  abstractXMLStreamReader	createXMLStreamReader(String systemId,Reader reader)	Create a new XMLStreamReader from a java.io.InputStream
  abstractXMLEventAllocator	getEventAllocator()	Gets the allocator used by streams created with this factory
  abstractObject	getProperty(String name)	Get the value of a feature/property from the underlying implementation
  abstractXMLReporter	getXMLReporter()	The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
  abstractXMLResolver	getXMLResolver()	The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
  abstract boolean	isPropertySupported(String name)	Query the set of properties that this factory supports.
  staticXMLInputFactory	newFactory()	Create a new instance of the factory.
  staticXMLInputFactory	newFactory(String factoryId,ClassLoader classLoader)	Create a new instance of the factory.
  staticXMLInputFactory	newInstance()	Creates a new instance of the factory in exactly the same manner as thenewFactory() method.
  staticXMLInputFactory	newInstance(String factoryId,ClassLoader classLoader)	Deprecated.  This method has been deprecated to maintain API consistency. All newInstance methods have been replaced with corresponding newFactory methods. The replacementnewFactory(java.lang.String, java.lang.ClassLoader) method defines no changes in behavior.
  abstract void	setEventAllocator(XMLEventAllocator allocator)	Set a user defined event allocator for events
  abstract void	setProperty(String name,Object value)	Allows the user to set specific feature/property on the underlying implementation.
  abstract void	setXMLReporter(XMLReporter reporter)	The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.
  abstract void	setXMLResolver(XMLResolver resolver)	The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

  • Methods inherited from class java.lang.Object

    clone,equals,finalize,getClass,hashCode,notify,notifyAll,toString,wait,wait,wait

• Field Detail

  • IS_NAMESPACE_AWARE

    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

    See Also:

    Constant Field Values

  • IS_VALIDATING

    public static final String IS_VALIDATING

    The property used to turn on/off implementation specific validation

    See Also:

    Constant Field Values

  • IS_COALESCING

    public static final String IS_COALESCING

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

    See Also:

    Constant Field Values

  • IS_REPLACING_ENTITY_REFERENCES

    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

    See Also:

    Constant Field Values

  • IS_SUPPORTING_EXTERNAL_ENTITIES

    public static final String IS_SUPPORTING_EXTERNAL_ENTITIES

    The property that requires the parser to resolve external parsed entities

    See Also:

    Constant Field Values

  • SUPPORT_DTD

    public static final String SUPPORT_DTD

    The property that requires the parser to support DTDs

    See Also:

    Constant Field Values

  • REPORTER

    public static final String REPORTER

    The property used to set/get the implementation of the XMLReporter interface

    See Also:

    Constant Field Values

  • RESOLVER

    public static final String RESOLVER

    The property used to set/get the implementation of the XMLResolver

    See Also:

    Constant Field Values

  • ALLOCATOR

    public static final String ALLOCATOR

    The property used to set/get the implementation of the allocator

    See Also:

    Constant Field Values

• Constructor Detail

  • XMLInputFactory

    protected XMLInputFactory()

• Method Detail

  • newInstance

    public static XMLInputFactory newInstance()                                   throwsFactoryConfigurationError

    Creates a new instance of the factory in exactly the same manner as thenewFactory() method.

    Throws:

    FactoryConfigurationError - if an instance of this factory cannot be loaded

  • newFactory

    public static XMLInputFactory newFactory()                                  throwsFactoryConfigurationError

    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 service-provider loading facilities, defined by theServiceLoader class, to attempt to locate and load an implementation of the service using thedefault loading mechanism: the service-provider loading facility will use thecurrent thread's context class loader to attempt to load the service. If the context class loader is null, thesystem class loader will be used.
    • Otherwise, the system-default implementation is returned.

    Once an application has obtained a reference to a XMLInputFactory it can use the factory to configure and obtain stream instances.

    Note that this is a new method that replaces the deprecated newInstance() method. No changes in behavior are defined by this replacement method relative to the deprecated method.

    Throws:

    FactoryConfigurationError - in case ofservice configuration error or if the implementation is not available or cannot be instantiated.

  • newInstance

    public static XMLInputFactory newInstance(String factoryId,ClassLoader classLoader)                                   throwsFactoryConfigurationError

    Deprecated. This method has been deprecated to maintain API consistency. All newInstance methods have been replaced with corresponding newFactory methods. The replacementnewFactory(java.lang.String, java.lang.ClassLoader) method defines no changes in behavior.
    Create a new instance of the factory

    Parameters:

    factoryId - Name of the factory to find, same as a property name

    classLoader - classLoader to use

    Returns:

    the factory implementation

    Throws:

    FactoryConfigurationError - if an instance of this factory cannot be loaded

  • newFactory

    public static XMLInputFactory newFactory(String factoryId,ClassLoader classLoader)                                  throwsFactoryConfigurationError

    Create a new instance of the factory. If the classLoader argument is null, then the ContextClassLoader is used.

    This method uses the following ordered lookup procedure to determine the XMLInputFactory implementation class to load:

    • Use the value of the system property identified byfactoryId.
    • 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 givenfactoryId.
    • IffactoryId is "javax.xml.stream.XMLInputFactory", use the service-provider loading facilities, defined by theServiceLoader class, to attempt tolocate and load an implementation of the service using the specifiedClassLoader. IfclassLoader is null, thedefault loading mechanism will apply: That is, the service-provider loading facility will use thecurrent thread's context class loader to attempt to load the service. If the context class loader is null, thesystem class loader will be used.
    • Otherwise, throws aFactoryConfigurationError.

    Note that this is a new method that replaces the deprecatednewInstance(String factoryId, ClassLoader classLoader) method. No changes in behavior are defined by this replacement method relative to the deprecated method.

    API Note:

    The parameter factoryId defined here is inconsistent with that of other JAXP factories where the first parameter is fully qualified factory class name that provides implementation of the factory.

    Parameters:

    factoryId - Name of the factory to find, same as a property name

    classLoader - classLoader to use

    Returns:

    the factory implementation

    Throws:

    FactoryConfigurationError - in case ofservice configuration error or if the implementation is not available or cannot be instantiated.

    FactoryConfigurationError - if an instance of this factory cannot be loaded

  • createXMLStreamReader

    public abstract XMLStreamReader createXMLStreamReader(Reader reader)                                               throwsXMLStreamException

    Create a new XMLStreamReader from a reader

    Parameters:

    reader - the XML data to read from

    Throws:

    XMLStreamException

  • createXMLStreamReader

    public abstract XMLStreamReader createXMLStreamReader(Source source)                                               throwsXMLStreamException

    Create a new XMLStreamReader from a JAXP source. This method is optional.

    Parameters:

    source - the source to read from

    Throws:

    UnsupportedOperationException - if this method is not supported by this XMLInputFactory

    XMLStreamException

  • createXMLStreamReader

    public abstract XMLStreamReader createXMLStreamReader(InputStream stream)                                               throwsXMLStreamException

    Create a new XMLStreamReader from a java.io.InputStream

    Parameters:

    stream - the InputStream to read from

    Throws:

    XMLStreamException

  • createXMLStreamReader

    public abstract XMLStreamReader createXMLStreamReader(InputStream stream,String encoding)                                               throwsXMLStreamException

    Create a new XMLStreamReader from a java.io.InputStream

    Parameters:

    stream - the InputStream to read from

    encoding - the character encoding of the stream

    Throws:

    XMLStreamException

  • createXMLStreamReader

    public abstract XMLStreamReader createXMLStreamReader(String systemId,InputStream stream)                                               throwsXMLStreamException

    Create a new XMLStreamReader from a java.io.InputStream

    Parameters:

    systemId - the system ID of the stream

    stream - the InputStream to read from

    Throws:

    XMLStreamException

  • createXMLStreamReader

    public abstract XMLStreamReader createXMLStreamReader(String systemId,Reader reader)                                               throwsXMLStreamException

    Create a new XMLStreamReader from a java.io.InputStream

    Parameters:

    systemId - the system ID of the stream

    reader - the InputStream to read from

    Throws:

    XMLStreamException

  • createXMLEventReader

    public abstract XMLEventReader createXMLEventReader(Reader reader)                                             throwsXMLStreamException

    Create a new XMLEventReader from a reader

    Parameters:

    reader - the XML data to read from

    Throws:

    XMLStreamException

  • createXMLEventReader

    public abstract XMLEventReader createXMLEventReader(String systemId,Reader reader)                                             throwsXMLStreamException

    Create a new XMLEventReader from a reader

    Parameters:

    systemId - the system ID of the input

    reader - the XML data to read from

    Throws:

    XMLStreamException

  • createXMLEventReader

    public abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)                                             throwsXMLStreamException

    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.

    Parameters:

    reader - the XMLStreamReader to read from (may not be modified)

    Returns:

    a new XMLEventReader

    Throws:

    XMLStreamException

  • createXMLEventReader

    public abstract XMLEventReader createXMLEventReader(Source source)                                             throwsXMLStreamException

    Create a new XMLEventReader from a JAXP source. Support of this method is optional.

    Parameters:

    source - the source to read from

    Throws:

    UnsupportedOperationException - if this method is not supported by this XMLInputFactory

    XMLStreamException

  • createXMLEventReader

    public abstract XMLEventReader createXMLEventReader(InputStream stream)                                             throwsXMLStreamException

    Create a new XMLEventReader from a java.io.InputStream

    Parameters:

    stream - the InputStream to read from

    Throws:

    XMLStreamException

  • createXMLEventReader

    public abstract XMLEventReader createXMLEventReader(InputStream stream,String encoding)                                             throwsXMLStreamException

    Create a new XMLEventReader from a java.io.InputStream

    Parameters:

    stream - the InputStream to read from

    encoding - the character encoding of the stream

    Throws:

    XMLStreamException

  • createXMLEventReader

    public abstract XMLEventReader createXMLEventReader(String systemId,InputStream stream)                                             throwsXMLStreamException

    Create a new XMLEventReader from a java.io.InputStream

    Parameters:

    systemId - the system ID of the stream

    stream - the InputStream to read from

    Throws:

    XMLStreamException

  • createFilteredReader

    public abstract XMLStreamReader createFilteredReader(XMLStreamReader reader,StreamFilter filter)                                              throwsXMLStreamException

    Create a filtered reader that wraps the filter around the reader

    Parameters:

    reader - the reader to filter

    filter - the filter to apply to the reader

    Throws:

    XMLStreamException

  • createFilteredReader

    public abstract XMLEventReader createFilteredReader(XMLEventReader reader,EventFilter filter)                                             throwsXMLStreamException

    Create a filtered event reader that wraps the filter around the event reader

    Parameters:

    reader - the event reader to wrap

    filter - the filter to apply to the event reader

    Throws:

    XMLStreamException

  • getXMLResolver

    public abstract XMLResolver getXMLResolver()

    The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

  • setXMLResolver

    public abstract void setXMLResolver(XMLResolver resolver)

    The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

    Parameters:

    resolver - the resolver to use to resolve references

  • getXMLReporter

    public abstract XMLReporter getXMLReporter()

    The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

  • setXMLReporter

    public abstract void setXMLReporter(XMLReporter reporter)

    The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance.

    Parameters:

    reporter - the resolver to use to report non fatal errors

  • setProperty

    public abstract void setProperty(String name,Object value)                          throwsIllegalArgumentException

    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.

    All implementations that implement JAXP 1.5 or newer are required to support theXMLConstants.ACCESS_EXTERNAL_DTD property.

    • Access to external DTDs, external Entity References is restricted to the protocols specified by the property. If access is denied during parsing due to the restriction of this property,XMLStreamException will be thrown by theXMLStreamReader.next() orXMLEventReader.nextEvent() method.

    Parameters:

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

    value - The value of the property

    Throws:

    IllegalArgumentException - if the property is not supported

  • getProperty

    public abstract Object getProperty(String name)                            throwsIllegalArgumentException

    Get 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

    public abstract boolean isPropertySupported(String name)

    Query the set of properties that this factory supports.

    Parameters:

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

    Returns:

    true if the property is supported and false otherwise

  • setEventAllocator

    public abstract void setEventAllocator(XMLEventAllocator allocator)

    Set a user defined event allocator for events

    Parameters:

    allocator - the user defined allocator

  • getEventAllocator

    public abstract XMLEventAllocator getEventAllocator()

    Gets the allocator used by streams created with this factory