|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavanet.staxutils.io.XMLWriterUtils
public final class XMLWriterUtils
Set of utility methods useful when writing XML.
Method Summary | |
---|---|
static void |
writeAttribute(Attribute attr,
java.io.Writer writer)
Writes an Attribute to the provided stream. |
static void |
writeAttribute(Attribute attr,
XMLStreamWriter writer)
Writes an Attribute to the provided stream. |
static void |
writeAttribute(QName name,
java.lang.String value,
java.io.Writer writer)
Writes an attribute to the provided stream. |
static void |
writeCData(char[] data,
int start,
int length,
java.io.Writer writer)
Writes a Characters to the provided stream. |
static void |
writeCData(java.lang.String text,
java.io.Writer writer)
Writes a Characters to the provided stream. |
static void |
writeCharacters(char[] data,
int start,
int length,
java.io.Writer writer)
Writes a chunk of encoded text to the provided stream. |
static void |
writeCharacters(Characters chars,
java.io.Writer writer)
Writes a Characters to the provided stream. |
static void |
writeCharacters(Characters chars,
XMLStreamWriter writer)
Writes a Characters to the provided stream. |
static void |
writeCharacters(java.lang.CharSequence text,
java.io.Writer writer)
Writes a chunk of encoded text to the provided stream. |
static void |
writeComment(Comment comment,
java.io.Writer writer)
Writes a Comment to the provided stream. |
static void |
writeComment(Comment comment,
XMLStreamWriter writer)
Writes a Comment to the provided stream. |
static void |
writeComment(java.lang.String comment,
java.io.Writer writer)
Writes a comment to the provided stream. |
static void |
writeDTD(DTD dtd,
java.io.Writer writer)
Writes a DTD to the provided stream. |
static void |
writeDTD(DTD dtd,
XMLStreamWriter writer)
Writes a DTD to the provided stream. |
static void |
writeDTD(java.lang.String dtd,
java.io.Writer writer)
Writes a dtd to the provided stream. |
static void |
writeEncodedCharacter(char c,
java.io.Writer writer)
Encodes the provided character if needed, and writes it to an output stream. |
static void |
writeEncodedQuotedValue(java.lang.String value,
java.io.Writer writer)
Encodes the given value and writes it to the provided stream, wrapping it in the appropriate quote character. |
static void |
writeEncodedText(char[] text,
int start,
int len,
java.io.Writer writer)
|
static void |
writeEncodedText(java.lang.CharSequence text,
java.io.Writer writer)
Encodes the provided text and writes it to the provided stream. |
static void |
writeEncodedValue(java.lang.String value,
char quoteChar,
java.io.Writer writer)
Encodes the given value, and writes it to the stream, but does not actually wrap the value in the quote character. |
static void |
writeEndDocument(EndDocument end,
java.io.Writer writer)
Writes an EndDocument to the provided stream. |
static void |
writeEndDocument(EndDocument end,
XMLStreamWriter writer)
Writes an EndDocument to the provided stream. |
static void |
writeEndDocument(java.io.Writer writer)
Writes an document ending to the provided stream. |
static void |
writeEndElement(EndElement end,
java.io.Writer writer)
Writes an EndElement to the provided stream. |
static void |
writeEndElement(EndElement end,
XMLStreamWriter writer)
Writes an EndElement to the provided stream. |
static void |
writeEndElement(QName name,
java.io.Writer writer)
Writes an element end tag to the provided stream. |
static void |
writeEntityDeclaration(EntityDeclaration declaration,
java.io.Writer writer)
Writes an EntityDeclaration to the stream. |
static void |
writeEntityDeclaration(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String notation,
java.io.Writer writer)
Writes an external entity declaration to the stream. |
static void |
writeEntityDeclaration(java.lang.String name,
java.lang.String text,
java.lang.String notation,
java.io.Writer writer)
Writes an internal entity declaration to the stream. |
static void |
writeEntityReference(EntityReference entityRef,
java.io.Writer writer)
Writes an EntityReference to the provided stream. |
static void |
writeEntityReference(EntityReference entityRef,
XMLStreamWriter writer)
Writes an EntityReference to the provided stream. |
static void |
writeEntityReference(java.lang.String entityRef,
java.io.Writer writer)
Writes an entity reference to the provided stream. |
static void |
writeEvent(XMLEvent event,
java.io.Writer writer)
Writes the given event to the provided Writer . |
static void |
writeEvent(XMLEvent event,
XMLStreamWriter writer)
Writes the given event to the provided XMLStreamWriter . |
static void |
writeNamespace(Namespace ns,
java.io.Writer writer)
Writes a Namespace to the provided stream. |
static void |
writeNamespace(Namespace ns,
XMLStreamWriter writer)
Writes a Namespace to the provided stream. |
static void |
writeNamespace(java.lang.String prefix,
java.lang.String uri,
java.io.Writer writer)
Writes a Namespace to the provided stream. |
static void |
writeNotationDeclaration(NotationDeclaration declaration,
java.io.Writer writer)
Writes a NotationDeclaration to the stream. |
static void |
writeNotationDeclaration(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.io.Writer writer)
Writes a notation declaration to the stream. |
static void |
writeProcessingInstruction(ProcessingInstruction procInst,
java.io.Writer writer)
Writes a ProcessingInstruction to the provided stream. |
static void |
writeProcessingInstruction(ProcessingInstruction procInst,
XMLStreamWriter writer)
Writes a ProcessingInstruction to the provided stream. |
static void |
writeProcessingInstruction(java.lang.String target,
java.lang.String data,
java.io.Writer writer)
Writes a ProcessingInstruction to the provided stream. |
static void |
writeQName(QName name,
java.io.Writer writer)
Writes a qualified name to the provided stream. |
static void |
writeQName(java.lang.String prefix,
java.lang.String localPart,
java.io.Writer writer)
Writes a qualified name to the provided stream. |
static void |
writeQuotedValue(java.lang.String value,
java.io.Writer writer)
Writes a quoted version of the given value, automatically determining the appropriate quote character. |
static void |
writeStartDocument(StartDocument start,
java.io.Writer writer)
Writes a StartDocument to the provided stream. |
static void |
writeStartDocument(StartDocument start,
XMLStreamWriter writer)
Writes a StartDocument to the provided stream. |
static void |
writeStartDocument(java.lang.String version,
java.lang.String encoding,
boolean standalone,
java.io.Writer writer)
Writes an XML declaration to the provided stream. |
static void |
writeStartDocument(java.lang.String version,
java.lang.String encoding,
java.lang.String standalone,
java.io.Writer writer)
Writes an XML declaration to the provided stream. |
static void |
writeStartDocument(java.lang.String version,
java.lang.String encoding,
java.io.Writer writer)
Writes an XML declaration to the provided stream. |
static void |
writeStartDocument(java.lang.String version,
java.io.Writer writer)
Writes an XML declaration to the provided stream. |
static void |
writeStartDocument(java.io.Writer writer)
Writes a default XML declaration to the provided stream. |
static void |
writeStartElement(QName name,
java.util.Iterator attributes,
java.util.Iterator namespaces,
boolean empty,
java.io.Writer writer)
Writes a start tag and any associated namespaces and attributes to the provided stream. |
static void |
writeStartElement(QName name,
java.util.Iterator attributes,
java.util.Iterator namespaces,
java.io.Writer writer)
Writes a start tag and any associated namespaces and attributes to the provided stream. |
static void |
writeStartElement(QName name,
java.util.Map attributes,
java.util.Map namespaces,
boolean empty,
java.io.Writer writer)
Writes a start tag and any associated namespaces and attributes to the provided stream. |
static void |
writeStartElement(StartElement start,
boolean empty,
java.io.Writer writer)
Writes a StartElement event to the provided stream. |
static void |
writeStartElement(StartElement start,
boolean empty,
XMLStreamWriter writer)
Writes a StartElement event to the provided stream. |
static void |
writeStartElement(StartElement start,
java.io.Writer writer)
Writes a StartElement event to the provided stream. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static final void writeQuotedValue(java.lang.String value, java.io.Writer writer) throws java.io.IOException
value
- The value to quote and output.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEncodedQuotedValue(java.lang.String value, java.io.Writer writer) throws java.io.IOException
value
- The value to encode, quote, and output.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEncodedValue(java.lang.String value, char quoteChar, java.io.Writer writer) throws java.io.IOException
value
- The value to encode and output.quoteChar
- The quote character; used to determine which characters need
to be encoded.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEncodedText(java.lang.CharSequence text, java.io.Writer writer) throws java.io.IOException
text
- The text to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEncodedText(char[] text, int start, int len, java.io.Writer writer) throws java.io.IOException
java.io.IOException
public static final void writeEncodedCharacter(char c, java.io.Writer writer) throws java.io.IOException
c
- The character to encode and output.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeQName(QName name, java.io.Writer writer) throws java.io.IOException
name
- The name to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeQName(java.lang.String prefix, java.lang.String localPart, java.io.Writer writer) throws java.io.IOException
prefix
- The prefix, or null
localPart
- The local part.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEvent(XMLEvent event, java.io.Writer writer) throws java.io.IOException, XMLStreamException
Writer
. This method
will delegate the actual task of writing to the stream to the appropriate
overloaded method.
event
- The event to write.writer
- The destination XML stream.
java.io.IOException
- If an error occurs writing to the stream.
XMLStreamException
- If the event is a StartElement and an error occurs
writing the Namespace or Attribute events.
java.lang.IllegalArgumentException
- If the event is an unknown type.public static final void writeStartDocument(StartDocument start, java.io.Writer writer) throws java.io.IOException
StartDocument
to the provided stream.
start
- The StartDocument
to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeStartDocument(java.io.Writer writer) throws java.io.IOException
writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeStartDocument(java.lang.String version, java.io.Writer writer) throws java.io.IOException
version
- The xml version definition.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeStartDocument(java.lang.String version, java.lang.String encoding, java.io.Writer writer) throws java.io.IOException
version
- The xml version definition.encoding
- The document encoding, or null
writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeStartDocument(java.lang.String version, java.lang.String encoding, boolean standalone, java.io.Writer writer) throws java.io.IOException
version
- The xml version definition.encoding
- The document encoding, or null
standalone
- The standalone definitionwriter
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeStartDocument(java.lang.String version, java.lang.String encoding, java.lang.String standalone, java.io.Writer writer) throws java.io.IOException
version
- The xml version definition.encoding
- The document encoding, or null
standalone
- The standalone definition, or null
writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEndDocument(EndDocument end, java.io.Writer writer) throws java.io.IOException
EndDocument
to the provided stream.
end
- The EndDocument
to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEndDocument(java.io.Writer writer) throws java.io.IOException
writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeStartElement(StartElement start, java.io.Writer writer) throws java.io.IOException, XMLStreamException
StartElement
event to the provided stream.
start
- The StartElement
event to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.
XMLStreamException
- If an error occurs writing any namespaces or
attribute events.public static final void writeStartElement(StartElement start, boolean empty, java.io.Writer writer) throws java.io.IOException, XMLStreamException
StartElement
event to the provided stream.
start
- The StartElement
event to write.empty
- Whether the element is empty.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.
XMLStreamException
- If an error occurs writing any namespaces or
attribute events.public static final void writeStartElement(QName name, java.util.Iterator attributes, java.util.Iterator namespaces, java.io.Writer writer) throws java.io.IOException, XMLStreamException
name
- The tag name.attributes
- An Attribute
iterator, or null
.namespaces
- A Namespace
iterator, or null
.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.
XMLStreamException
- If an error occurs writing any namespaces or
attribute events.public static final void writeStartElement(QName name, java.util.Iterator attributes, java.util.Iterator namespaces, boolean empty, java.io.Writer writer) throws java.io.IOException, XMLStreamException
name
- The tag name.attributes
- An Attribute
iterator, or null
.namespaces
- A Namespace
iterator, or null
.empty
- Whether the element is empty.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.
XMLStreamException
public static final void writeStartElement(QName name, java.util.Map attributes, java.util.Map namespaces, boolean empty, java.io.Writer writer) throws java.io.IOException
name
- The tag name.attributes
- A Map
of attribute values, keyed by their
QName
s. If no attributes are present, this may be null.namespaces
- A Map
of namespace values, keyed by their
prefixes. If no namespaces are present, this may be null.empty
- Whether the element is empty.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeAttribute(Attribute attr, java.io.Writer writer) throws java.io.IOException
Attribute
to the provided stream.
attr
- The Attribute
to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeAttribute(QName name, java.lang.String value, java.io.Writer writer) throws java.io.IOException
name
- The attribute name.value
- The attribute value.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeNamespace(Namespace ns, java.io.Writer writer) throws java.io.IOException
Namespace
to the provided stream.
ns
- The Namespace
to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeNamespace(java.lang.String prefix, java.lang.String uri, java.io.Writer writer) throws java.io.IOException
Namespace
to the provided stream.
prefix
- The namespace prefix, which may be null
.uri
- The namespace uri.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEndElement(EndElement end, java.io.Writer writer) throws java.io.IOException
EndElement
to the provided stream.
end
- The EndElement
to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEndElement(QName name, java.io.Writer writer) throws java.io.IOException
name
- The element name.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeCharacters(Characters chars, java.io.Writer writer) throws java.io.IOException
Characters
to the provided stream.
chars
- The Characters
to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeCharacters(java.lang.CharSequence text, java.io.Writer writer) throws java.io.IOException
text
- The text to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeCharacters(char[] data, int start, int length, java.io.Writer writer) throws java.io.IOException
data
- A character array containing the characters.start
- The starting index into the array.length
- The number of characters to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeCData(java.lang.String text, java.io.Writer writer) throws java.io.IOException
Characters
to the provided stream.
text
- The CData text to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeCData(char[] data, int start, int length, java.io.Writer writer) throws java.io.IOException
Characters
to the provided stream.
data
- A character array containing the cdata text.start
- The starting index into the array.length
- The number of characters to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeComment(Comment comment, java.io.Writer writer) throws java.io.IOException
Comment
to the provided stream.
comment
- The Comment
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.
java.io.IOException
public static final void writeComment(java.lang.String comment, java.io.Writer writer) throws java.io.IOException
comment
- The comment text.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.
java.io.IOException
public static final void writeEntityReference(EntityReference entityRef, java.io.Writer writer) throws java.io.IOException
EntityReference
to the provided stream.
entityRef
- The EntityReference
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.
java.io.IOException
public static final void writeEntityReference(java.lang.String entityRef, java.io.Writer writer) throws java.io.IOException
entityRef
- The name of the entity reference.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.
java.io.IOException
public static final void writeEntityDeclaration(EntityDeclaration declaration, java.io.Writer writer) throws java.io.IOException
EntityDeclaration
to the stream.
declaration
- The EntityDeclaration
to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEntityDeclaration(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notation, java.io.Writer writer) throws java.io.IOException
publicId
and systemId
parameters must be
non-null
.
name
- The entity name.publicId
- The entity public ID, or null
.systemId
- The entity system ID, or null
.notation
- The notation name, or null
.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEntityDeclaration(java.lang.String name, java.lang.String text, java.lang.String notation, java.io.Writer writer) throws java.io.IOException
name
- The entity name.text
- The entity replacement text.notation
- The notation name, or null
.writer
-
java.io.IOException
public static final void writeNotationDeclaration(NotationDeclaration declaration, java.io.Writer writer) throws java.io.IOException
NotationDeclaration
to the stream.
declaration
- The NotationDeclaration
to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeNotationDeclaration(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.io.Writer writer) throws java.io.IOException
publicId
and systemId
parameters must be
non-null
.
name
- The notation name.publicId
- The entity public ID, or null
.systemId
- The entity system ID, or null
.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeProcessingInstruction(ProcessingInstruction procInst, java.io.Writer writer) throws java.io.IOException
ProcessingInstruction
to the provided stream.
procInst
- The ProcessingInstruction
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.
java.io.IOException
public static final void writeProcessingInstruction(java.lang.String target, java.lang.String data, java.io.Writer writer) throws java.io.IOException
ProcessingInstruction
to the provided stream.
target
- The instruction target.data
- The instruction data, or null
.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.
java.io.IOException
public static final void writeDTD(DTD dtd, java.io.Writer writer) throws java.io.IOException
DTD
to the provided stream.
dtd
- The DTD
to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeDTD(java.lang.String dtd, java.io.Writer writer) throws java.io.IOException
dtd
- The dtd to write.writer
- The destination stream.
java.io.IOException
- If an error occurs writing to the stream.public static final void writeEvent(XMLEvent event, XMLStreamWriter writer) throws XMLStreamException
XMLStreamWriter
. This method
will delegate the actual task of writing to the stream to the appropriate
overloaded method.
event
- The event to write.writer
- The destination XML stream.
XMLStreamException
- If an error occurs writing the event.public static final void writeStartElement(StartElement start, boolean empty, XMLStreamWriter writer) throws XMLStreamException
StartElement
event to the provided stream.
start
- The StartElement
event to write.empty
- Whether the element is empty.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeEndElement(EndElement end, XMLStreamWriter writer) throws XMLStreamException
EndElement
to the provided stream.
end
- The EndElement
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeAttribute(Attribute attr, XMLStreamWriter writer) throws XMLStreamException
Attribute
to the provided stream.
attr
- The Attribute
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeNamespace(Namespace ns, XMLStreamWriter writer) throws XMLStreamException
Namespace
to the provided stream.
ns
- The Namespace
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeStartDocument(StartDocument start, XMLStreamWriter writer) throws XMLStreamException
StartDocument
to the provided stream.
start
- The StartDocument
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeEndDocument(EndDocument end, XMLStreamWriter writer) throws XMLStreamException
EndDocument
to the provided stream.
end
- The EndDocument
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeCharacters(Characters chars, XMLStreamWriter writer) throws XMLStreamException
Characters
to the provided stream.
chars
- The Characters
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeComment(Comment comment, XMLStreamWriter writer) throws XMLStreamException
Comment
to the provided stream.
comment
- The Comment
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeEntityReference(EntityReference entityRef, XMLStreamWriter writer) throws XMLStreamException
EntityReference
to the provided stream.
entityRef
- The EntityReference
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeProcessingInstruction(ProcessingInstruction procInst, XMLStreamWriter writer) throws XMLStreamException
ProcessingInstruction
to the provided stream.
procInst
- The ProcessingInstruction
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.public static final void writeDTD(DTD dtd, XMLStreamWriter writer) throws XMLStreamException
DTD
to the provided stream.
dtd
- The DTD
to write.writer
- The destination stream.
XMLStreamException
- If an error occurs writing to the stream.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |