Package org.apache.myfaces.view.facelets
Class StateWriter
java.lang.Object
java.io.Writer
org.apache.myfaces.view.facelets.StateWriter
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
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.
- Version:
- $Id$
- Author:
- Adam Winer
-
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionStateWriter
(Writer initialOut, int initialSize) StateWriter
(Writer initialOut, int initialSize, FacesContext facesContext) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
void
flush()
static StateWriter
static StateWriter
getCurrentInstance
(FacesContext facesContext) boolean
boolean
void
release()
void
release
(FacesContext facesContext) void
write
(char[] cbuf) void
write
(char[] cbuf, int off, int len) void
write
(int c) void
void
void
Mark that state is about to be written.void
Methods inherited from class java.io.Writer
append, append, append, nullWriter
-
Constructor Details
-
StateWriter
-
StateWriter
-
-
Method Details
-
getCurrentInstance
-
getCurrentInstance
-
writingState
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. -
isStateWritten
public boolean isStateWritten() -
writingStateWithoutWrapper
public void writingStateWithoutWrapper() -
isStateWrittenWithoutWrapper
public boolean isStateWrittenWithoutWrapper() -
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classWriter
- Throws:
IOException
-
flush
- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classWriter
- Throws:
IOException
-
write
- Specified by:
write
in classWriter
- Throws:
IOException
-
write
- Overrides:
write
in classWriter
- Throws:
IOException
-
write
- Overrides:
write
in classWriter
- Throws:
IOException
-
write
- Overrides:
write
in classWriter
- Throws:
IOException
-
write
- Overrides:
write
in classWriter
- Throws:
IOException
-
getAndResetBuffer
-
release
public void release() -
release
-