Jakarta EE 11.0.0 · com.sun.faces.facelets.StateWriter

A class for handling state insertion. Content is written directly to "out" until an attempt to write state; at that point, it's redirected into a buffer that can be picked through in theory, this buffer should be very small, since it only needs to be enough to contain all the content after the close of the first (and, hopefully, only) form.

Potential optimizations:

If we created a new FastWriter at each call to writingState(), and stored a List of them, then we'd know that state tokens could only possibly be near the start of each buffer (and might not be there at all). (There might be a close-element before the state token). Then, we'd only need to check the start of the buffer for the state token; if it's there, write out the real state, then blast the rest of the buffer out. This wouldn't even require toString(), which for large buffers is expensive. However, this optimization is only going to be especially meaningful for the multi-form case.
More of a FastWriter optimization than a StateWriter, but: it is far faster to create a set of small 1K buffers than constantly reallocating one big buffer.

Modifier and Type	Field and Description
private static final ThreadLocal<T>	CURRENT_WRITER
private FastWriter	fast
private int	initialSize
private Writer	out
private boolean	writtenState

Constructor Summary

Access	Constructor and Description
public	StateWriter(Writer initialOut, int initialSize)

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 void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushes the stream.
public String	getAndResetBuffer()
public static StateWriter	getCurrentInstance()
public boolean	isStateWritten()
public void	release()
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 java.io.Writer.write. Writes a portion of an array of characters.
public void	write(char[] Array of characters to be written cbuf) Overrides java.io.Writer.write. Writes an array of characters.
public void	write(int int specifying a character to be written c) Overrides java.io.Writer.write. Writes a single character.
public 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.
public void	write(String String to be written str) Overrides java.io.Writer.write. Writes a string.
public void	writingState() Mark that state is about to be written.

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

Field Detail

CURRENT_WRITER	back to summary
private static final ThreadLocal<T> CURRENT_WRITER

fast	back to summary
private FastWriter fast

initialSize	back to summary
private int initialSize

out	back to summary
private Writer out

writtenState	back to summary
private boolean writtenState

Constructor Detail

StateWriter	back to summary
public StateWriter(Writer initialOut, int initialSize)

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. Annotations @Override 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.

Annotations

@Override

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. Annotations @Override 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.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

getAndResetBuffer	back to summary
public String getAndResetBuffer()

getCurrentInstance	back to summary
public static StateWriter getCurrentInstance()

isStateWritten	back to summary
public boolean isStateWritten()

release	back to summary
public void release()

write	back to summary
public 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 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 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 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 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 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 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 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 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 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

writingState	back to summary
public void writingState() Mark that state is about to be written. Contrary to what you'd expect, we cannot and should not assume that this location is really going to have state; it is perfectly legit to have a ResponseWriter that filters out content, and ignores an attempt to write out state at this point. So, we have to check after the fact to see if there really are state markers.

pack-priv final Class StateWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail