Apache Groovy 3.0.20 · groovy.xml.streamingmarkupsupport.StreamingMarkupWriter

Field Summary

Modifier and Type	Field and Description
private final Function<Character, Optional<String>>	attrFilter
protected final CharsetEncoder	encoder
protected final String	encoding
protected boolean	encodingKnown
private final Writer	escapedWriter
protected boolean	haveHighSurrogate
private final Function<Character, Optional<String>>	quoteFilter
private final Function<Character, Optional<String>>	stdFilter
protected StringBuilder	surrogatePair
protected final Writer	writer
protected boolean	writingAttribute

Inherited from java.io.Writer:: lock

Constructor Summary

Access	Constructor and Description
public	StreamingMarkupWriter(final Writer writer, final String encoding)
public	StreamingMarkupWriter(final Writer writer, final String encoding, boolean useDoubleQuotes)
public	StreamingMarkupWriter(final Writer writer)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closes the stream, flushing it first.
public Writer	escaped()
public void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushes the stream.
public String	getEncoding()
public boolean	getEncodingKnown()
private static String	getNormalizedEncoding(String unnormalized)
public void	setWritingAttribute(final boolean writingAttribute)
public Writer	unescaped()
public void	write(final int int specifying a character to be written c) Overrides java.io.Writer.write. Writes a single character.
public void	write(final 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.

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

Field Detail

attrFilter	back to summary
private final Function<Character, Optional<String>> attrFilter

encoder	back to summary
protected final CharsetEncoder encoder

encoding	back to summary
protected final String encoding

encodingKnown	back to summary
protected boolean encodingKnown

escapedWriter	back to summary
private final Writer escapedWriter

haveHighSurrogate	back to summary
protected boolean haveHighSurrogate

quoteFilter	back to summary
private final Function<Character, Optional<String>> quoteFilter

stdFilter	back to summary
private final Function<Character, Optional<String>> stdFilter

surrogatePair	back to summary
protected StringBuilder surrogatePair

writer	back to summary
protected final Writer writer

writingAttribute	back to summary
protected boolean writingAttribute

Constructor Detail

StreamingMarkupWriter	back to summary
public StreamingMarkupWriter(final Writer writer, final String encoding)

StreamingMarkupWriter	back to summary
public StreamingMarkupWriter(final Writer writer, final String encoding, boolean useDoubleQuotes)

StreamingMarkupWriter	back to summary
public StreamingMarkupWriter(final Writer writer)

Method Detail

close	back to summary
public 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. Exceptions IOException: If an I/O error occurs

back to summary

public 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.

Exceptions

IOException:: If an I/O error occurs

escaped	back to summary
public Writer escaped()

flush	back to summary
public 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. Exceptions IOException: If an I/O error occurs

flush

back to summary

public 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.

Exceptions

IOException:: If an I/O error occurs

getEncoding	back to summary
public String getEncoding()

getEncodingKnown	back to summary
public boolean getEncodingKnown()

getNormalizedEncoding	back to summary
private static String getNormalizedEncoding(String unnormalized)

setWritingAttribute	back to summary
public void setWritingAttribute(final boolean writingAttribute)

unescaped	back to summary
public Writer unescaped()

write	back to summary
public void write(final 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 Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(final 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

Exceptions

IOException:: If an I/O error occurs

write	back to summary
public void write(final 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 Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(final 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

Exceptions

IOException:: If an I/O error occurs

public Class StreamingMarkupWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail