You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by mg...@apache.org on 2012/08/22 13:41:55 UTC

git commit: Improve IRequestCycleSettings javadoc about buffering response's headers.

Updated Branches:
  refs/heads/master aaf48b285 -> 43878fc8c


Improve IRequestCycleSettings javadoc about buffering response's headers.


Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/43878fc8
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/43878fc8
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/43878fc8

Branch: refs/heads/master
Commit: 43878fc8c470044923f3b599953a1c4ff2aef63b
Parents: aaf48b2
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
Authored: Wed Aug 22 14:41:17 2012 +0300
Committer: Martin Tzvetanov Grigorov <mg...@apache.org>
Committed: Wed Aug 22 14:41:17 2012 +0300

----------------------------------------------------------------------
 .../wicket/settings/IRequestCycleSettings.java     |   14 ++++++++++++--
 1 files changed, 12 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/wicket/blob/43878fc8/wicket-core/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java b/wicket-core/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java
index 2d8e3c6..6c871c6 100644
--- a/wicket-core/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java
+++ b/wicket-core/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java
@@ -140,7 +140,12 @@ public interface IRequestCycleSettings
 	void addResponseFilter(IResponseFilter responseFilter);
 
 	/**
-	 * @return True if this application buffers its responses
+	 * Decides whether to buffer the response's headers until the end of the request processing.
+	 * The buffering is needed if the application makes use of
+	 * {@link org.apache.wicket.Component#setResponsePage(org.apache.wicket.Page)} or
+	 * {@link org.apache.wicket.request.flow.ResetResponseException}
+	 *
+	 * @return {@code true} if the application should buffer the response's headers.
 	 */
 	boolean getBufferResponse();
 
@@ -196,8 +201,13 @@ public interface IRequestCycleSettings
 	Duration getTimeout();
 
 	/**
+	 * Sets a flag whether the application should buffer the response's headers until the end
+	 * of the request processing. The buffering is needed if the application makes use of
+	 * {@link org.apache.wicket.Component#setResponsePage(org.apache.wicket.Page)} or
+	 * {@link org.apache.wicket.request.flow.ResetResponseException}
+	 *
 	 * @param bufferResponse
-	 *            True if this application should buffer responses.
+	 *            {@code true} if the application should buffer response's headers.
 	 */
 	void setBufferResponse(boolean bufferResponse);