Mojarra 2.4.0 · com.sun.faces.application.view.WriteBehindStateWriter

Modifier and Type	Field and Description
private char[]	buf
private int	bufSize
private FacesContext	context
private static final ThreadLocal<WriteBehindStateWriter>	CUR_WRITER
private FastStringWriter	fWriter
private Writer	orig
private Writer	out
private Object	state
private static final int	STATE_MARKER_LEN
private boolean	stateWritten

Access	Constructor and Description
public	WriteBehindStateWriter(Writer the writer we write non-buffered content to out, FacesContext the `FacesContext` for the current request context, int the buffer size for post-processing buffered content bufSize) Constructs a new `WriteBehindStateWriter` instance.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. This is a no-op.
public void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. This is a no-op.
public void	flushToWriter() Write directly from our FastStringWriter to the provided writer.
public static WriteBehindStateWriter	Returns: the `WriteBehindStateWriter` being used for processing this request getCurrentInstance()
private static int	Returns: the index of the next delimiter, if any getNextDelimiterIndex(StringBuilder buffered content builder, int the offset to start the search from offset)
private StringBuilder	Returns: the state. getState(StateManager the state manager. stateManager, ResponseWriter the original response writer. origWriter) Get the state.
public void	release() Clear the ThreadLocal state.
public boolean	Returns: `true` if `writingState()` has been called, otherwise returns `false` stateWritten()
public void	write(int int specifying a character to be written c) Overrides java.io.Writer.write. Writes directly to the current `out`.
public void	write(char[] Array of characters to be written cbuf) Overrides java.io.Writer.write. Writes directly to the current `out`.
public void	write(String String to be written str) Overrides java.io.Writer.write. Writes directly to the current `out`.
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 directly to the current `out`.
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 directly to the current `out`.
public void	writingState() When called, the original writer is backed up and replaced with a new FastStringWriter.

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

buf	back to summary
private char[] buf

bufSize	back to summary
private int bufSize

context	back to summary
private FacesContext context

CUR_WRITER	back to summary
private static final ThreadLocal<WriteBehindStateWriter> CUR_WRITER

fWriter	back to summary
private FastStringWriter fWriter

orig	back to summary
private Writer orig

out	back to summary
private Writer out

state	back to summary
private Object state

STATE_MARKER_LEN	back to summary
private static final int STATE_MARKER_LEN

stateWritten	back to summary
private boolean stateWritten

WriteBehindStateWriter	back to summary
public WriteBehindStateWriter(Writer out, FacesContext context, int bufSize) Constructs a new `WriteBehindStateWriter` instance. Parameters out:Writer the writer we write non-buffered content to context:FacesContext the `FacesContext` for the current request bufSize:int the buffer size for post-processing buffered content

Method Detail

close	back to summary
public void close() throws IOException Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. This is a no-op. Annotations @Override Exceptions IOException: Doc from java.io.Writer.close. 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.

This is a no-op.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Writer.close.

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. This is a no-op. Annotations @Override Exceptions IOException: Doc from java.io.Writer.flush. 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.

This is a no-op.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Writer.flush.

If an I/O error occurs

flushToWriter	back to summary
public void flushToWriter() throws IOException Write directly from our FastStringWriter to the provided writer. Exceptions IOException: if an error occurs

flushToWriter

back to summary

public void flushToWriter() throws IOException

Write directly from our FastStringWriter to the provided writer.

Exceptions

IOException:: if an error occurs

getCurrentInstance	back to summary
public static WriteBehindStateWriter getCurrentInstance() Returns:WriteBehindStateWriter the `WriteBehindStateWriter` being used for processing this request

getNextDelimiterIndex	back to summary
private static int getNextDelimiterIndex(StringBuilder builder, int offset) Parameters builder:StringBuilder buffered content offset:int the offset to start the search from Returns:int the index of the next delimiter, if any

getState	back to summary
private StringBuilder getState(StateManager stateManager, ResponseWriter origWriter) throws IOException Get the state. In JSF 2.2 it is required by the specification that the view state hidden input in each h:form has a unique id. So we have to call this method multiple times as each h:form needs to generate the element id for itself. Parameters stateManager:StateManager the state manager. origWriter:ResponseWriter the original response writer. Returns:StringBuilder the state. Exceptions IOException: when an I/O error occurs.

getState

back to summary

private StringBuilder getState(StateManager stateManager, ResponseWriter origWriter) throws IOException

Get the state.

In JSF 2.2 it is required by the specification that the view state hidden input in each h:form has a unique id. So we have to call this method multiple times as each h:form needs to generate the element id for itself.

Parameters

stateManager:StateManager: the state manager.
origWriter:ResponseWriter: the original response writer.

Returns:StringBuilder

the state.

Exceptions

IOException:: when an I/O error occurs.

release	back to summary
public void release() Clear the ThreadLocal state.

stateWritten	back to summary
public boolean stateWritten() Returns:boolean `true` if `writingState()` has been called, otherwise returns `false`

write back to summary

write	back to summary
public void write(int c) throws IOException Overrides java.io.Writer.write. Writes directly to the current `out`. Parameters c:int Doc from java.io.Writer.write. int specifying a character to be written Annotations @Override Exceptions IOException: Doc from java.io.Writer.write. If an I/O error occurs See Also `Writer#write(int)`

public void write(int c) throws IOException

Overrides java.io.Writer.write.

Writes directly to the current out.

Parameters

c:int

Doc from java.io.Writer.write.

int specifying a character to be written

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Writer.write.

If an I/O error occurs

See Also

Writer#write(int)

write back to summary

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

public void write(char[] cbuf) throws IOException

Overrides java.io.Writer.write.

Writes directly to the current out.

Parameters

cbuf:char[]

Doc from java.io.Writer.write.

Array of characters to be written

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Writer.write.

If an I/O error occurs

See Also

Writer#write(char[])

write back to summary

write	back to summary
public void write(String str) throws IOException Overrides java.io.Writer.write. Writes directly to the current `out`. Parameters str:String Doc from java.io.Writer.write. String to be written Annotations @Override Exceptions IOException: Doc from java.io.Writer.write. If an I/O error occurs See Also `Writer#write(String)`

public void write(String str) throws IOException

Overrides java.io.Writer.write.

Writes directly to the current out.

Parameters

str:String

Doc from java.io.Writer.write.

String to be written

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Writer.write.

If an I/O error occurs

See Also

Writer#write(String)

write back to summary

write	back to summary
public void write(String str, int off, int len) throws IOException Overrides java.io.Writer.write. Writes directly to the current `out`. Parameters str:String Doc from java.io.Writer.write. A String off:int Doc from java.io.Writer.write. Offset from which to start writing characters len:int Doc from java.io.Writer.write. Number of characters to write Annotations @Override Exceptions IOException: Doc from java.io.Writer.write. If an I/O error occurs See Also `Writer#write(String, int, int)`

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

Overrides java.io.Writer.write.

Writes directly to the current out.

Parameters

str:String

Doc from java.io.Writer.write.

A String

off:int

Doc from java.io.Writer.write.

Offset from which to start writing characters

len:int

Doc from java.io.Writer.write.

Number of characters to write

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Writer.write.

If an I/O error occurs

See Also

Writer#write(String, int, int)

write back to summary

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

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

Implements abstract java.io.Writer.write.

Writes directly to the current out.

Parameters

cbuf:char[]

Doc from java.io.Writer.write.

Array of characters

off:int

Doc from java.io.Writer.write.

Offset from which to start writing characters

len:int

Doc from java.io.Writer.write.

Number of characters to write

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Writer.write.

If an I/O error occurs

See Also

Writer#write(char[], int, int)

writingState	back to summary
public void writingState() When called, the original writer is backed up and replaced with a new FastStringWriter. All content written after this method is called will then be buffered and written out later after the entire view has been rendered.

pack-priv final Class WriteBehindStateWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail