|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractMap
com.sun.xml.stream.writers.XMLStreamWriterImpl
public final class XMLStreamWriterImpl
This class implements a StAX XMLStreamWriter. It extends
AbstractMap
in order to support a getter for
implementation-specific properties. For example, you can get
the underlying OutputStream
by casting an instance
of this class to Map
and calling
getProperty(OUTPUTSTREAM_PROPERTY)
.
Nested Class Summary | |
---|---|
protected class |
XMLStreamWriterImpl.ElementStack
|
Nested classes/interfaces inherited from class java.util.AbstractMap |
---|
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V> |
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Field Summary | |
---|---|
static java.lang.String |
CLOSE_EMPTY_ELEMENT
|
static char |
CLOSE_END_TAG
|
static char |
CLOSE_START_TAG
|
static java.lang.String |
DEFAULT_ENCODING
|
static java.lang.String |
DEFAULT_XML_VERSION
|
static java.lang.String |
DEFAULT_XMLDECL
|
static java.lang.String |
END_CDATA
|
static java.lang.String |
END_COMMENT
|
static java.lang.String |
OPEN_END_TAG
|
static char |
OPEN_START_TAG
|
static java.lang.String |
OUTPUTSTREAM_PROPERTY
|
static java.lang.String |
SPACE
|
static java.lang.String |
START_CDATA
|
static java.lang.String |
START_COMMENT
|
static java.lang.String |
UTF_8
|
Constructor Summary | |
---|---|
XMLStreamWriterImpl(java.io.OutputStream outputStream,
PropertyManager props)
Creates a new instance of XMLStreamWriterImpl. |
|
XMLStreamWriterImpl(java.io.OutputStream outputStream,
java.lang.String encoding,
PropertyManager props)
Creates a new instance of XMLStreamWriterImpl. |
|
XMLStreamWriterImpl(javax.xml.transform.stream.StreamResult sr,
java.lang.String encoding,
PropertyManager props)
Creates a new instance of XMLStreamWriterImpl using a StreamResult. |
|
XMLStreamWriterImpl(java.io.Writer writer,
PropertyManager props)
Creates a new instance of XMLStreamWriterImpl using a Writer. |
Method Summary | |
---|---|
boolean |
canReuse()
Can this instance be reused |
void |
close()
Close this XMLStreamWriter by closing underlying writer. |
boolean |
containsKey(java.lang.Object key)
|
java.util.Set |
entrySet()
|
boolean |
equals(java.lang.Object obj)
Overrides the method defined in AbstractMap This is required to satisfy the contract for hashCode. |
void |
flush()
Flush this XMLStreamWriter by flushin underlying writer. |
java.lang.Object |
get(java.lang.Object key)
Returns the value associated to an implementation-specific property. |
boolean |
getEscapeCharacters()
|
javax.xml.namespace.NamespaceContext |
getNamespaceContext()
Return NamespaceContext being used by the writer. |
java.lang.String |
getPrefix(java.lang.String uri)
Return a prefix associated with specified uri, or null if the uri is unknown. |
java.lang.Object |
getProperty(java.lang.String str)
Returns value associated with the specified property name. |
int |
hashCode()
Overrides the method defined in AbstractMap This is required by the toString() method |
boolean |
isEmpty()
|
protected void |
repair()
Correct's namespaces as per requirements of isReparisingNamespace property. |
void |
reset()
Reset this instance so that it can be re-used. |
void |
setDefaultNamespace(java.lang.String uri)
Set the specified URI as default namespace in the current namespace context. |
void |
setEscapeCharacters(boolean escape)
|
void |
setNamespaceContext(javax.xml.namespace.NamespaceContext namespaceContext)
Sets the current NamespaceContext for prefix and uri bindings. |
void |
setOutput(javax.xml.transform.stream.StreamResult sr,
java.lang.String encoding)
Use a StreamResult to initialize the output for this XMLStreamWriter. |
void |
setPrefix(java.lang.String prefix,
java.lang.String uri)
Sets the prefix the uri is bound to. |
int |
size()
|
java.lang.String |
toString()
Overrides the method defined in AbstractMap which is not completely implemented. |
void |
writeAttribute(java.lang.String localName,
java.lang.String value)
|
void |
writeAttribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value)
|
void |
writeAttribute(java.lang.String prefix,
java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value)
|
void |
writeCData(java.lang.String cdata)
|
void |
writeCharacters(char[] data,
int start,
int len)
|
void |
writeCharacters(java.lang.String data)
|
void |
writeComment(java.lang.String comment)
|
void |
writeDefaultNamespace(java.lang.String namespaceURI)
|
void |
writeDTD(java.lang.String dtd)
|
void |
writeEmptyElement(java.lang.String localName)
|
void |
writeEmptyElement(java.lang.String namespaceURI,
java.lang.String localName)
|
void |
writeEmptyElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI)
|
void |
writeEndDocument()
|
void |
writeEndElement()
|
void |
writeEntityRef(java.lang.String refName)
|
void |
writeNamespace(java.lang.String prefix,
java.lang.String namespaceURI)
Write a Namespace declaration. |
void |
writeProcessingInstruction(java.lang.String target)
|
void |
writeProcessingInstruction(java.lang.String target,
java.lang.String data)
|
void |
writeStartDocument()
|
void |
writeStartDocument(java.lang.String version)
|
void |
writeStartDocument(java.lang.String encoding,
java.lang.String version)
|
void |
writeStartElement(java.lang.String localName)
|
void |
writeStartElement(java.lang.String namespaceURI,
java.lang.String localName)
|
void |
writeStartElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI)
|
Methods inherited from class java.util.AbstractMap |
---|
clear, clone, containsValue, keySet, put, putAll, remove, values |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String START_COMMENT
public static final java.lang.String END_COMMENT
public static final java.lang.String DEFAULT_ENCODING
public static final java.lang.String DEFAULT_XMLDECL
public static final java.lang.String DEFAULT_XML_VERSION
public static final char CLOSE_START_TAG
public static final char OPEN_START_TAG
public static final java.lang.String OPEN_END_TAG
public static final char CLOSE_END_TAG
public static final java.lang.String START_CDATA
public static final java.lang.String END_CDATA
public static final java.lang.String CLOSE_EMPTY_ELEMENT
public static final java.lang.String SPACE
public static final java.lang.String UTF_8
public static final java.lang.String OUTPUTSTREAM_PROPERTY
Constructor Detail |
---|
public XMLStreamWriterImpl(java.io.OutputStream outputStream, PropertyManager props) throws java.io.IOException
outputStream
- Underlying stream to write the bytes toprops
- Properties used by this writer
java.io.IOException
public XMLStreamWriterImpl(java.io.OutputStream outputStream, java.lang.String encoding, PropertyManager props) throws java.io.IOException
outputStream
- Underlying stream to write the bytesencoding
- Encoding used to convert chars into bytesprops
- Properties used by this writer
java.io.IOException
public XMLStreamWriterImpl(java.io.Writer writer, PropertyManager props) throws java.io.IOException
writer
- Underlying writer to which chars are writtenprops
- Properties used by this writer
java.io.IOException
public XMLStreamWriterImpl(javax.xml.transform.stream.StreamResult sr, java.lang.String encoding, PropertyManager props) throws java.io.IOException
writer
- Underlying writer to which chars are writtenprops
- Properties used by this writer
java.io.IOException
Method Detail |
---|
public void reset()
setOutput(StreamResult, encoding)
must
be called after this one.
public void setOutput(javax.xml.transform.stream.StreamResult sr, java.lang.String encoding) throws java.io.IOException
sr
- StreamResult encapsulating output informationencoding
- Encoding to be used except when a Writer is available
java.io.IOException
public boolean canReuse()
public void setEscapeCharacters(boolean escape)
public boolean getEscapeCharacters()
public void close() throws javax.xml.stream.XMLStreamException
close
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void flush() throws javax.xml.stream.XMLStreamException
flush
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public javax.xml.namespace.NamespaceContext getNamespaceContext()
NamespaceContext
being used by the writer.
getNamespaceContext
in interface javax.xml.stream.XMLStreamWriter
public java.lang.String getPrefix(java.lang.String uri) throws javax.xml.stream.XMLStreamException
getPrefix
in interface javax.xml.stream.XMLStreamWriter
uri
- The namespace uri
javax.xml.stream.XMLStreamException
- if uri specified is "" or nullpublic java.lang.Object getProperty(java.lang.String str) throws java.lang.IllegalArgumentException
getProperty
in interface javax.xml.stream.XMLStreamWriter
str
- Property name
java.lang.IllegalArgumentException
- if the specified property is not supportedpublic void setDefaultNamespace(java.lang.String uri) throws javax.xml.stream.XMLStreamException
setDefaultNamespace
in interface javax.xml.stream.XMLStreamWriter
uri
- Namespace URI
javax.xml.stream.XMLStreamException
public void setNamespaceContext(javax.xml.namespace.NamespaceContext namespaceContext) throws javax.xml.stream.XMLStreamException
NamespaceContext
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
XMLStreamWriter
.
setNamespaceContext
in interface javax.xml.stream.XMLStreamWriter
namespaceContext
- the namespace context to use for this writer, may not be null
javax.xml.stream.XMLStreamException
public void setPrefix(java.lang.String prefix, java.lang.String uri) throws javax.xml.stream.XMLStreamException
setPrefix
in interface javax.xml.stream.XMLStreamWriter
prefix
- uri
-
javax.xml.stream.XMLStreamException
public void writeAttribute(java.lang.String localName, java.lang.String value) throws javax.xml.stream.XMLStreamException
writeAttribute
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeAttribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String value) throws javax.xml.stream.XMLStreamException
writeAttribute
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value) throws javax.xml.stream.XMLStreamException
writeAttribute
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeCData(java.lang.String cdata) throws javax.xml.stream.XMLStreamException
writeCData
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeCharacters(java.lang.String data) throws javax.xml.stream.XMLStreamException
writeCharacters
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeCharacters(char[] data, int start, int len) throws javax.xml.stream.XMLStreamException
writeCharacters
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeComment(java.lang.String comment) throws javax.xml.stream.XMLStreamException
writeComment
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeDTD(java.lang.String dtd) throws javax.xml.stream.XMLStreamException
writeDTD
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeDefaultNamespace(java.lang.String namespaceURI) throws javax.xml.stream.XMLStreamException
writeDefaultNamespace
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeEmptyElement(java.lang.String localName) throws javax.xml.stream.XMLStreamException
writeEmptyElement
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeEmptyElement(java.lang.String namespaceURI, java.lang.String localName) throws javax.xml.stream.XMLStreamException
writeEmptyElement
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) throws javax.xml.stream.XMLStreamException
writeEmptyElement
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeEndDocument() throws javax.xml.stream.XMLStreamException
writeEndDocument
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeEndElement() throws javax.xml.stream.XMLStreamException
writeEndElement
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeEntityRef(java.lang.String refName) throws javax.xml.stream.XMLStreamException
writeEntityRef
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeNamespace(java.lang.String prefix, java.lang.String namespaceURI) throws javax.xml.stream.XMLStreamException
XMLConstants.NULL_NS_URI
,
i.e. there is no Namespace.
writeNamespace
in interface javax.xml.stream.XMLStreamWriter
prefix
- Prefix to bind.namespaceURI
- NamespaceURI to declare.
javax.xml.stream.XMLStreamException
public void writeProcessingInstruction(java.lang.String target) throws javax.xml.stream.XMLStreamException
writeProcessingInstruction
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeProcessingInstruction(java.lang.String target, java.lang.String data) throws javax.xml.stream.XMLStreamException
writeProcessingInstruction
in interface javax.xml.stream.XMLStreamWriter
target
- data
-
javax.xml.stream.XMLStreamException
public void writeStartDocument() throws javax.xml.stream.XMLStreamException
writeStartDocument
in interface javax.xml.stream.XMLStreamWriter
javax.xml.stream.XMLStreamException
public void writeStartDocument(java.lang.String version) throws javax.xml.stream.XMLStreamException
writeStartDocument
in interface javax.xml.stream.XMLStreamWriter
version
-
javax.xml.stream.XMLStreamException
public void writeStartDocument(java.lang.String encoding, java.lang.String version) throws javax.xml.stream.XMLStreamException
writeStartDocument
in interface javax.xml.stream.XMLStreamWriter
encoding
- version
-
javax.xml.stream.XMLStreamException
public void writeStartElement(java.lang.String localName) throws javax.xml.stream.XMLStreamException
writeStartElement
in interface javax.xml.stream.XMLStreamWriter
localName
-
javax.xml.stream.XMLStreamException
public void writeStartElement(java.lang.String namespaceURI, java.lang.String localName) throws javax.xml.stream.XMLStreamException
writeStartElement
in interface javax.xml.stream.XMLStreamWriter
namespaceURI
- localName
-
javax.xml.stream.XMLStreamException
public void writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) throws javax.xml.stream.XMLStreamException
writeStartElement
in interface javax.xml.stream.XMLStreamWriter
prefix
- localName
- namespaceURI
-
javax.xml.stream.XMLStreamException
protected void repair()
public int size()
size
in interface java.util.Map
size
in class java.util.AbstractMap
public boolean isEmpty()
isEmpty
in interface java.util.Map
isEmpty
in class java.util.AbstractMap
public boolean containsKey(java.lang.Object key)
containsKey
in interface java.util.Map
containsKey
in class java.util.AbstractMap
public java.lang.Object get(java.lang.Object key)
get
in interface java.util.Map
get
in class java.util.AbstractMap
public java.util.Set entrySet()
entrySet
in interface java.util.Map
entrySet
in class java.util.AbstractMap
public java.lang.String toString()
toString
in class java.util.AbstractMap
public int hashCode()
hashCode
in interface java.util.Map
hashCode
in class java.util.AbstractMap
public boolean equals(java.lang.Object obj)
equals
in interface java.util.Map
equals
in class java.util.AbstractMap
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |