JavaTM Platform
Standard Ed. 6

javax.xml.stream
类 XMLEventFactory

java.lang.Object
  继承者 javax.xml.stream.XMLEventFactory

public abstract class XMLEventFactory
     
extends Object

此接口定义一个创建 XMLEvent 实例的实用工具类。

从以下版本开始:
1.6
另请参见:
StartElement, EndElement, ProcessingInstruction, Comment, Characters, StartDocument, EndDocument, DTD

构造方法摘要
protected XMLEventFactory()
           
 
方法摘要
abstract  Attribute createAttribute(QName name, String value)
          创建一个新 Attribute。
abstract  Attribute createAttribute(String localName, String value)
          创建一个新 Attribute。
abstract  Attribute createAttribute(String prefix, String namespaceURI, String localName, String value)
          创建一个新 Attribute。
abstract  Characters createCData(String content)
          创建一个 CData 标记设置为 true 的 Character 事件。
abstract  Characters createCharacters(String content)
          创建一个 Character 事件,此方法不检查内容是否全部为空白。
abstract  Comment createComment(String text)
          创建一个注释。
abstract  DTD createDTD(String dtd)
          创建一个文档类型定义事件。
abstract  EndDocument createEndDocument()
          创建一个 EndDocument 事件的新实例。
abstract  EndElement createEndElement(QName name, Iterator namespaces)
          创建一个新 EndElement。
abstract  EndElement createEndElement(String prefix, String namespaceUri, String localName)
          创建一个新 EndElement。
abstract  EndElement createEndElement(String prefix, String namespaceUri, String localName, Iterator namespaces)
          创建一个新 EndElement。
abstract  EntityReference createEntityReference(String name, EntityDeclaration declaration)
          创建一个 EntityReference 事件的新实例。
abstract  Characters createIgnorableSpace(String content)
          创建一个可忽略的空间。
abstract  Namespace createNamespace(String namespaceURI)
          创建一个新的默认 Namespace。
abstract  Namespace createNamespace(String prefix, String namespaceUri)
          创建一个新的 Namespace。
abstract  ProcessingInstruction createProcessingInstruction(String target, String data)
          创建一个处理指令。
abstract  Characters createSpace(String content)
          创建一个 isSpace 标记设置为 true 的 Character 事件。
abstract  StartDocument createStartDocument()
          创建一个 StartDocument 事件的新实例。
abstract  StartDocument createStartDocument(String encoding)
          创建一个 StartDocument 事件的新实例。
abstract  StartDocument createStartDocument(String encoding, String version)
          创建一个 StartDocument 事件的新实例。
abstract  StartDocument createStartDocument(String encoding, String version, boolean standalone)
          创建一个 StartDocument 事件的新实例。
abstract  StartElement createStartElement(QName name, Iterator attributes, Iterator namespaces)
          创建一个新 StartElement。
abstract  StartElement createStartElement(String prefix, String namespaceUri, String localName)
          创建一个新 StartElement。
abstract  StartElement createStartElement(String prefix, String namespaceUri, String localName, Iterator attributes, Iterator namespaces)
          创建一个新 StartElement。
abstract  StartElement createStartElement(String prefix, String namespaceUri, String localName, Iterator attributes, Iterator namespaces, NamespaceContext context)
          创建一个新 StartElement。
static XMLEventFactory newInstance()
          创建一个新的工厂实例。
static XMLEventFactory newInstance(String factoryId, ClassLoader classLoader)
          创建一个新的工厂实例。
abstract  void setLocation(Location location)
          此方法允许对此工厂创建的每个事件设置 Location。
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

XMLEventFactory

protected XMLEventFactory()
方法详细信息

newInstance

public static XMLEventFactory newInstance()
                                   throws FactoryConfigurationError
创建一个新的工厂实例。

抛出:
FactoryConfigurationError - 如果无法加载此工厂的实例

newInstance

public static XMLEventFactory newInstance(String factoryId,
                                          ClassLoader classLoader)
                                   throws FactoryConfigurationError
创建一个新的工厂实例。

参数:
factoryId - 要查找的工厂的名称,与属性名称相同
classLoader - 要使用的类加载器
返回:
工厂实现
抛出:
FactoryConfigurationError - 如果此工厂的实例无法加载

setLocation

public abstract void setLocation(Location location)
此方法允许对此工厂创建的每个事件设置 Location。这些值被复制到此工厂创建的事件中。若要重置位置信息,可将 location 设置为 null。

参数:
location - 要对每个创建的事件设置的位置

createAttribute

public abstract Attribute createAttribute(String prefix,
                                          String namespaceURI,
                                          String localName,
                                          String value)
创建一个新 Attribute。

参数:
prefix - 此属性的前缀,不可以为 null
namespaceURI - 被设置为此值的属性值,不可以为 null
localName - 属性 XML 名称的本地名称,localName 不可以为 null
value - 要设置的属性值,不可以为 null
返回:
带有指定值的 Attribute

createAttribute

public abstract Attribute createAttribute(String localName,
                                          String value)
创建一个新 Attribute。

参数:
localName - 属性 XML 名称的本地名称,localName 不可以为 null
value - 要设置的属性值,不可以为 null
返回:
带有指定值的 Attribute

createAttribute

public abstract Attribute createAttribute(QName name,
                                          String value)
创建一个新 Attribute。

参数:
name - 属性的限定名,不可以为 null
value - 要设置的属性值,不可以为 unll
返回:
带有指定值的 Attribute

createNamespace

public abstract Namespace createNamespace(String namespaceURI)
创建一个新的默认 Namespace。

参数:
namespaceURI - 默认名称空间 URI
返回:
带有指定值的 Namespace

createNamespace

public abstract Namespace createNamespace(String prefix,
                                          String namespaceUri)
创建一个新的 Namespace。

参数:
prefix - 此名称空间的前缀,不可以为 null
namespaceUri - 被设置为此值的属性值,不可以为 null
返回:
带有指定值的 Namespace

createStartElement

public abstract StartElement createStartElement(QName name,
                                                Iterator attributes,
                                                Iterator namespaces)
创建一个新 StartElement。通过传入一个迭代 Namespace 接口集合的 Iterator,可以将名称空间添加到此 StartElement。通过传入一个迭代 Attribute 接口集合的 Iterator,可以将属性添加到此 StartElement。

参数:
name - 属性的限定名,不可以为 null
attributes - 要添加到新 StartElement 的可选无序对象集合,这些对象均实现 Attribute,该参数可以为 null
namespaces - 要添加到新 StartElement 的可选无序对象集合,这些对象均实现 Namespace,该参数可以为 null
返回:
请求的 StartElement 的实例

createStartElement

public abstract StartElement createStartElement(String prefix,
                                                String namespaceUri,
                                                String localName)
创建一个新 StartElement。此方法默认 NamespaceContext 为空 NamespaceContext。查询此事件的名称空间或属性将导致返回空的迭代器。

参数:
namespaceUri - 新 StartElement QName 的 URI
localName - 新 StartElement QName 的本地名称
prefix - 新 StartElement QName 的前缀
返回:
请求的 StartElement 的实例

createStartElement

public abstract StartElement createStartElement(String prefix,
                                                String namespaceUri,
                                                String localName,
                                                Iterator attributes,
                                                Iterator namespaces)
创建一个新 StartElement。通过传入一个迭代 Namespace 接口集合的 Iterator,可以将名称空间添加到此 StartElement。通过传入一个迭代 Attribute 接口集合的 Iterator,可以将属性添加到此 StartElement。

参数:
namespaceUri - 新 StartElement QName 的 URI
localName - 新 StartElement QName 的本地名称
prefix - 新 StartElement QName 的前缀
attributes - 要添加到新 StartElement 的无序对象集合,这些对象均实现 Attribute
namespaces - 要添加到新 StartElement 的无序对象集合,这些对象均实现 Namespace
返回:
请求的 StartElement 的实例

createStartElement

public abstract StartElement createStartElement(String prefix,
                                                String namespaceUri,
                                                String localName,
                                                Iterator attributes,
                                                Iterator namespaces,
                                                NamespaceContext context)
创建一个新 StartElement。通过传入一个迭代 Namespace 接口集合的 Iterator,可以将名称空间添加到此 StartElement。通过传入一个迭代 Attribute 接口集合的 Iterator,可以将属性添加到此 StartElement。

参数:
namespaceUri - 新 StartElement QName 的 URI
localName - 新 StartElement QName 的本地名称
prefix - 新 StartElemente QName 的前缀
attributes - 要添加到新 StartElement 的无序对象集合,这些对象均实现 Attribute,可以为 null
namespaces - 要添加到新 StartElement 的无序对象集合,这些对象均实现 Namespace,可以为 null
context - 此元素的名称空间上下文
返回:
请求的 StartElement 的实例

createEndElement

public abstract EndElement createEndElement(QName name,
                                            Iterator namespaces)
创建一个新 EndElement。

参数:
name - EndElement 的限定名
namespaces - 超出范围的无序对象集合,这些对象均实现 Namespace,该参数可以为 null
返回:
请求的 EndElement 的实例

createEndElement

public abstract EndElement createEndElement(String prefix,
                                            String namespaceUri,
                                            String localName)
创建一个新 EndElement。

参数:
namespaceUri - 新 StartElement QName 的 URI
localName - 新 StartElement QName 的本地名称
prefix - 新 StartElement QName 的前缀
返回:
请求的 EndElement 的实例

createEndElement

public abstract EndElement createEndElement(String prefix,
                                            String namespaceUri,
                                            String localName,
                                            Iterator namespaces)
创建一个新 EndElement。

参数:
namespaceUri - 新 StartElement QName 的 URI
localName - 新 StartElement QName 的本地名称
prefix - 新 StartElement QName 的前缀
namespaces - 超出范围的无序对象集合,这些对象均实现 Namespace,该参数可以为 null
返回:
请求的 EndElement 的实例

createCharacters

public abstract Characters createCharacters(String content)
创建一个 Character 事件,此方法不检查内容是否全部为空白。使用 #createSpace(String) 创建一个空间事件。

参数:
content - 要创建的字符串
返回:
一个 Character 事件

createCData

public abstract Characters createCData(String content)
创建一个 CData 标记设置为 true 的 Character 事件。

参数:
content - 要创建的字符串
返回:
一个 Character 事件

createSpace

public abstract Characters createSpace(String content)
创建一个 isSpace 标记设置为 true 的 Character 事件。

参数:
content - 要创建的空间的内容
返回:
一个 Character 事件

createIgnorableSpace

public abstract Characters createIgnorableSpace(String content)
创建一个可忽略的空间。

参数:
content - 要创建的空间
返回:
一个 Character 事件

createStartDocument

public abstract StartDocument createStartDocument()
创建一个 StartDocument 事件的新实例。

返回:
一个 StartDocument 事件

createStartDocument

public abstract StartDocument createStartDocument(String encoding,
                                                  String version,
                                                  boolean standalone)
创建一个 StartDocument 事件的新实例。

参数:
encoding - 编码样式
version - XML 的版本
standalone - 独立的状态,可以设置为 "true" 或 "false"
返回:
一个 StartDocument 事件

createStartDocument

public abstract StartDocument createStartDocument(String encoding,
                                                  String version)
创建一个 StartDocument 事件的新实例。

参数:
encoding - 编码样式
XML - 的版本
返回:
一个 StartDocument 事件

createStartDocument

public abstract StartDocument createStartDocument(String encoding)
创建一个 StartDocument 事件的新实例。

参数:
encoding - 编码样式
返回:
一个 StartDocument 事件

createEndDocument

public abstract EndDocument createEndDocument()
创建一个 EndDocument 事件的新实例。

返回:
一个 EndDocument 事件

createEntityReference

public abstract EntityReference createEntityReference(String name,
                                                      EntityDeclaration declaration)
创建一个 EntityReference 事件的新实例。

参数:
name - 引用的名称
declaration - 事件的声明
返回:
一个 EntityReference 事件

createComment

public abstract Comment createComment(String text)
创建一个注释。

参数:
text - Comment 事件的注释文本

createProcessingInstruction

public abstract ProcessingInstruction createProcessingInstruction(String target,
                                                                  String data)
创建一个处理指令。

参数:
target - 处理指令的目标
data - 处理指令的文本
返回:
一个 ProcessingInstruction 事件

createDTD

public abstract DTD createDTD(String dtd)
创建一个文档类型定义事件。此字符串包含与 XML 1.0 规范中的 doctypedecl 相匹配的整个文档类型声明。

参数:
dtd - 文档类型定义的文本
返回:
一个 DTD 事件

JavaTM Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策