Skip navigation links

oracle.idm.io
Class XmlPrintWriter

java.lang.Object
java.io.Writer
java.io.PrintWriter
oracle.idm.io.IndentPrintWriter
oracle.idm.io.XmlPrintWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, Indentable

public class XmlPrintWriter

extends IndentPrintWriter

XmlPrintWriter is a convenience class for printing XML elements.

Field Summary

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

XmlPrintWriter(java.io.OutputStream out)
Constructor for XML print writer from output stream.

XmlPrintWriter(java.io.OutputStream out, boolean autoFlush)
Constructor for XML print writer from output stream, given auto flush mode.

XmlPrintWriter(java.io.Writer out)
Constructor for XML print writer from writer.

XmlPrintWriter(java.io.Writer out, boolean autoFlush)
Constructor for XML print writer from writer, given auto flush mode.

Method Summary

java.lang.String	escape(java.lang.String string) Escapes the string for XML printing.
static XmlPrintWriter	getXmlPrintWriter(java.io.Writer out) Factory method for XML print writers.
void	xprint(boolean b) Prints a boolean as an XML element.
void	xprint(boolean b, java.lang.String tag) Prints a boolean as an XML element.
void	xprint(char c) Prints a char as an XML element.
void	xprint(char[] s) Prints a char[] as an XML element.
void	xprint(char[] cs, java.lang.String tag) Prints a char[] as an XML element.
void	xprint(char c, java.lang.String tag) Prints a char as an XML element.
void	xprint(java.util.Collection collection) Prints the collection as an XML element.
void	xprint(java.util.Collection collection, boolean sorted) Prints the collection as an XML element.
void	xprint(java.util.Collection collection, java.lang.String tag) Prints the collection as an XML element.
void	xprint(java.util.Collection collection, java.lang.String tag, boolean sorted) Prints the collection as an XML element.
void	xprint(double d) Prints a double as an XML element.
void	xprint(double d, java.lang.String tag) Prints a double as an XML element.
void	xprint(java.lang.Error error) Prints error as an XML element.
void	xprint(java.lang.Error error, java.lang.String tag) Prints error as an XML element.
void	xprint(java.lang.Exception exception) Prints exception as an XML element.
void	xprint(java.lang.Exception exception, java.lang.String tag) Prints exception as an XML element.
void	xprint(float f) Prints a float as an XML element.
void	xprint(float f, java.lang.String tag) Prints a float as an XML element.
void	xprint(int i) Prints an int as an XML element.
void	xprint(int i, java.lang.String tag) Prints an int as an XML element.
void	xprint(java.util.Iterator iterator) Prints the iterator as an XML element.
void	xprint(java.util.Iterator iterator, java.lang.String tag) Prints the iterator as an XML element.
void	xprint(java.util.Iterator iterator, java.lang.String tag, boolean expanded) Prints the iterator as an XML element.
void	xprint(java.util.List list) Prints the list as an XML element.
void	xprint(java.util.List list, boolean sorted) Prints the list as an XML element.
void	xprint(java.util.List list, java.lang.String tag) Prints the list as an XML element.
void	xprint(java.util.List list, java.lang.String tag, boolean sorted) Prints the list as an XML element.
void	xprint(long l) Prints a long as an XML element.
void	xprint(long l, java.lang.String tag) Prints a long as an XML element.
void	xprint(java.util.Map map) Prints the map as an XML element.
void	xprint(java.util.Map map, boolean sorted) Prints the map as an XML element.
void	xprint(java.util.Map map, java.lang.String tag) Prints the map as an XML element.
void	xprint(java.util.Map map, java.lang.String tag, boolean sorted) Prints the map as an XML element.
void	xprint(java.lang.Object o) Prints an object as an XML element.
void	xprint(java.lang.Object o, java.lang.String tag) Prints an object as an XML element.
void	xprint(java.lang.RuntimeException runtimeException) Prints runtime exception as an XML element.
void	xprint(java.lang.RuntimeException runtimeException, java.lang.String tag) Prints runtime exception as an XML element.
void	xprint(java.util.Set set) Prints the set as an XML element.
void	xprint(java.util.Set set, boolean sorted) Prints the set as an XML element.
void	xprint(java.util.Set set, java.lang.String tag) Prints the set as an XML element.
void	xprint(java.util.Set set, java.lang.String tag, boolean sorted) Prints the set as an XML element.
void	xprint(java.lang.StackTraceElement[] stackTrace) Prints the stack trace as an XML element.
void	xprint(java.lang.StackTraceElement[] stackTrace, java.lang.String tag) Prints the stack trace as an XML element.
void	xprint(java.lang.String s) Prints a string as an XML element.
void	xprint(java.lang.String s, java.lang.String tag) Prints a string as an XML element.
void	xprint(java.lang.Throwable throwable) Prints throwable as an XML element.
void	xprint(java.lang.Throwable throwable, java.lang.String tag) Prints throwable as an XML element.
void	xprint(XmlPrintable printable) Prints the XML printable object by invoking printable.xprint(this).
void	xprintBody(java.util.Collection collection) Prints the collection as an XML element body (no tag will be printed).
void	xprintBody(java.util.Collection collection, boolean sorted) Prints the collection as an XML element body (no tag will be printed).
void	xprintBody(java.util.Iterator iterator) Prints the iterator as an XML element body (no tag will be printed).
void	xprintBody(java.util.Iterator iterator, boolean expanded) Prints the iterator as an XML element body (no tag will be printed).
void	xprintBody(java.util.Map map) Prints the map as an XML element body (no tag will be printed).
void	xprintBody(java.util.Map map, boolean sorted) Prints the map as an XML element body (no tag will be printed).
void	xprintCause(java.lang.Throwable cause) Prints throwable cause and an XML element.
void	xprintComment(java.lang.String comment) Prints an XML comment.
void	xprintDeclaration() Prints an XML declaration.
void	xprintDeclaration(java.lang.String version) Prints an XML declaration.
void	xprintDeclaration(java.lang.String version, java.lang.String encoding) Prints an XML declaration.
void	xprintDeclaration(java.lang.String version, java.lang.String encoding, boolean standalone) Prints an XML declaration.

Methods inherited from class oracle.idm.io.IndentPrintWriter

decrease, getIndenter, getIndentPrintWriter, increase, indent, iprint, iprint, iprint, iprint, iprint, iprint, iprint, iprint, iprint, iprintln, iprintln, iprintln, iprintln, iprintln, iprintln, iprintln, iprintln, iprintln, iprintln, setIndenter

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlPrintWriter

public XmlPrintWriter(java.io.OutputStream out)

Constructor for XML print writer from output stream.

XmlPrintWriter

public XmlPrintWriter(java.io.OutputStream out,
                      boolean autoFlush)

Constructor for XML print writer from output stream, given auto flush mode.

XmlPrintWriter

public XmlPrintWriter(java.io.Writer out)

Constructor for XML print writer from writer.

XmlPrintWriter

public XmlPrintWriter(java.io.Writer out,
                      boolean autoFlush)

Constructor for XML print writer from writer, given auto flush mode.

Method Detail

getXmlPrintWriter

public static XmlPrintWriter getXmlPrintWriter(java.io.Writer out)

Factory method for XML print writers. If the writer input argument is already an XML print writer, it will be returned. Otherwise a new XML print writer will be constructed and returned.

escape

public java.lang.String escape(java.lang.String string)

Escapes the string for XML printing.

xprint

public void xprint(boolean b)

Prints a boolean as an XML element.

xprint

public void xprint(boolean b,
                   java.lang.String tag)

Prints a boolean as an XML element.

xprint

public void xprint(char c)

Prints a char as an XML element.

xprint

public void xprint(char c,
                   java.lang.String tag)

Prints a char as an XML element.

xprint

public void xprint(int i)

Prints an int as an XML element.

xprint

public void xprint(int i,
                   java.lang.String tag)

Prints an int as an XML element.

xprint

public void xprint(long l)

Prints a long as an XML element.

xprint

public void xprint(long l,
                   java.lang.String tag)

Prints a long as an XML element.

xprint

public void xprint(float f)

Prints a float as an XML element.

xprint

public void xprint(float f,
                   java.lang.String tag)

Prints a float as an XML element.

xprint

public void xprint(double d)

Prints a double as an XML element.

xprint

public void xprint(double d,
                   java.lang.String tag)

Prints a double as an XML element.

xprint

public void xprint(char[] s)

Prints a char[] as an XML element.

xprint

public void xprint(char[] cs,
                   java.lang.String tag)

Prints a char[] as an XML element.

xprint

public void xprint(java.lang.String s)

Prints a string as an XML element.

xprint

public void xprint(java.lang.String s,
                   java.lang.String tag)

Prints a string as an XML element.

xprint

public void xprint(java.lang.Object o)

Prints an object as an XML element.

xprint

public void xprint(java.lang.Object o,
                   java.lang.String tag)

Prints an object as an XML element.

xprint

public void xprint(java.lang.StackTraceElement[] stackTrace)

Prints the stack trace as an XML element.

xprint

public void xprint(java.lang.StackTraceElement[] stackTrace,
                   java.lang.String tag)

Prints the stack trace as an XML element.

xprint

public void xprint(java.lang.Throwable throwable)

Prints throwable as an XML element.

xprint

public void xprint(java.lang.Throwable throwable,
                   java.lang.String tag)

Prints throwable as an XML element.

xprintCause

public void xprintCause(java.lang.Throwable cause)

Prints throwable cause and an XML element.

xprint

public void xprint(java.lang.RuntimeException runtimeException)

Prints runtime exception as an XML element.

xprint

public void xprint(java.lang.RuntimeException runtimeException,
                   java.lang.String tag)

Prints runtime exception as an XML element.

xprint

public void xprint(java.lang.Exception exception)

Prints exception as an XML element.

xprint

public void xprint(java.lang.Exception exception,
                   java.lang.String tag)

Prints exception as an XML element.

xprint

public void xprint(java.lang.Error error)

Prints error as an XML element.

xprint

public void xprint(java.lang.Error error,
                   java.lang.String tag)

Prints error as an XML element.

xprint

public void xprint(java.util.Iterator iterator)

Prints the iterator as an XML element.

xprint

public void xprint(java.util.Iterator iterator,
                   java.lang.String tag)

Prints the iterator as an XML element.

xprint

public void xprint(java.util.Iterator iterator,
                   java.lang.String tag,
                   boolean expanded)

Prints the iterator as an XML element.

xprintBody

public void xprintBody(java.util.Iterator iterator)

Prints the iterator as an XML element body (no tag will be printed).

xprintBody

public void xprintBody(java.util.Iterator iterator,
                       boolean expanded)

Prints the iterator as an XML element body (no tag will be printed).

xprint

public void xprint(java.util.Collection collection)

Prints the collection as an XML element.

xprint

public void xprint(java.util.Collection collection,
                   java.lang.String tag)

Prints the collection as an XML element.

xprint

public void xprint(java.util.Collection collection,
                   boolean sorted)

Prints the collection as an XML element.

xprint

public void xprint(java.util.Collection collection,
                   java.lang.String tag,
                   boolean sorted)

Prints the collection as an XML element.

xprintBody

public void xprintBody(java.util.Collection collection)

Prints the collection as an XML element body (no tag will be printed).

xprintBody

public void xprintBody(java.util.Collection collection,
                       boolean sorted)

Prints the collection as an XML element body (no tag will be printed).

xprint

public void xprint(java.util.List list)

Prints the list as an XML element.

xprint

public void xprint(java.util.List list,
                   java.lang.String tag)

Prints the list as an XML element.

xprint

public void xprint(java.util.List list,
                   boolean sorted)

Prints the list as an XML element.

xprint

public void xprint(java.util.List list,
                   java.lang.String tag,
                   boolean sorted)

Prints the list as an XML element.

xprint

public void xprint(java.util.Set set)

Prints the set as an XML element.

xprint

public void xprint(java.util.Set set,
                   java.lang.String tag)

Prints the set as an XML element.

xprint

public void xprint(java.util.Set set,
                   boolean sorted)

Prints the set as an XML element.

xprint

public void xprint(java.util.Set set,
                   java.lang.String tag,
                   boolean sorted)

Prints the set as an XML element.

xprint

public void xprint(java.util.Map map)

Prints the map as an XML element.

xprint

public void xprint(java.util.Map map,
                   java.lang.String tag)

Prints the map as an XML element.

xprint

public void xprint(java.util.Map map,
                   boolean sorted)

Prints the map as an XML element.

xprint

public void xprint(java.util.Map map,
                   java.lang.String tag,
                   boolean sorted)

Prints the map as an XML element.

xprintBody

public void xprintBody(java.util.Map map)

Prints the map as an XML element body (no tag will be printed).

xprintBody

public void xprintBody(java.util.Map map,
                       boolean sorted)

Prints the map as an XML element body (no tag will be printed).

xprint

public void xprint(XmlPrintable printable)

Prints the XML printable object by invoking printable.xprint(this).

If the XML printable argument is null, it simply returns.

xprintComment

public void xprintComment(java.lang.String comment)

Prints an XML comment.

xprintDeclaration

public void xprintDeclaration()

Prints an XML declaration.

xprintDeclaration

public void xprintDeclaration(java.lang.String version)

Prints an XML declaration.

xprintDeclaration

public void xprintDeclaration(java.lang.String version,
                              java.lang.String encoding)

Prints an XML declaration.

xprintDeclaration

public void xprintDeclaration(java.lang.String version,
                              java.lang.String encoding,
                              boolean standalone)

Prints an XML declaration.

Skip navigation links