XMLInputFactory (Java Platform SE 8 )

java.lang.Object
- javax.xml.stream.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

从以下版本开始：: 一点六
Version:: 一点二
另请参见：: XMLOutputFactory， XMLEventReader， XMLStreamReader， EventFilter， XMLReporter， XMLResolver， XMLEventAllocator

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOCATOR` 属性用于设置或获取分配器的实现
`static String`	`IS_COALESCING` 物业要求解析器合并相邻字符数据段
`static String`	`IS_NAMESPACE_AWARE` 用于打开/关闭命名空间支持的属性，这是支持XML 1文档，只有真正的设置必须被支持
`static String`	`IS_REPLACING_ENTITY_REFERENCES` 需要解析器以替换文本来替换内部实体引用，并将它们报告为字符
`static String`	`IS_SUPPORTING_EXTERNAL_ENTITIES` 需要解析来解析外部解析实体的属性
`static String`	`IS_VALIDATING` 用于打开/关闭实现特定验证的属性
`static String`	`REPORTER` 属性用于设置或获取的xmlreporter接口的实现
`static String`	`RESOLVER` 属性用于设置/得到实施的XMLResolver
`static String`	`SUPPORT_DTD` 物业要求解析器支持DTD

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`XMLInputFactory()`

方法摘要

所有方法静态方法接口方法抽象方法具体的方法弃用的方法
Modifier and Type	Method and Description
`abstract XMLEventReader`	`createFilteredReader(XMLEventReader reader, EventFilter filter)` 创建一个过滤事件阅读器，将过滤器包装在事件阅读器周围
`abstract XMLStreamReader`	`createFilteredReader(XMLStreamReader reader, StreamFilter filter)` 创建一个过滤的阅读器，包装在阅读器周围的过滤器
`abstract XMLEventReader`	`createXMLEventReader(InputStream stream)` 从一个新的创造java.io.inputstream XMLEventReader
`abstract XMLEventReader`	`createXMLEventReader(InputStream stream, String encoding)` 从一个新的创造java.io.inputstream XMLEventReader
`abstract XMLEventReader`	`createXMLEventReader(Reader reader)` 创建从一个读者的新XMLEventReader
`abstract XMLEventReader`	`createXMLEventReader(Source source)` 创建从JAXP源新XMLEventReader。
`abstract XMLEventReader`	`createXMLEventReader(String systemId, InputStream stream)` 从一个新的创造java.io.inputstream XMLEventReader
`abstract XMLEventReader`	`createXMLEventReader(String systemId, Reader reader)` 创建从一个读者的新XMLEventReader
`abstract XMLEventReader`	`createXMLEventReader(XMLStreamReader reader)` 创建一个新的XMLEventReader XMLStreamReader。
`abstract XMLStreamReader`	`createXMLStreamReader(InputStream stream)` 从java.io.inputstream创造新xmlstreamreader
`abstract XMLStreamReader`	`createXMLStreamReader(InputStream stream, String encoding)` 从java.io.inputstream创造新xmlstreamreader
`abstract XMLStreamReader`	`createXMLStreamReader(Reader reader)` 创建从一个读者的一个新的xmlstreamreader
`abstract XMLStreamReader`	`createXMLStreamReader(Source source)` 创建新xmlstreamreader JAXP源。
`abstract XMLStreamReader`	`createXMLStreamReader(String systemId, InputStream stream)` 从java.io.inputstream创造新xmlstreamreader
`abstract XMLStreamReader`	`createXMLStreamReader(String systemId, Reader reader)` 从java.io.inputstream创造新xmlstreamreader
`abstract XMLEventAllocator`	`getEventAllocator()` 被这个工厂创建流分配器
`abstract Object`	`getProperty(String name)` 从底层实现获取一个功能/属性的值
`abstract XMLReporter`	`getXMLReporter()` 记者将被设置在任何xmlstreamreader XMLEventReader实例创建或本厂。
`abstract XMLResolver`	`getXMLResolver()` 解析器将设置在任何xmlstreamreader XMLEventReader实例创建或本厂。
`abstract boolean`	`isPropertySupported(String name)` 查询此工厂支持的属性集。
`static XMLInputFactory`	`newFactory()` 创建工厂的一个新实例。
`static XMLInputFactory`	`newFactory(String factoryId, ClassLoader classLoader)` 创建工厂的一个新实例。
`static XMLInputFactory`	`newInstance()` 创建了一个新的工厂，以同样的方式方法的 `newFactory()`。
`static XMLInputFactory`	`newInstance(String factoryId, ClassLoader classLoader)` 过时的。此方法已被否决保持API的一致性。所有的newInstance方法已经有相应的新工厂方法所取代。更换`newFactory(java.lang.String, java.lang.ClassLoader)`方法定义在行为上没有变化。
`abstract void`	`setEventAllocator(XMLEventAllocator allocator)` 为事件设置一个用户定义的事件分配器
`abstract void`	`setProperty(String name, Object value)` 允许用户在底层实现上设置特定的功能/属性。
`abstract void`	`setXMLReporter(XMLReporter reporter)` 记者将被设置在任何xmlstreamreader XMLEventReader实例创建或本厂。
`abstract void`	`setXMLResolver(XMLResolver resolver)` 解析器将设置在任何xmlstreamreader XMLEventReader实例创建或本厂。

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
```
    用于打开/关闭命名空间支持的属性，这是支持XML 1文档，只有真正的设置必须被支持
    
    另请参见：
    
    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
  - SUPPORT_DTD
```
public static final String SUPPORT_DTD
```
    物业要求解析器支持DTD
    
    另请参见：
    
    Constant Field Values
  - REPORTER
```
public static final String REPORTER
```
    属性用于设置或获取的xmlreporter接口的实现
    
    另请参见：
    
    Constant Field Values
  - RESOLVER
```
public static final String RESOLVER
```
    属性用于设置/得到实施的XMLResolver
    
    另请参见：
    
    Constant Field Values
  - ALLOCATOR
```
public static final String ALLOCATOR
```
    属性用于设置或获取分配器的实现
    
    另请参见：
    
    Constant Field Values
- Constructor Detail
  - XMLInputFactory
```
protected XMLInputFactory()
```
- 方法详细信息
  - newInstance
```
public static XMLInputFactory newInstance()
                                   throws FactoryConfigurationError
```
    创建了一个新的工厂，以同样的方式方法的 newFactory()。
    
    异常
    
    FactoryConfigurationError -如果该厂不能实例被加载
  - newFactory
```
public static XMLInputFactory newFactory()
                                  throws FactoryConfigurationError
```
    创建工厂的一个新实例。
    这种静态方法创建一个新的工厂实例。此方法使用以下命令查找程序确定XMLInputFactory实现类负载：
    - 使用javax.xml.stream.xmlinputfactory系统性能。
    - 使用属性文件的“库/ StAX。属性”在JRE目录。这个配置文件是java.util.properties格式标准，包含实现类的完全限定名的关键是上面定义的系统性能。
    - 使用服务提供商装载设施，由ServiceLoader类定义，试图定位和加载使用default loading mechanism服务的实现：服务提供者装载设备将使用current thread's context class loader尝试加载服务。如果上下文类加载器是空的，将使用的system class loader。
    - 否则，系统默认实现返回。
    一旦申请获得参考一XMLInputFactory可以使用工厂配置和获取流实例。
    
    请注意，这是一种新的方法取代了过时的newinstance()方法。在行为上没有变化是由这种方法相对于过时的方法定义。
    异常
    
    FactoryConfigurationError -的情况下， service configuration error或者执行不可用或不能被实例化。
  - newInstance
```
public static XMLInputFactory newInstance(String factoryId,
                                          ClassLoader classLoader)
                                   throws FactoryConfigurationError
```
    过时的。此方法已被否决保持API的一致性。所有的newInstance方法已经有相应的新工厂方法所取代。更换newFactory(java.lang.String, java.lang.ClassLoader)方法定义在行为上没有变化。
    
    创建工厂的一个新实例
    
    参数
    
    factoryId -工厂找到名字，相同的属性名
    
    classLoader -类装载器使用
    
    结果
    
    本厂实施
    
    异常
    
    FactoryConfigurationError -如果该厂不能实例被加载
  - newFactory
```
public static XMLInputFactory newFactory(String factoryId,
                                         ClassLoader classLoader)
                                  throws FactoryConfigurationError
```
    创建工厂的一个新实例。如果类装载器的参数为null，然后用contextclassloader。
    此方法使用以下命令查找程序确定XMLInputFactory实现类负载：
    - 利用确定的factoryId系统属性的值。
    - 使用属性文件的“库/ StAX。属性”在JRE目录。这个配置文件是java.util.properties格式标准，包含实现类的完全限定名的关键是给出的factoryId。
    - 如果factoryId“javax. XML流。XMLInputFactory”，使用该服务提供商装载设施，由ServiceLoader类定义，试图找到并加载一个服务的实现使用指定的ClassLoader classLoader。如果为空，将default loading mechanism：即服务提供商装载设备将使用current thread's context class loader试图加载服务。如果上下文类加载器是空的，将使用的system class loader。
    - 否则，抛出一个FactoryConfigurationError。
    请注意，这是一种新的方法取代了过时的newInstance(String factoryId, ClassLoader classLoader)方法。在行为上没有变化是由这种方法相对于过时的方法定义。
    API Note:
    
    这里定义的参数factoryid与其他JAXP的工厂，第一个参数是完全合格的工厂类的名字，提供工厂实施不一致。
    
    参数
    
    factoryId -工厂找到名字，相同的属性名
    
    classLoader -类装载器使用
    
    结果
    
    本厂实施
    
    异常
    
    FactoryConfigurationError -的情况下， service configuration error或者执行不可用或不能被实例化。
    
    FactoryConfigurationError -如果该厂不能实例被加载
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(Reader reader)
                                               throws XMLStreamException
```
    创建从一个读者的一个新的xmlstreamreader
    
    参数
    
    reader - XML数据读取
    
    异常
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(Source source)
                                               throws XMLStreamException
```
    创建新xmlstreamreader JAXP源。此方法是可选的。
    
    参数
    
    source -源读取
    
    异常
    
    UnsupportedOperationException -如果这个方法不支持这个XMLInputFactory
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(InputStream stream)
                                               throws XMLStreamException
```
    从java.io.inputstream创造新xmlstreamreader
    
    参数
    
    stream的InputStream读取
    
    异常
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(InputStream stream,
                                                      String encoding)
                                               throws XMLStreamException
```
    从java.io.inputstream创造新xmlstreamreader
    
    参数
    
    stream的InputStream读取
    
    encoding -流的字符编码
    
    异常
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(String systemId,
                                                      InputStream stream)
                                               throws XMLStreamException
```
    从java.io.inputstream创造新xmlstreamreader
    
    参数
    
    systemId -流系统ID
    
    stream的InputStream读取
    
    异常
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(String systemId,
                                                      Reader reader)
                                               throws XMLStreamException
```
    从java.io.inputstream创造新xmlstreamreader
    
    参数
    
    systemId -流系统ID
    
    reader的InputStream读取
    
    异常
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(Reader reader)
                                             throws XMLStreamException
```
    创建从一个读者的新XMLEventReader
    
    参数
    
    reader - XML数据读取
    
    异常
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(String systemId,
                                                    Reader reader)
                                             throws XMLStreamException
```
    创建从一个读者的新XMLEventReader
    
    参数
    
    systemId -输入系统ID
    
    reader - XML数据读取
    
    异常
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)
                                             throws XMLStreamException
```
    创建一个新的XMLEventReader XMLStreamReader。后被用来构建XMLEventReader实例从此方法返回的xmlstreamreader不得使用。
    
    参数
    
    reader - xmlstreamreader读取（不可修改）
    
    结果
    
    一个新的XMLEventReader
    
    异常
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(Source source)
                                             throws XMLStreamException
```
    创建从JAXP源新XMLEventReader。这种方法的支持是可选的。
    
    参数
    
    source -源读取
    
    异常
    
    UnsupportedOperationException -如果这个方法不支持这个XMLInputFactory
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(InputStream stream)
                                             throws XMLStreamException
```
    从一个新的创造java.io.inputstream XMLEventReader
    
    参数
    
    stream的InputStream读取
    
    异常
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(InputStream stream,
                                                    String encoding)
                                             throws XMLStreamException
```
    从一个新的创造java.io.inputstream XMLEventReader
    
    参数
    
    stream的InputStream读取
    
    encoding -流的字符编码
    
    异常
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(String systemId,
                                                    InputStream stream)
                                             throws XMLStreamException
```
    从一个新的创造java.io.inputstream XMLEventReader
    
    参数
    
    systemId -流系统ID
    
    stream的InputStream读取
    
    异常
    
    XMLStreamException
  - createFilteredReader
```
public abstract XMLStreamReader createFilteredReader(XMLStreamReader reader,
                                                     StreamFilter filter)
                                              throws XMLStreamException
```
    创建一个过滤的阅读器，包装在阅读器周围的过滤器
    
    参数
    
    reader -读者滤波器
    
    filter -过滤器适用于读者
    
    异常
    
    XMLStreamException
  - createFilteredReader
```
public abstract XMLEventReader createFilteredReader(XMLEventReader reader,
                                                    EventFilter filter)
                                             throws XMLStreamException
```
    创建一个过滤事件阅读器，将过滤器包装在事件阅读器周围
    
    参数
    
    reader -事件阅读器包
    
    filter -过滤器适用于事件的读者
    
    异常
    
    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
```
    允许用户在底层实现上设置特定的功能/属性。底层的实现不需要支持规范中的每个属性都设置，可以使用时表示不支持的属性不能设置指定值。
    实现JAXP 1.5或更新版本的所有实现都必须支持的XMLConstants.ACCESS_EXTERNAL_DTD财产。
    - 访问外部DTDs，外部实体引用是限制由属性指定的协议。如果访问被拒绝，在分析过程中，由于这种性质的限制，XMLStreamException将抛出的XMLStreamReader.next()或XMLEventReader.nextEvent()方法。
    参数
    
    name -属性的名称（不得为空）
    
    value -财产的价值
    
    异常
    
    IllegalArgumentException如果物业不支持
  - getProperty
```
public abstract Object getProperty(String name)
                            throws IllegalArgumentException
```
    从底层实现获取一个功能/属性的值
    
    参数
    
    name -属性的名称（不得为空）
    
    结果
    
    属性的值
    
    异常
    
    IllegalArgumentException如果物业不支持
  - isPropertySupported
```
public abstract boolean isPropertySupported(String name)
```
    查询此工厂支持的属性集。
    
    参数
    
    name -属性的名称（不得为空）
    
    结果
    
    如果属性是支持的，否则为假
  - setEventAllocator
```
public abstract void setEventAllocator(XMLEventAllocator allocator)
```
    为事件设置一个用户定义的事件分配器
    
    参数
    
    allocator定义分配器用户
  - getEventAllocator
```
public abstract XMLEventAllocator getEventAllocator()
```
    被这个工厂创建流分配器

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Class XMLInputFactory

Field Summary

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

Field Detail

IS_NAMESPACE_AWARE

IS_VALIDATING

IS_COALESCING

IS_REPLACING_ENTITY_REFERENCES

IS_SUPPORTING_EXTERNAL_ENTITIES

SUPPORT_DTD

REPORTER

RESOLVER

ALLOCATOR

Constructor Detail

XMLInputFactory

方法详细信息

newInstance

newFactory

newInstance

newFactory

createXMLStreamReader

createXMLStreamReader

createXMLStreamReader

createXMLStreamReader

createXMLStreamReader

createXMLStreamReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createFilteredReader

createFilteredReader

getXMLResolver

setXMLResolver

getXMLReporter

setXMLReporter

setProperty

getProperty

isPropertySupported

setEventAllocator

getEventAllocator