XMLStreamWriter (Java EE 5 SDK)

Java

previous page next page
概述  软件包   类  树  已过时  索引  帮助 
Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.
 上一个类   下一个 CLASS 框架    无框架    
摘要: 嵌套 | 字段 | 构造器 | 方法 详细信息: 字段 | 构造器 | 方法

javax.xml.stream Interface XMLStreamWriter

public interface XMLStreamWriter

The XMLStreamWriter interface specifies how to write XML. The XMLStreamWriter does not perform well formedness checking on its input. However the writeCharacters method is required to escape & , < and > For attribute values the writeAttribute method will escape the above characters plus " to ensure that all character content and attribute values are well formed. Each NAMESPACE and ATTRIBUTE must be individually written. If javax.xml.stream.isPrefixDefaulting is set to false it is a fatal error if an element is written with namespace URI that has not been bound to a prefix. If javax.xml.stream.isPrefixDefaulting is set to true the XMLStreamWriter implementation must write a prefix for each unbound URI that it encounters in the current scope.

版本:
1.0
作者:
Copyright (c) 2003 by BEA Systems. All Rights Reserved.
另请参见:
XMLOutputFactory, XMLStreamReader

方法摘要
 void close()
          Close this writer and free any resources associated with the writer.
 void flush()
          Write any cached data to the underlying output mechanism.
 NamespaceContext getNamespaceContext()
          Returns the current namespace context.
 String getPrefix(String uri)
          Gets the prefix the uri is bound to
 Object getProperty(String name)
          Get the value of a feature/property from the underlying implementation
 void setDefaultNamespace(String uri)
          Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair.
 void setNamespaceContext(NamespaceContext context)
          Sets the current namespace context for prefix and uri bindings.
 void setPrefix(String prefix, String uri)
          Sets the prefix the uri is bound to.
 void writeAttribute(String localName, String value)
          Writes an attribute to the output stream without a prefix.
 void writeAttribute(String namespaceURI, String localName, String value)
          Writes an attribute to the output stream
 void writeAttribute(String prefix, String namespaceURI, String localName, String value)
          Writes an attribute to the output stream
 void writeCData(String data)
          Writes a CData section
 void writeCharacters(char[] text, int start, int len)
          Write text to the output
 void writeCharacters(String text)
          Write text to the output
 void writeComment(String data)
          Writes an xml comment with the data enclosed
 void writeDefaultNamespace(String namespaceURI)
          Writes the default namespace to the stream
 void writeDTD(String dtd)
          Write a DTD section.
 void writeEmptyElement(String localName)
          Writes an empty element tag to the output
 void writeEmptyElement(String namespaceURI, String localName)
          Writes an empty element tag to the output
 void writeEmptyElement(String prefix, String localName, String namespaceURI)
          Writes an empty element tag to the output
 void writeEndDocument()
          Closes any start tags and writes corresponding end tags.
 void writeEndElement()
          Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.
 void writeEntityRef(String name)
          Writes an entity reference
 void writeNamespace(String prefix, String namespaceURI)
          Writes a namespace to the output stream If the prefix argument to this method is the empty string, "xmlns", or null this method will delegate to writeDefaultNamespace
 void writeProcessingInstruction(String target)
          Writes a processing instruction
 void writeProcessingInstruction(String target, String data)
          Writes a processing instruction
 void writeStartDocument()
          Write the XML Declaration.
 void writeStartDocument(String version)
          Write the XML Declaration.
 void writeStartDocument(String encoding, String version)
          Write the XML Declaration.
 void writeStartElement(String localName)
          Writes a start tag to the output.
 void writeStartElement(String namespaceURI, String localName)
          Writes a start tag to the output
 void writeStartElement(String prefix, String localName, String namespaceURI)
          Writes a start tag to the output
 

方法详细信息

writeStartElement

void writeStartElement(String localName)
                       throws XMLStreamException
Writes a start tag to the output. All writeStartElement methods open a new scope in the internal namespace context. Writing the corresponding EndElement causes the scope to be closed.

参数:
localName - local name of the tag, may not be null
抛出异常:
XMLStreamException

writeStartElement

void writeStartElement(String namespaceURI,
                       String localName)
                       throws XMLStreamException
Writes a start tag to the output

参数:
namespaceURI - the namespaceURI of the prefix to use, may not be null
localName - local name of the tag, may not be null
抛出异常:
XMLStreamException - if the namespace URI has not been bound to a prefix and javax.xml.stream.isPrefixDefaulting has not been set to true

writeStartElement

void writeStartElement(String prefix,
                       String localName,
                       String namespaceURI)
                       throws XMLStreamException
Writes a start tag to the output

参数:
localName - local name of the tag, may not be null
prefix - the prefix of the tag, may not be null
namespaceURI - the uri to bind the prefix to, may not be null
抛出异常:
XMLStreamException

writeEmptyElement

void writeEmptyElement(String namespaceURI,
                       String localName)
                       throws XMLStreamException
Writes an empty element tag to the output

参数:
namespaceURI - the uri to bind the tag to, may not be null
localName - local name of the tag, may not be null
抛出异常:
XMLStreamException - if the namespace URI has not been bound to a prefix and javax.xml.stream.isPrefixDefaulting has not been set to true

writeEmptyElement

void writeEmptyElement(String prefix,
                       String localName,
                       String namespaceURI)
                       throws XMLStreamException
Writes an empty element tag to the output

参数:
prefix - the prefix of the tag, may not be null
localName - local name of the tag, may not be null
namespaceURI - the uri to bind the tag to, may not be null
抛出异常:
XMLStreamException

writeEmptyElement

void writeEmptyElement(String localName)
                       throws XMLStreamException
Writes an empty element tag to the output

参数:
localName - local name of the tag, may not be null
抛出异常:
XMLStreamException

writeEndElement

void writeEndElement()
                     throws XMLStreamException
Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.

抛出异常:
XMLStreamException

writeEndDocument

void writeEndDocument()
                      throws XMLStreamException
Closes any start tags and writes corresponding end tags.

抛出异常:
XMLStreamException

close

void close()
           throws XMLStreamException
Close this writer and free any resources associated with the writer. This must not close the underlying output stream.

抛出异常:
XMLStreamException

flush

void flush()
           throws XMLStreamException
Write any cached data to the underlying output mechanism.

抛出异常:
XMLStreamException

writeAttribute

void writeAttribute(String localName,
                    String value)
                    throws XMLStreamException
Writes an attribute to the output stream without a prefix.

参数:
localName - the local name of the attribute
value - the value of the attribute
抛出异常:
IllegalStateException - if the current state does not allow Attribute writing
XMLStreamException

writeAttribute

void writeAttribute(String prefix,
                    String namespaceURI,
                    String localName,
                    String value)
                    throws XMLStreamException
Writes an attribute to the output stream

参数:
prefix - the prefix for this attribute
namespaceURI - the uri of the prefix for this attribute
localName - the local name of the attribute
value - the value of the attribute
抛出异常:
IllegalStateException - if the current state does not allow Attribute writing
XMLStreamException - if the namespace URI has not been bound to a prefix and javax.xml.stream.isPrefixDefaulting has not been set to true

writeAttribute

void writeAttribute(String namespaceURI,
                    String localName,
                    String value)
                    throws XMLStreamException
Writes an attribute to the output stream

参数:
namespaceURI - the uri of the prefix for this attribute
localName - the local name of the attribute
value - the value of the attribute
抛出异常:
IllegalStateException - if the current state does not allow Attribute writing
XMLStreamException - if the namespace URI has not been bound to a prefix and javax.xml.stream.isPrefixDefaulting has not been set to true

writeNamespace

void writeNamespace(String prefix,
                    String namespaceURI)
                    throws XMLStreamException
Writes a namespace to the output stream If the prefix argument to this method is the empty string, "xmlns", or null this method will delegate to writeDefaultNamespace

参数:
prefix - the prefix to bind this namespace to
namespaceURI - the uri to bind the prefix to
抛出异常:
IllegalStateException - if the current state does not allow Namespace writing
XMLStreamException

writeDefaultNamespace

void writeDefaultNamespace(String namespaceURI)
                           throws XMLStreamException
Writes the default namespace to the stream

参数:
namespaceURI - the uri to bind the default namespace to
抛出异常:
IllegalStateException - if the current state does not allow Namespace writing
XMLStreamException

writeComment

void writeComment(String data)
                  throws XMLStreamException
Writes an xml comment with the data enclosed

参数:
data - the data contained in the comment, may be null
抛出异常:
XMLStreamException

writeProcessingInstruction

void writeProcessingInstruction(String target)
                                throws XMLStreamException
Writes a processing instruction

参数:
target - the target of the processing instruction, may not be null
抛出异常:
XMLStreamException

writeProcessingInstruction

void writeProcessingInstruction(String target,
                                String data)
                                throws XMLStreamException
Writes a processing instruction

参数:
target - the target of the processing instruction, may not be null
data - the data contained in the processing instruction, may not be null
抛出异常:
XMLStreamException

writeCData

void writeCData(String data)
                throws XMLStreamException
Writes a CData section

参数:
data - the data contained in the CData Section, may not be null
抛出异常:
XMLStreamException

writeDTD

void writeDTD(String dtd)
              throws XMLStreamException
Write a DTD section. This string represents the entire doctypedecl production from the XML 1.0 specification.

参数:
dtd - the DTD to be written
抛出异常:
XMLStreamException

writeEntityRef

void writeEntityRef(String name)
                    throws XMLStreamException
Writes an entity reference

参数:
name - the name of the entity
抛出异常:
XMLStreamException

writeStartDocument

void writeStartDocument()
                        throws XMLStreamException
Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8

抛出异常:
XMLStreamException

writeStartDocument

void writeStartDocument(String version)
                        throws XMLStreamException
Write the XML Declaration. Defaults the XML version to 1.0

参数:
version - version of the xml document
抛出异常:
XMLStreamException

writeStartDocument

void writeStartDocument(String encoding,
                        String version)
                        throws XMLStreamException
Write the XML Declaration. Note that the encoding parameter does not set the actual encoding of the underlying output. That must be set when the instance of the XMLStreamWriter is created using the XMLOutputFactory

参数:
encoding - encoding of the xml declaration
version - version of the xml document
抛出异常:
XMLStreamException

writeCharacters

void writeCharacters(String text)
                     throws XMLStreamException
Write text to the output

参数:
text - the value to write
抛出异常:
XMLStreamException

writeCharacters

void writeCharacters(char[] text,
                     int start,
                     int len)
                     throws XMLStreamException
Write text to the output

参数:
text - the value to write
start - the starting position in the array
len - the number of characters to write
抛出异常:
XMLStreamException

getPrefix

String getPrefix(String uri)
                 throws XMLStreamException
Gets the prefix the uri is bound to

返回:
the prefix or null
抛出异常:
XMLStreamException

setPrefix

void setPrefix(String prefix,
               String uri)
               throws XMLStreamException
Sets the prefix the uri is bound to. This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the prefix is bound in the root scope.

参数:
prefix - the prefix to bind to the uri, may not be null
uri - the uri to bind to the prefix, may be null
抛出异常:
XMLStreamException

setDefaultNamespace

void setDefaultNamespace(String uri)
                         throws XMLStreamException
Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the uri is bound in the root scope.

参数:
uri - the uri to bind to the default namespace, may be null
抛出异常:
XMLStreamException

setNamespaceContext

void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException
Sets the current namespace context for prefix and uri bindings. This context becomes the root namespace context for writing and will replace the current root namespace context. Subsequent calls to setPrefix and setDefaultNamespace will bind namespaces using the context passed to the method as the root context for resolving namespaces. This method may only be called once at the start of the document. It does not cause the namespaces to be declared. If a namespace URI to prefix mapping is found in the namespace context it is treated as declared and the prefix may be used by the StreamWriter.

参数:
context - the namespace context to use for this writer, may not be null
抛出异常:
XMLStreamException

getNamespaceContext

NamespaceContext getNamespaceContext()
Returns the current namespace context.

返回:
the current NamespaceContext

getProperty

Object getProperty(String name)
                   throws IllegalArgumentException
Get the value of a feature/property from the underlying implementation

参数:
name - The name of the property, may not be null
返回:
The value of the property
抛出异常:
IllegalArgumentException - if the property is not supported
NullPointerException - if the name is null
概述  软件包   类  树  已过时  索引  帮助 
Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.
 上一个类   下一个 CLASS 框架    无框架    
摘要: 嵌套 | 字段 | 构造器 | 方法 详细信息: 字段 | 构造器 | 方法
提交错误或意见

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。深圳电信培训中心.徐海蛟老师教学参考.

previous page start next page