|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object wicket.Response
public abstract class Response
Abstract base class for different implementations of response writing. A subclass must implement write(String) to write a String to the response destination (whether it be a browser, a file, a test harness or some other place). A subclass may optionally implement close(), encodeURL(String), redirect(String), isRedirect() or setContentType(String) as appropriate.
Constructor Summary | |
---|---|
Response()
|
Method Summary | |
---|---|
void |
close()
Closes the response output stream |
java.lang.CharSequence |
encodeURL(java.lang.CharSequence url)
An implementation of this method is only required if a subclass wishes to support sessions via URL rewriting. |
AppendingStringBuffer |
filter(AppendingStringBuffer responseBuffer)
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. |
java.lang.String |
getCharacterEncoding()
Get the default encoding |
abstract java.io.OutputStream |
getOutputStream()
|
boolean |
isRedirect()
Returns true if a redirection has occurred. |
void |
println(java.lang.CharSequence string)
Writes the given string to the Response subclass output destination and appends a cr/nl depending on the OS |
void |
redirect(java.lang.String url)
CLIENTS SHOULD NEVER CALL THIS METHOD FOR DAY TO DAY USE! |
void |
reset()
Called when the Response needs to reset itself. |
void |
setCharacterEncoding(java.lang.String encoding)
Set the default encoding for the output. |
void |
setContentLength(long length)
Set the content length on the response, if appropriate in the subclass. |
void |
setContentType(java.lang.String mimeType)
Set the content type on the response, if appropriate in the subclass. |
void |
setLastModifiedTime(Time time)
Set the contents last modified time, if appropriate in the subclass. |
void |
setLocale(java.util.Locale locale)
|
abstract void |
write(java.lang.CharSequence string)
Writes the given string to the Response subclass output destination. |
void |
write(ComponentTag tag)
Writes the given tag to via the write(String) abstract method. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Response()
Method Detail |
---|
public void close()
public void reset()
public java.lang.CharSequence encodeURL(java.lang.CharSequence url)
url
- The URL to encode
public final AppendingStringBuffer filter(AppendingStringBuffer responseBuffer)
responseBuffer
- The response buffer to be filtered
public java.lang.String getCharacterEncoding()
public abstract java.io.OutputStream getOutputStream()
public boolean isRedirect()
public void redirect(java.lang.String url)
A subclass may override this method to implement redirection. Subclasses which have no need to do redirection may choose not to override this default implementation, which does nothing. For example, if a subclass wishes to write output to a file or is part of a testing harness, there may be no meaning to redirection.
url
- The URL to redirect topublic void setCharacterEncoding(java.lang.String encoding)
encoding
- public void setContentLength(long length)
length
- The length of the contentpublic void setContentType(java.lang.String mimeType)
mimeType
- The mime typepublic void setLastModifiedTime(Time time)
time
- The time objectpublic void setLocale(java.util.Locale locale)
locale
- Locale to use for this responsepublic final void write(ComponentTag tag)
tag
- The tag to writepublic abstract void write(java.lang.CharSequence string)
string
- The string to writepublic final void println(java.lang.CharSequence string)
string
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |