Modifier and Type	Class and Description
private static class	XmlWriterWrapper.RawWrapper This wrapper directs calls to `writeRaw` methods.
private static class	XmlWriterWrapper.TextWrapper This wrapper directs calls to `writeCharacters` methods.

Modifier and Type	Field and Description
private char[]	mBuffer
protected final XmlWriter	mWriter

Access	Constructor and Description
protected	XmlWriterWrapper(XmlWriter writer)

Method Summary

Modifier and Type	Method and Description
public final void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closes the stream, flushing it first.
public final void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushes the stream.
public static XmlWriterWrapper	wrapWriteCharacters(XmlWriter xw)
public static XmlWriterWrapper	wrapWriteRaw(XmlWriter xw)
public final void	write(char[] Array of characters to be written cbuf) Overrides java.io.Writer.write. Writes an array of characters.
public abstract void	write(char[] Array of characters cbuf, int Offset from which to start writing characters off, int Number of characters to write len) Implements abstract java.io.Writer.write. Writes a portion of an array of characters.
public final void	write(int int specifying a character to be written c) Overrides java.io.Writer.write. Writes a single character.
public abstract void	write(String String to be written str) Overrides java.io.Writer.write. Writes a string.
public abstract void	write(String A String str, int Offset from which to start writing characters off, int Number of characters to write len) Overrides java.io.Writer.write. Writes a portion of a string.

Inherited from java.io.Writer:: append append append nullWriter

Field Detail

mBuffer	back to summary
private char[] mBuffer

mWriter	back to summary
protected final XmlWriter mWriter

Constructor Detail

XmlWriterWrapper	back to summary
protected XmlWriterWrapper(XmlWriter writer)

Method Detail

close	back to summary
public final void close() throws IOException Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Doc from java.io.Writer.close. Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect. Annotations @Override Exceptions IOException: If an I/O error occurs

back to summary

public final void close() throws IOException

Implements abstract java.io.Writer.close.

Implements java.io.Closeable.close.

Doc from java.io.Writer.close.

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

flush	back to summary
public final void flush() throws IOException Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Doc from java.io.Writer.flush. Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Annotations @Override Exceptions IOException: If an I/O error occurs

flush

back to summary

public final void flush() throws IOException

Implements abstract java.io.Writer.flush.

Implements java.io.Flushable.flush.

Doc from java.io.Writer.flush.

Flushes the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

wrapWriteCharacters	back to summary
public static XmlWriterWrapper wrapWriteCharacters(XmlWriter xw)

wrapWriteRaw	back to summary
public static XmlWriterWrapper wrapWriteRaw(XmlWriter xw)

write	back to summary
public final void write(char[] cbuf) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes an array of characters. Parameters cbuf:char[] Array of characters to be written Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public final void write(char[] cbuf) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes an array of characters.

Parameters

cbuf:char[]: Array of characters to be written

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public abstract void write(char[] cbuf, int off, int len) throws IOException Implements abstract java.io.Writer.write. Doc from java.io.Writer.write. Writes a portion of an array of characters. Parameters cbuf:char[] Array of characters off:int Offset from which to start writing characters len:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public abstract void write(char[] cbuf, int off, int len) throws IOException

Implements abstract java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of an array of characters.

Parameters

cbuf:char[]: Array of characters
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public final void write(int c) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a single character. The character to be written is contained in the 16 low-order bits of the given integer value; the 16 high-order bits are ignored. Subclasses that intend to support efficient single-character output should override this method. Parameters c:int int specifying a character to be written Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public final void write(int c) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a single character. The character to be written is contained in the 16 low-order bits of the given integer value; the 16 high-order bits are ignored.

Subclasses that intend to support efficient single-character output should override this method.

Parameters

c:int: int specifying a character to be written

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public abstract void write(String str) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a string. Parameters str:String String to be written Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public abstract void write(String str) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a string.

Parameters

str:String: String to be written

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public abstract void write(String str, int off, int len) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a portion of a string. Parameters str:String A String off:int Offset from which to start writing characters len:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public abstract void write(String str, int off, int len) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a portion of a string.

Parameters

str:String: A String
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

com.ctc.wstx.sw back to summary

private final Class XmlWriterWrapper.RawWrapper

Class Inheritance

extends XmlWriterWrapper

java.lang.Object
java.io.Writer
com.ctc.wstx.sw.XmlWriterWrapper
com.ctc.wstx.sw.XmlWriterWrapper.RawWrapper

This wrapper directs calls to writeRaw methods. Thus, it is a "vanilla" writer, and no escaping is done.

Field Summary

Inherited from com.ctc.wstx.sw.XmlWriterWrapper:: mWriter

Constructor Summary

Access	Constructor and Description
protected	RawWrapper(XmlWriter writer)

Method Summary

Modifier and Type	Method and Description
public void	write(char[] Array of characters cbuf, int Offset from which to start writing characters off, int Number of characters to write len) Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Writes a portion of an array of characters.
public void	write(String A String str, int Offset from which to start writing characters off, int Number of characters to write len) Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Writes a portion of a string.
public final void	write(String String to be written str) Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Writes a string.

Inherited from com.ctc.wstx.sw.XmlWriterWrapper:: close flush wrapWriteCharacters wrapWriteRaw write write

Constructor Detail

RawWrapper	back to summary
protected RawWrapper(XmlWriter writer)

Method Detail

write	back to summary
public void write(char[] cbuf, int off, int len) throws IOException Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Doc from java.io.Writer.write. Writes a portion of an array of characters. Parameters cbuf:char[] Array of characters off:int Offset from which to start writing characters len:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(char[] cbuf, int off, int len) throws IOException

Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write.

Doc from java.io.Writer.write.

Writes a portion of an array of characters.

Parameters

cbuf:char[]: Array of characters
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(String str, int off, int len) throws IOException Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Doc from java.io.Writer.write. Writes a portion of a string. Parameters str:String A String off:int Offset from which to start writing characters len:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(String str, int off, int len) throws IOException

Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write.

Doc from java.io.Writer.write.

Writes a portion of a string.

Parameters

str:String: A String
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public final void write(String str) throws IOException Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Doc from java.io.Writer.write. Writes a string. Parameters str:String String to be written Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public final void write(String str) throws IOException

Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write.

Doc from java.io.Writer.write.

Writes a string.

Parameters

str:String: String to be written

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

com.ctc.wstx.sw back to summary

private Class XmlWriterWrapper.TextWrapper

Class Inheritance

extends XmlWriterWrapper

java.lang.Object
java.io.Writer
com.ctc.wstx.sw.XmlWriterWrapper
com.ctc.wstx.sw.XmlWriterWrapper.TextWrapper

This wrapper directs calls to writeCharacters methods. This means that text content escaping (and, possibly, validation) is done, using default or custom escaping code.

Field Summary

Inherited from com.ctc.wstx.sw.XmlWriterWrapper:: mWriter

Constructor Summary

Access	Constructor and Description
protected	TextWrapper(XmlWriter writer)

Method Summary

Modifier and Type	Method and Description
public void	write(char[] Array of characters cbuf, int Offset from which to start writing characters off, int Number of characters to write len) Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Writes a portion of an array of characters.
public void	write(String String to be written str) Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Writes a string.
public void	write(String A String str, int Offset from which to start writing characters off, int Number of characters to write len) Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Writes a portion of a string.

Inherited from com.ctc.wstx.sw.XmlWriterWrapper:: close flush wrapWriteCharacters wrapWriteRaw write write

Constructor Detail

TextWrapper	back to summary
protected TextWrapper(XmlWriter writer)

Method Detail

write	back to summary
public void write(char[] cbuf, int off, int len) throws IOException Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Doc from java.io.Writer.write. Writes a portion of an array of characters. Parameters cbuf:char[] Array of characters off:int Offset from which to start writing characters len:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(char[] cbuf, int off, int len) throws IOException

Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write.

Doc from java.io.Writer.write.

Writes a portion of an array of characters.

Parameters

cbuf:char[]: Array of characters
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(String str) throws IOException Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Doc from java.io.Writer.write. Writes a string. Parameters str:String String to be written Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(String str) throws IOException

Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write.

Doc from java.io.Writer.write.

Writes a string.

Parameters

str:String: String to be written

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(String str, int off, int len) throws IOException Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write. Doc from java.io.Writer.write. Writes a portion of a string. Parameters str:String A String off:int Offset from which to start writing characters len:int Number of characters to write Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(String str, int off, int len) throws IOException

Implements abstract com.ctc.wstx.sw.XmlWriterWrapper.write.

Doc from java.io.Writer.write.

Writes a portion of a string.

Parameters

str:String: A String
off:int: Offset from which to start writing characters
len:int: Number of characters to write

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

public abstract Class XmlWriterWrapper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class XmlWriterWrapper.RawWrapper

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class XmlWriterWrapper.TextWrapper

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail