XMLEventFactory (Java EE 5)

This interface defines a utility class for creating instances of XMLEvents

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

See Also:

StartElement, EndElement, ProcessingInstruction, Comment, Characters, StartDocument, EndDocument, DTD

protected XMLEventFactory()

英文文档：

XMLEventFactory

protected XMLEventFactory()

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

Throws

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

英文文档：

newInstance

public static XMLEventFactory newInstance()
                                   throws FactoryConfigurationError

Create a new instance of the factory

Throws:

FactoryConfigurationError - if an instance of this factory cannot be loaded

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

factoryId	要查找的工厂的名称，与属性名称相同
classLoader	要使用的类加载器
return	工厂实现
Throws	FactoryConfigurationError: 如果无法加载此工厂的实例

英文文档：

newInstance

public static XMLEventFactory newInstance(String factoryId,
                                          ClassLoader classLoader)
                                   throws FactoryConfigurationError

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

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

location

要对每个创建的事件设置的位置

英文文档：

setLocation

public abstract void setLocation(Location location)

This method allows setting of the Location on each event that is created by this factory. The values are copied by value into the events created by this factory. To reset the location information set the location to null.

Parameters:

location - the location to set on each event created

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

prefix	此属性的前缀，不可以为 null
namespaceURI	被设置为此值的属性值，不可以为 null
localName	属性 XML 名称的本地名称，localName 不可以为 null
value	要设置的属性值，不可以为 unll
return	带有指定值的 Attribute

英文文档：

createAttribute

public abstract Attribute createAttribute(String prefix,
                                          String namespaceURI,
                                          String localName,
                                          String value)

Create a new Attribute

Parameters:

prefix - the prefix of this attribute, may not be null

namespaceURI - the attribute value is set to this value, may not be null

localName - the local name of the XML name of the attribute, localName cannot be null

value - the attribute value to set, may not be null

Returns:

the Attribute with specified values

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

localName	属性 XML 名称的本地名称，localName 不可以为 null
value	要设置的属性值，不可以为 unll
return	带有指定值的 Attribute

英文文档：

createAttribute

public abstract Attribute createAttribute(String localName,
                                          String value)

Create a new Attribute

Parameters:

localName - the local name of the XML name of the attribute, localName cannot be null

value - the attribute value to set, may not be null

Returns:

the Attribute with specified values

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

name	属性的限定名，不可以为 null
value	要设置的属性值，不可以为 unll
return	带有指定值的 Attribute

英文文档：

createAttribute

public abstract Attribute createAttribute(QName name,
                                          String value)

Create a new Attribute

Parameters:

name - the qualified name of the attribute, may not be null

value - the attribute value to set, may not be null

Returns:

the Attribute with specified values

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

namespaceURI	默认名称空间 URI
return	带有指定值的 Namespace

英文文档：

createNamespace

public abstract Namespace createNamespace(String namespaceURI)

Create a new default Namespace

Parameters:

namespaceURI - the default namespace uri

Returns:

the Namespace with the specified value

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

prefix	此名称空间的前缀，不可以为 null
namespaceUri	被设置为此值的属性值，不可以为 null
return	带有指定值的 Namespace

英文文档：

createNamespace

public abstract Namespace createNamespace(String prefix,
                                          String namespaceUri)

Create a new Namespace

Parameters:

prefix - the prefix of this namespace, may not be null

namespaceUri - the attribute value is set to this value, may not be null

Returns:

the Namespace with the specified values

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

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

英文文档：

createStartElement

public abstract StartElement createStartElement(QName name,
                                                Iterator attributes,
                                                Iterator namespaces)

Create a new StartElement. Namespaces can be added to this StartElement by passing in an Iterator that walks over a set of Namespace interfaces. Attributes can be added to this StartElement by passing an iterator that walks over a set of Attribute interfaces.

Parameters:

name - the qualified name of the attribute, may not be null

attributes - an optional unordered set of objects that implement Attribute to add to the new StartElement, may be null

namespaces - an optional unordered set of objects that implement Namespace to add to the new StartElement, may be null

Returns:

an instance of the requested StartElement

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

namespaceUri	新 StartElement QName 的 URI
localName	新 StartElement QName 的本地名称
prefix	新 StartElemente QName 的前缀
return	请求的 StartElement 的实例

英文文档：

createStartElement

public abstract StartElement createStartElement(String prefix,
                                                String namespaceUri,
                                                String localName)

Create a new StartElement. This defaults the NamespaceContext to an empty NamespaceContext. Querying this event for its namespaces or attributes will result in an empty iterator being returned.

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

Returns:

an instance of the requested StartElement

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

namespaceUri	新 StartElement QName 的 URI
localName	新 StartElement QName 的本地名称
prefix	新 StartElemente QName 的前缀
attributes	要添加到新 StartElement 的无序对象集合，这些对象均实现 Attribute
namespaces	要添加到新 StartElement 的无序对象集合，这些对象均实现 Namespace
return	请求的 StartElement 的实例

英文文档：

createStartElement

public abstract StartElement createStartElement(String prefix,
                                                String namespaceUri,
                                                String localName,
                                                Iterator attributes,
                                                Iterator namespaces)

Create a new StartElement. Namespaces can be added to this StartElement by passing in an Iterator that walks over a set of Namespace interfaces. Attributes can be added to this StartElement by passing an iterator that walks over a set of Attribute interfaces.

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

attributes - an unordered set of objects that implement Attribute to add to the new StartElement

namespaces - an unordered set of objects that implement Namespace to add to the new StartElement

Returns:

an instance of the requested StartElement

abstract public StartElement createStartElement(String prefix, String namespaceUri, String localName, java.util.Iterator<E> attributes, java.util.Iterator<E> namespaces, javax.xml.namespace.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	此元素的名称空间上下文
return	请求的 StartElement 的实例

英文文档：

createStartElement

public abstract StartElement createStartElement(String prefix,
                                                String namespaceUri,
                                                String localName,
                                                Iterator attributes,
                                                Iterator namespaces,
                                                NamespaceContext context)

Create a new StartElement. Namespaces can be added to this StartElement by passing in an Iterator that walks over a set of Namespace interfaces. Attributes can be added to this StartElement by passing an iterator that walks over a set of Attribute interfaces.

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

attributes - an unordered set of objects that implement Attribute to add to the new StartElement, may be null

namespaces - an unordered set of objects that implement Namespace to add to the new StartElement, may be null

context - the namespace context of this element

Returns:

an instance of the requested StartElement

abstract public EndElement createEndElement(javax.xml.namespace.QName name, java.util.Iterator<E> namespaces)
创建一个新 EndElement。

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

英文文档：

createEndElement

public abstract EndElement createEndElement(QName name,
                                            Iterator namespaces)

Create a new EndElement

Parameters:

name - the qualified name of the EndElement

namespaces - an optional unordered set of objects that implement Namespace that have gone out of scope, may be null

Returns:

an instance of the requested EndElement

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

namespaceUri	新 StartElement QName 的 URI
localName	新 StartElement QName 的本地名称
prefix	新 StartElemente QName 的前缀
return	请求的 EndElement 的实例

英文文档：

createEndElement

public abstract EndElement createEndElement(String prefix,
                                            String namespaceUri,
                                            String localName)

Create a new EndElement

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

Returns:

an instance of the requested EndElement

abstract public EndElement createEndElement(String prefix, String namespaceUri, String localName, java.util.Iterator<E> namespaces)
创建一个新 EndElement。

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

英文文档：

createEndElement

public abstract EndElement createEndElement(String prefix,
                                            String namespaceUri,
                                            String localName,
                                            Iterator namespaces)

Create a new EndElement

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

namespaces - an unordered set of objects that implement Namespace that have gone out of scope, may be null

Returns:

an instance of the requested EndElement

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

content	要创建的字符串
return	一个 Character 事件

英文文档：

createCharacters

public abstract Characters createCharacters(String content)

Create a Characters event, this method does not check if the content is all whitespace. To create a space event use #createSpace(String)

Parameters:

content - the string to create

Returns:

a Characters event

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

content	要创建的字符串
return	一个 Character 事件

英文文档：

createCData

public abstract Characters createCData(String content)

Create a Characters event with the CData flag set to true

Parameters:

content - the string to create

Returns:

a Characters event

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

content	要创建的空间的内容
return	一个 Character 事件

英文文档：

createSpace

public abstract Characters createSpace(String content)

Create a Characters event with the isSpace flag set to true

Parameters:

content - the content of the space to create

Returns:

a Characters event

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

content	要创建的空间
return	一个 Character 事件

英文文档：

createIgnorableSpace

public abstract Characters createIgnorableSpace(String content)

Create an ignorable space

Parameters:

content - the space to create

Returns:

a Characters event

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

return

一个 StartDocument 事件

英文文档：

createStartDocument

public abstract StartDocument createStartDocument()

Creates a new instance of a StartDocument event

Returns:

a StartDocument event

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

encoding	编码样式
version	的版本
standalone	独立的状态，可以设置为 "true" 或 "false"
return	一个 StartDocument 事件

英文文档：

createStartDocument

public abstract StartDocument createStartDocument(String encoding,
                                                  String version,
                                                  boolean standalone)

Creates a new instance of a StartDocument event

Parameters:

encoding - the encoding style

version - the XML version

standalone - the status of standalone may be set to "true" or "false"

Returns:

a StartDocument event

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

encoding	编码样式
version	的版本
return	一个 StartDocument 事件

英文文档：

createStartDocument

public abstract StartDocument createStartDocument(String encoding,
                                                  String version)

Creates a new instance of a StartDocument event

Parameters:

encoding - the encoding style

version - the XML version

Returns:

a StartDocument event

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

encoding	编码样式
return	一个 StartDocument 事件

英文文档：

createStartDocument

public abstract StartDocument createStartDocument(String encoding)

Creates a new instance of a StartDocument event

Parameters:

encoding - the encoding style

Returns:

a StartDocument event

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

return

一个 EndDocument 事件

英文文档：

createEndDocument

public abstract EndDocument createEndDocument()

Creates a new instance of an EndDocument event

Returns:

an EndDocument event

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

name	引用的名称
declaration	事件的声明
return	一个 EntityReference 事件

英文文档：

createEntityReference

public abstract EntityReference createEntityReference(String name,
                                                      EntityDeclaration declaration)

Creates a new instance of a EntityReference event

Parameters:

name - The name of the reference

declaration - the declaration for the event

Returns:

an EntityReference event

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

text	Comment 事件的注释文本

英文文档：

createComment

public abstract Comment createComment(String text)

Create a comment

Parameters:

text - The text of the comment a Comment event

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

target	处理指令的目标
data	处理指令的文本
return	一个 ProcessingInstruction 事件

英文文档：

createProcessingInstruction

public abstract ProcessingInstruction createProcessingInstruction(String target,
                                                                  String data)

Create a processing instruction

Parameters:

target - The target of the processing instruction

data - The text of the processing instruction

Returns:

a ProcessingInstruction event

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

dtd	文档类型定义的文本
return	一个 DTD 事件

英文文档：

createDTD

public abstract DTD createDTD(String dtd)

Create a document type definition event This string contains the entire document type declaration that matches the doctypedecl in the XML 1.0 specification

Parameters:

dtd - the text of the document type definition

Returns:

a DTD event

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.