IT. Expert System.

Java Standard Edition (SE)

XMLInputFactory


compact2, compact3
javax.xml.stream

Class XMLInputFactory



  • public abstract class XMLInputFactory
    extends Object
    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
    Since:
    1.6
    Version:
    1.2
    See Also:
    XMLOutputFactory, XMLEventReader, XMLStreamReader, EventFilter, XMLReporter, XMLResolver, XMLEventAllocator
    • 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

      • newFactory

        public static XMLInputFactory newFactory()
                                          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 service-provider loading facilities, defined by the ServiceLoader class, to attempt to locate and load an implementation of the service using the default loading mechanism: the service-provider loading facility will use the current thread's context class loader to attempt to load the service. If the context class loader is null, the system 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 of service configuration error or if the implementation is not available or cannot be instantiated.
      • newInstance

        public static XMLInputFactory newInstance(String factoryId,
                                                  ClassLoader classLoader)
                                           throws FactoryConfigurationError
        Deprecated. This method has been deprecated to maintain API consistency. All newInstance methods have been replaced with corresponding newFactory methods. The replacement newFactory(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)
                                          throws FactoryConfigurationError
        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 by factoryId.
        • 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 given factoryId.
        • If factoryId is "javax.xml.stream.XMLInputFactory", use the service-provider loading facilities, defined by the ServiceLoader class, to attempt to locate and load an implementation of the service using the specified ClassLoader. If classLoader is null, the default loading mechanism will apply: That is, the service-provider loading facility will use the current thread's context class loader to attempt to load the service. If the context class loader is null, the system class loader will be used.
        • Otherwise, throws a FactoryConfigurationError.

        Note that this is a new method that replaces the deprecated newInstance(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 of service configuration error or if the implementation is not available or cannot be instantiated.
        FactoryConfigurationError - if an instance of this factory cannot be loaded
      • createXMLEventReader

        public abstract 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.
        Parameters:
        reader - the XMLStreamReader to read from (may not be modified)
        Returns:
        a new XMLEventReader
        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)
                                  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.

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

        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)
                                    throws IllegalArgumentException
        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


Content

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.
All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.
Copyright 2016 © ELTASK.COM. All rights reserved.
Site is optimized for mobile devices.
Downloads: 271 / 158871143. Delta: 0.11863 с