org.tinygroup.weblayer.webcontext.buffered

Interface BufferedWebContext

All Superinterfaces:

BaseContext, Context, Serializable, WebContext

All Known Implementing Classes:

BufferedWebContextImpl

public interface BufferedWebContext
extends WebContext

对response.getWriter()和response.getOutputStream() 所返回的输出流进行缓存操作。

Author:

renhui

Field Summary

Fields inherited from interface org.tinygroup.weblayer.WebContext

REQUEST_ATTRIBUTE_FROM_WEBCONTEXT

Method Summary

Modifier and Type	Method and Description
boolean	isBuffering() 设置是否将所有信息保存在内存中。
ByteArray	peekByteBuffer() 返回最上层的ByteArray
String	peekCharBuffer() 返回最上层的buffer
ByteArray	popByteBuffer() 弹出最近的buffer，如果堆栈中只有一个buffer，则弹出后再创建一个新的。
String	popCharBuffer() 弹出最近的buffer，如果堆栈中只有一个buffer，则弹出后再创建一个新的。
void	pushBuffer() 创建新的buffer，保存老的buffer。
void	setBuffering(boolean buffering) 设置buffer模式，如果设置成true，表示将所有信息保存在内存中，否则直接输出到原始response中。

Methods inherited from interface org.tinygroup.weblayer.WebContext

getObject, getRequest, getResponse, getServletContext, getWrappedWebContext, init, isRequestFinished, setObject, setRequest, setResponse, setServletContext

Methods inherited from interface org.tinygroup.context.Context

clearSubContext, createSubContext, getInSubContext, getItemMap, getParent, getSubContext, getSubContextMap, getTotalItemMap, put, putSubContext, remove, removeSubContext, setParent

Methods inherited from interface org.tinygroup.context.BaseContext

clear, contain, exist, get, get, put, putAll, remove, renameKey, size

Method Detail

isBuffering

boolean isBuffering()

设置是否将所有信息保存在内存中。

Returns:

如果是，则返回true

setBuffering

void setBuffering(boolean buffering)

设置buffer模式，如果设置成true，表示将所有信息保存在内存中，否则直接输出到原始response中。

此方法必须在getOutputStream和getWriter方法之前执行，否则将抛出 IllegalStateException。

Parameters:

buffering - 是否buffer内容

Throws:

IllegalStateException - getOutputStream或 getWriter方法已经被执行

pushBuffer

void pushBuffer()

创建新的buffer，保存老的buffer。

Throws:

IllegalStateException - 如果不在buffer模式，或getWriter及 getOutputStream方法从未被调用

popByteBuffer

ByteArray popByteBuffer()

弹出最近的buffer，如果堆栈中只有一个buffer，则弹出后再创建一个新的。

Returns:

最近的buffer内容

Throws:

IllegalStateException - 如果不在buffer模式，或getWriter 方法曾被调用，或 getOutputStream方法从未被调用

popCharBuffer

String popCharBuffer()

弹出最近的buffer，如果堆栈中只有一个buffer，则弹出后再创建一个新的。

Returns:

最近的buffer内容

Throws:

IllegalStateException - 如果不在buffer模式，或getOutputStream 方法曾被调用，或getWriter方法从未被调用

peekByteBuffer

ByteArray peekByteBuffer()

返回最上层的ByteArray

Returns:

最近的buffer内容

Throws:

IllegalStateException - 如果不在buffer模式，或getWriter 方法曾被调用，或 getOutputStream方法从未被调用

peekCharBuffer

String peekCharBuffer()

返回最上层的buffer

Returns:

最近的buffer内容

Throws:

IllegalStateException - 如果不在buffer模式，或getOutputStream 方法曾被调用，或getWriter方法从未被调用