Module  java.xml
软件包  javax.xml.stream

Class XMLInputFactory


  • public abstract class XMLInputFactory
extends Object
    定义了一个工厂的抽象实现来获取流。 下表定义了本规范的标准属性。 每个财产的每个实施所需的支持水平各不相同。 所需的支持级别在“必需”列中描述。 Configuration Parameters Property Name Behavior Return type Default Value Required javax.xml.stream.isValidating Turns on/off implementation specific DTD validation Boolean False No javax.xml.stream.isNamespaceAware Turns on/off namespace processing for XML 1.0 support Boolean True True (required) / False (optional) javax.xml.stream.isCoalescing Requires the processor to coalesce adjacent character data Boolean False Yes javax.xml.stream.isReplacingEntityReferences replace internal entity references with their replacement text and report them as characters Boolean True Yes javax.xml.stream.isSupportingExternalEntities Resolve external parsed entities Boolean Unspecified Yes javax.xml.stream.supportDTD Use this property to request processors that do not support DTDs Boolean True Yes javax.xml.stream.reporter sets/gets the impl of the XMLReporter javax.xml.stream.XMLReporter Null Yes javax.xml.stream.resolver sets/gets the impl of the XMLResolver interface javax.xml.stream.XMLResolver Null Yes javax.xml.stream.allocator sets/gets the impl of the XMLEventAllocator interface javax.xml.stream.util.XMLEventAllocator Null Yes
    从以下版本开始：
    1.6
    Version:
    1.2
    另请参见：
    XMLOutputFactory ， XMLEventReader ， XMLStreamReader ， EventFilter ， XMLReporter ， XMLResolver ， XMLEventAllocator

    • 字段详细信息

      • IS_NAMESPACE_AWARE

        public static final String IS_NAMESPACE_AWARE
        该属性用于打开/关闭命名空间支持，这是为了支持XML 1.0文档，只有真正的设置必须被支持
        另请参见：
        Constant Field Values

      • IS_VALIDATING

        public static final String IS_VALIDATING
        用于打开/关闭实现特定验证的属性
        另请参见：
        Constant Field Values

      • IS_COALESCING

        public static final String IS_COALESCING
        需要解析器来合并相邻字符数据部分的属性
        另请参见：
        Constant Field Values

      • IS_REPLACING_ENTITY_REFERENCES

        public static final String IS_REPLACING_ENTITY_REFERENCES
        需要解析器用其替换文本替换内部实体引用并将其报告为字符
        另请参见：
        Constant Field Values

      • IS_SUPPORTING_EXTERNAL_ENTITIES

        public static final String IS_SUPPORTING_EXTERNAL_ENTITIES
        需要解析器解析外部解析实体的属性
        另请参见：
        Constant Field Values

      • REPORTER

        public static final String REPORTER
        该属性用于设置/获取XMLReporter接口的实现
        另请参见：
        Constant Field Values

    • 构造方法详细信息

      • XMLInputFactory

        protected XMLInputFactory​()

    • 方法详细信息

      • newDefaultFactory

        public static XMLInputFactory newDefaultFactory​()
        创建一个新的 XMLInputFactory内建系统默认实现。
        结果
        XMLInputFactory内建系统默认实现的新实例。
        从以下版本开始：
        9

      • newFactory

        @Deprecated(since="1.7")
public static XMLInputFactory newFactory​()
                                  throws FactoryConfigurationError
        已过时。
        创建一个新的工厂实例。

        这个静态方法创建一个新的工厂实例。 此方法使用以下有序查找过程来确定要加载的XMLInputFactory实现类：

        • 使用javax.xml.stream.XMLInputFactory系统属性。

        • 使用配置文件“stax.properties”。 该文件采用标准Properties格式，通常位于Java安装的conf目录中。 它包含实现类的完全限定名称，其中键是上面定义的系统属性。

          stax.properties文件只能在实现中读取一次，然后将其值缓存以备将来使用。 如果文件第一次尝试读取文件不存在，则不再进一步检查其存在。 在第一次读取stax.properties之后，不可能更改任何属性的值。

          使用jaxp配置文件“jaxp.properties”。 该文件的格式与stax.properties格式相同，只有在stax.properties不存在的情况下才会被读取。

        • 使用由ServiceLoader类定义的服务提供商加载工具，尝试使用default loading mechanism来定位和加载服务的实现 ：服务提供商加载工具将使用current thread's context class loader尝试加载服务。 如果上下文类加载器为null，将使用system class loader 。

        • 否则，将返回system-default实现。

        一旦应用程序获得了对XMLInputFactory的引用，它可以使用工厂来配置和获取流实例。

        请注意，这是一种替代不推荐使用的newInstance（）方法的新方法。 相对于不推荐使用的方法，此替换方法没有定义行为更改。

        异常
        FactoryConfigurationError -在以下情况下service configuration error或者如果实现不可用或不能被实例化。

      • newFactory

        public static XMLInputFactory newFactory​(String factoryId,
                                         ClassLoader classLoader)
                                  throws FactoryConfigurationError
        创建一个新的工厂实例。 如果classLoader参数为空，则使用ContextClassLoader。

        此方法使用以下有序查找过程来确定要加载的XMLInputFactory实现类：

        • 使用factoryId标识的系统属性的值。

        • 使用配置文件“stax.properties”。 该文件采用标准Properties格式，通常位于Java安装的conf目录中。 它包含实现类的完全限定名称，其中键是上面定义的系统属性。

          stax.properties文件只能在实现中读取一次，然后将其值缓存以备将来使用。 如果文件第一次尝试读取文件不存在，则不再进一步检查其存在。 在第一次读取stax.properties之后，不可能更改任何属性的值。

          使用jaxp配置文件“jaxp.properties”。 该文件的格式与stax.properties格式相同，只有在stax.properties不存在的情况下才会被读取。

        • 如果factoryId是“javax.xml.stream.XMLInputFactory”，使用服务提供商装载设施，由定义ServiceLoader类，试图locate and load使用指定的服务的实现ClassLoader 。 如果classLoader为空，则将使用default loading mechanism ：即，服务提供商加载工具将使用current thread's context class loader尝试加载服务。 如果上下文类加载器为null，将使用system class loader 。

        • 否则，抛出一个FactoryConfigurationError 。

        请注意，这是一种替代已弃用的newInstance(String factoryId, ClassLoader classLoader)方法的新方法。 相对于不推荐使用的方法，此替换方法没有定义行为更改。

        API Note:
        这里定义的参数factoryId与其他JAXP工厂的参数factoryId不一致，其中第一个参数是提供工厂实现的完全限定的工厂类名称。
        参数
        factoryId - 要查找的工厂名称，与属性名称相同
        classLoader - classLoader使用
        结果
        工厂实施
        异常
        FactoryConfigurationError -在以下情况下service configuration error或者如果实现不可用或不能被实例化。
        FactoryConfigurationError - 如果此工厂的实例无法加载

      • createXMLEventReader

        public abstract XMLEventReader createXMLEventReader​(XMLStreamReader reader)
                                             throws XMLStreamException
        从XMLStreamReader创建一个新的XMLEventReader。 在用于构造从此方法返回的XMLEventReader实例之后，不能使用XMLStreamReader。
        参数
        reader - 要读取的XMLStreamReader（可能不会被修改）
        结果
        一个新的XMLEventReader
        异常
        XMLStreamException

      • getXMLResolver

        public abstract XMLResolver getXMLResolver​()
        将在此工厂实例创建的任何XMLStreamReader或XMLEventReader上设置的解析器。

      • setXMLResolver

        public abstract void setXMLResolver​(XMLResolver resolver)
        将在此工厂实例创建的任何XMLStreamReader或XMLEventReader上设置的解析器。
        参数
        resolver - 解析器用于解析引用

      • getXMLReporter

        public abstract XMLReporter getXMLReporter​()
        该记者会设置在由此工厂实例创建的任何XMLStreamReader或XMLEventReader上。

      • setXMLReporter

        public abstract void setXMLReporter​(XMLReporter reporter)
        该记者会设置在由此工厂实例创建的任何XMLStreamReader或XMLEventReader上。
        参数
        reporter - 用于报告非致命错误的解析器

      • setProperty

        public abstract void setProperty​(String name,
                                 Object value)
                          throws IllegalArgumentException
        允许用户在底层实现上设置特定的功能/属性。 底层实现不需要支持规范中每个属性的每个设置，并且可能使用IllegalArgumentException来表示不支持的属性不能被设置为指定的值。

        实现JAXP 1.5或更高版本的所有实现都需要支持XMLConstants.ACCESS_EXTERNAL_DTD属性。

        参数
        name - 属性的名称（可能不为空）
        value - 物业的价值
        异常
        IllegalArgumentException - 如果不支持该属性

      • isPropertySupported

        public abstract boolean isPropertySupported​(String name)
        查询此工厂支持的属性集。
        参数
        name - 属性的名称（可能不为空）
        结果
        如果属性被支持，则为true，否则为false

      • setEventAllocator

        public abstract void setEventAllocator​(XMLEventAllocator allocator)
        为事件设置用户定义的事件分配器
        参数
        allocator - 用户定义的分配器

      • getEventAllocator

        public abstract XMLEventAllocator getEventAllocator​()
        获取由此工厂创建的流使用的分配器