You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by gs...@apache.org on 2007/10/14 02:46:05 UTC
svn commit: r584462 - in
/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket: ./
markup/parser/ model/ protocol/http/ protocol/http/request/ request/
request/target/component/listener/ session/ settings/ util/io/
Author: gseitz
Date: Sat Oct 13 17:46:03 2007
New Revision: 584462
URL: http://svn.apache.org/viewvc?rev=584462&view=rev
Log:
WICKET-1043 + several other javadoc typos; some files were reformatted since they still were in non wicket formatting style
Modified:
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Component.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IPageFactory.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IRequestTarget.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Page.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestCycle.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestListenerInterface.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/parser/IMarkupFilter.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/model/Model.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/AbstractHttpSessionStore.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/request/WebRequestCodingStrategy.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/RequestParameters.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/target/component/listener/ListenerInterfaceRequestTarget.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/session/ISessionStore.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java
wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/io/IObjectStreamFactory.java
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Component.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Component.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Component.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Component.java Sat Oct 13 17:46:03 2007
@@ -561,8 +561,9 @@
private static final int FLAG_OUTPUT_MARKUP_ID = 0x4000;
/**
- * Ouput a placeholder tag if the component is not visible. This is useful in ajax mode to go to
- * visible(false) to visible(true) without the overhead of repaiting a visible parent container
+ * Output a placeholder tag if the component is not visible. This is useful in ajax mode to go
+ * to visible(false) to visible(true) without the overhead of repainting a visible parent
+ * container
*/
private static final int FLAG_PLACEHOLDER = 0x8000;
@@ -756,8 +757,8 @@
}
/**
- * Called on very component after the page is renderd It will call onAfterRender for it self and
- * its childeren.
+ * Called on very component after the page is rendered. It will call onAfterRender for it self
+ * and its children.
*/
public final void afterRender()
{
@@ -1123,7 +1124,7 @@
}
/**
- * Gets the locale for this component. By default, it searches it parent for a locale. If no
+ * Gets the locale for this component. By default, it searches its parents for a locale. If no
* parents (it's a recursive search) returns a locale, it gets one from the session.
*
* @return The locale to be used for this component
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IPageFactory.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IPageFactory.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IPageFactory.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IPageFactory.java Sat Oct 13 17:46:03 2007
@@ -23,7 +23,7 @@
* <p>
* IMPORTANT NOTE: Implementations must let subclasses of
* {@link org.apache.wicket.AbstractRestartResponseException} thrown from the constructing
- * page' constructor bubble up.
+ * page's constructor bubble up.
*
* @see org.apache.wicket.settings.ISessionSettings#setPageFactory(IPageFactory)
* @see Session#getPageFactory()
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IRequestTarget.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IRequestTarget.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IRequestTarget.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/IRequestTarget.java Sat Oct 13 17:46:03 2007
@@ -18,19 +18,17 @@
/**
* <p>
- * A request target is the base entity that is the subject of a request.
- * Different types of request have different request targets. For instance a
- * request for a bookmarkable page differs from a request for a link on a
- * previously rendered page, which in turn differs from a request for a shared
- * resource.
+ * A request target is the base entity that is the subject of a request. Different types of request
+ * have different request targets. For instance a request for a bookmarkable page differs from a
+ * request for a link on a previously rendered page, which in turn differs from a request for a
+ * shared resource.
* </p>
* <p>
* It is very important (for mounting) that implementations implement
- * {@link java.lang.Object#equals(java.lang.Object)} and
- * {@link java.lang.Object#hashCode()} in a consistent way.
+ * {@link java.lang.Object#equals(java.lang.Object)} and {@link java.lang.Object#hashCode()} in a
+ * consistent way.
* </p>
- * Typically, implementations of IRequestTarget are not meant to be used more
- * than once.
+ * Typically, implementations of IRequestTarget are not meant to be used more than once.
*
* @author Eelco Hillenius
*/
@@ -45,9 +43,8 @@
void respond(RequestCycle requestCycle);
/**
- * This method is alled on the end of a request cycle to indicate that
- * processing is done and that cleaning up of the subject(s) of this target
- * may be done.
+ * This method is called at the end of a request cycle to indicate that processing is done and
+ * that cleaning up of the subject(s) of this target may be done.
*
* @param requestCycle
* the current request cycle
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Page.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Page.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Page.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/Page.java Sat Oct 13 17:46:03 2007
@@ -708,7 +708,7 @@
* statefull urls, and components on statefull page must not render any stateless urls.
* Statefull urls are urls, which refer to a certain (current) page instance.
*
- * @return Whether to page is stateless
+ * @return Whether this page is stateless
*/
public final boolean isPageStateless()
{
@@ -796,7 +796,7 @@
// They must be of type Form as well
if (component instanceof Form)
{
- // Delete persistet FormComponent data and disable
+ // Delete persistent FormComponent data and disable
// persistence
((Form)component).removePersistentFormComponentValues(disablePersistence);
}
@@ -1246,11 +1246,11 @@
* by an application setting (@see ApplicationSettings#getResponseRequestEncoding()). In
* addition, if the page's markup contains a xml declaration like <?xml ... ?> an xml
* declaration with proper encoding information is written to the output as well, provided it is
- * not disabled by an applicaton setting (@see
+ * not disabled by an application setting (@see
* ApplicationSettings#getStripXmlDeclarationFromOutput()).
* <p>
* Note: Prior to Wicket 1.1 the output encoding was determined by the page's markup encoding.
- * Because this caused uncertainties about the /request/ encoding, it has been changed in favour
+ * Because this caused uncertainties about the /request/ encoding, it has been changed in favor
* of the new, much safer, approach. Please see the Wiki for more details.
*/
protected void configureResponse()
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestCycle.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestCycle.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestCycle.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestCycle.java Sat Oct 13 17:46:03 2007
@@ -256,7 +256,7 @@
protected Response response;
/**
- * Boolean if the next to be encoded url is targetting a new window (ModalWindow, popup, tab).
+ * Boolean if the next to be encoded url is targeting a new window (ModalWindow, popup, tab).
* This temporary flag is specifically needed for portlet-support as then such a page needs a
* special target (Resource) url. After each urlFor call, this flag is reset to false.
*/
@@ -308,7 +308,7 @@
}
/**
- * Get the orignal respone the request was create with. Access may be necessary with the
+ * Get the original response the request was create with. Access may be necessary with the
* response has temporarily being replaced but your components requires access to lets say the
* cookie methods of a WebResponse.
*
@@ -625,7 +625,7 @@
}
/**
- * Atempts to return name of current page map
+ * Attempts to return name of current page map
*
* @return
*/
@@ -713,7 +713,7 @@
}
/**
- * @return true if the next to be encoded url is targetting a new window (ModalWindow, popup,
+ * @return true if the next to be encoded url is targeting a new window (ModalWindow, popup,
* tab).
*/
public final boolean isUrlForNewWindowEncoding()
@@ -722,7 +722,7 @@
}
/**
- * Indicate if the next to be encoded url is targetting a new window (ModalWindow, popup, tab).
+ * Indicate if the next to be encoded url is targeting a new window (ModalWindow, popup, tab).
* This temporary flag is specifically needed for portlet-support as then such a page needs a
* special target (Resource) url. After each urlFor call, this flag is reset to false.
*/
@@ -763,18 +763,18 @@
}
/**
- * Returns a URL that references a given interface on a given behaviour of a component. When the
- * URL is requested from the server at a later time, the interface on the behaviour will be
+ * Returns a URL that references a given interface on a given behavior of a component. When the
+ * URL is requested from the server at a later time, the interface on the behavior will be
* called. A URL returned by this method will not be stable across sessions and cannot be
* bookmarked by a user.
*
* @param component
* The component to reference
* @param behaviour
- * The behaviour to reference
+ * The behavior to reference
* @param listener
* The listener interface on the component
- * @return A URL that encodes a page, component, behaviour and interface to call
+ * @return A URL that encodes a page, component, behavior and interface to call
*/
public final CharSequence urlFor(final Component component, final IBehavior behaviour,
final RequestListenerInterface listener)
@@ -979,7 +979,7 @@
if (automaticallyClearFeedbackMessages)
{
- // remove any rendered and otherwise obsolute feedback messages from
+ // remove any rendered and otherwise obsolete feedback messages from
// the session
try
{
@@ -1315,7 +1315,7 @@
}
/**
- * Called when an unrecoverable runtime exception during request cycle handling occured, which
+ * Called when an unrecoverable runtime exception during request cycle handling occurred, which
* will result in displaying a user facing error page. Clients can override this method in case
* they want to customize logging. NOT called for
* {@link PageExpiredException page expired exceptions}.
@@ -1379,7 +1379,7 @@
*
* @param key
* The key for the data
- * @return The metadata or null of no metadata was found for the given key
+ * @return The metadata or null if no metadata was found for the given key
* @see MetaDataKey
*/
public final Serializable getMetaData(final MetaDataKey key)
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestListenerInterface.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestListenerInterface.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestListenerInterface.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/RequestListenerInterface.java Sat Oct 13 17:46:03 2007
@@ -63,16 +63,15 @@
private final String name;
/**
- * Whether or not this listener is targetted for a specific page version. If
- * recordVersion is true the page will be rolled back to the version which
- * created the url, if false the latest version of the page will be used.
+ * Whether or not this listener is targeted for a specific page version. If recordVersion is
+ * true the page will be rolled back to the version which created the url, if false the latest
+ * version of the page will be used.
*/
private boolean recordsPageVersion = true;
/**
- * Constructor that creates listener interfaces which record the page
- * version.
+ * Constructor that creates listener interfaces which record the page version.
*
* @param listenerInterfaceClass
* The interface class, which must extend IRequestListener.
@@ -89,17 +88,16 @@
* @param listenerInterfaceClass
* The interface class, which must extend IRequestListener.
* @param recordsPageVersion
- * Whether or not urls encoded for this interface contain the
- * page version. If set to false the latest page version is
- * always used.
+ * Whether or not urls encoded for this interface contain the page version. If set to
+ * false the latest page version is always used.
*/
public RequestListenerInterface(final Class listenerInterfaceClass, boolean recordsPageVersion)
{
- // Ensure that i extends IRequestListener
+ // Ensure that it extends IRequestListener
if (!IRequestListener.class.isAssignableFrom(listenerInterfaceClass))
{
- throw new IllegalArgumentException("Class " + listenerInterfaceClass
- + " must extend IRequestListener");
+ throw new IllegalArgumentException("Class " + listenerInterfaceClass +
+ " must extend IRequestListener");
}
this.recordsPageVersion = recordsPageVersion;
@@ -113,22 +111,22 @@
// and that method takes no parameters
if (methods[0].getParameterTypes().length == 0)
{
- this.method = methods[0];
+ method = methods[0];
}
else
{
- throw new IllegalArgumentException("Method " + methods[0] + " in interface "
- + listenerInterfaceClass + " cannot take any arguments");
+ throw new IllegalArgumentException("Method " + methods[0] + " in interface " +
+ listenerInterfaceClass + " cannot take any arguments");
}
}
else
{
- throw new IllegalArgumentException("Interface " + listenerInterfaceClass
- + " can have only one method");
+ throw new IllegalArgumentException("Interface " + listenerInterfaceClass +
+ " can have only one method");
}
// Save short class name
- this.name = Classes.simpleName(listenerInterfaceClass);
+ name = Classes.simpleName(listenerInterfaceClass);
// Register this listener
register();
@@ -151,9 +149,8 @@
}
/**
- * @return true if urls encoded for this interface should record the page
- * version, false if they should always be encoded for the latest
- * page version
+ * @return true if urls encoded for this interface should record the page version, false if they
+ * should always be encoded for the latest page version
*/
public final boolean getRecordsPageVersion()
{
@@ -188,21 +185,21 @@
catch (InvocationTargetException e)
{
// Honor redirect exception contract defined in IPageFactory
- if (e.getTargetException() instanceof AbstractRestartResponseException
- || e.getTargetException() instanceof AuthorizationException
- || e.getTargetException() instanceof WicketRuntimeException)
+ if (e.getTargetException() instanceof AbstractRestartResponseException ||
+ e.getTargetException() instanceof AuthorizationException ||
+ e.getTargetException() instanceof WicketRuntimeException)
{
throw (RuntimeException)e.getTargetException();
}
- throw new WicketRuntimeException("Method " + method.getName() + " of "
- + method.getDeclaringClass() + " targeted at component " + component
- + " threw an exception", e);
+ throw new WicketRuntimeException("Method " + method.getName() + " of " +
+ method.getDeclaringClass() + " targeted at component " + component +
+ " threw an exception", e);
}
catch (Exception e)
{
- throw new WicketRuntimeException("Method " + method.getName() + " of "
- + method.getDeclaringClass() + " targeted at component " + component
- + " threw an exception", e);
+ throw new WicketRuntimeException("Method " + method.getName() + " of " +
+ method.getDeclaringClass() + " targeted at component " + component +
+ " threw an exception", e);
}
finally
{
@@ -250,13 +247,11 @@
/**
* THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.
* <p>
- * In previous versions of Wicket, request listeners were manually
- * registered by calling this method. Now there is a first class
- * RequestListenerInterface object which should be constructed as a constant
- * member of the interface to enable automatic interface registration.
+ * In previous versions of Wicket, request listeners were manually registered by calling this
+ * method. Now there is a first class RequestListenerInterface object which should be
+ * constructed as a constant member of the interface to enable automatic interface registration.
* <p>
- * Adds a request listener interface to the map of interfaces that can be
- * invoked by outsiders.
+ * Adds a request listener interface to the map of interfaces that can be invoked by outsiders.
*
* @param requestListenerInterface
* The request listener interface object
@@ -268,13 +263,13 @@
// already been registered
final RequestListenerInterface existingInterface = RequestListenerInterface
.forName(requestListenerInterface.getName());
- if (existingInterface != null
- && existingInterface.getMethod() != requestListenerInterface.getMethod())
+ if (existingInterface != null &&
+ existingInterface.getMethod() != requestListenerInterface.getMethod())
{
- throw new IllegalStateException("Cannot register listener interface "
- + requestListenerInterface
- + " because it conflicts with the already registered interface "
- + existingInterface);
+ throw new IllegalStateException("Cannot register listener interface " +
+ requestListenerInterface +
+ " because it conflicts with the already registered interface " +
+ existingInterface);
}
// Save this interface method by the non-qualified class name
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/parser/IMarkupFilter.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/parser/IMarkupFilter.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/parser/IMarkupFilter.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/parser/IMarkupFilter.java Sat Oct 13 17:46:03 2007
@@ -45,7 +45,7 @@
/**
* Get the next MarkupElement from the parent MarkupFilter and handle it if
* the specific filter criteria are met. Depending on the filter, it may
- * return the MarkupElement unchanged, modified or it remove by asking the
+ * return the MarkupElement unchanged, modified or remove it by asking the
* parent handler for the next tag.
*
* @return Return the next eligible MarkupElement
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/model/Model.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/model/Model.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/model/Model.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/model/Model.java Sat Oct 13 17:46:03 2007
@@ -27,9 +27,9 @@
/**
- * Model is the basic implementation of an AbstractModel. It just wraps a simple
- * model object. The model object must be serializable, as it is stored in the
- * session. If you have large objects to store, consider using
+ * <code>Model</code> is the basic implementation of an <code>IModel</code>. It just wraps a
+ * simple model object. The model object must be serializable, as it is stored in the session. If
+ * you have large objects to store, consider using
* {@link org.apache.wicket.model.LoadableDetachableModel} instead of this class.
*
* @author Chris Turner
@@ -89,8 +89,8 @@
}
/**
- * Set the model object; calls setObject(java.io.Serializable). The model
- * object must be serializable, as it is stored in the session
+ * Set the model object; calls setObject(java.io.Serializable). The model object must be
+ * serializable, as it is stored in the session
*
* @param object
* the model object
@@ -109,8 +109,7 @@
}
/**
- * Sets the model object. The model object must be serializable, as it is
- * stored in the session
+ * Sets the model object. The model object must be serializable, as it is stored in the session
*
* @param object
* The serializable model object
@@ -135,7 +134,7 @@
{
StringBuffer sb = new StringBuffer("Model:classname=[");
sb.append(getClass().getName()).append("]");
- sb.append(":object=[").append(this.object).append("]");
+ sb.append(":object=[").append(object).append("]");
return sb.toString();
}
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/AbstractHttpSessionStore.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/AbstractHttpSessionStore.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/AbstractHttpSessionStore.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/AbstractHttpSessionStore.java Sat Oct 13 17:46:03 2007
@@ -37,7 +37,7 @@
/**
* Abstract implementation of {@link ISessionStore} that works with web applications and that
- * provided some speficic http servlet/ session related functionality.
+ * provided some specific http servlet/ session related functionality.
*
* @author jcompagner
* @author Eelco Hillenius
@@ -284,7 +284,7 @@
* <p>
* WARNING: it is a bad idea to depend on the http session object directly. Please use the
* classes and methods that are exposed by Wicket instead. Send an email to the mailing list in
- * case it is not clear how to do things or you think you miss funcionality which causes you to
+ * case it is not clear how to do things or you think you miss functionality which causes you to
* depend on this directly.
* </p>
*
@@ -345,4 +345,4 @@
}
return (WebRequest)request;
}
-}
\ No newline at end of file
+}
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/WebApplication.java Sat Oct 13 17:46:03 2007
@@ -451,7 +451,7 @@
/**
* THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL IT.
*
- * Internal intialization. First determine the deployment mode. First check the system property
+ * Internal initialization. First determine the deployment mode. First check the system property
* -Dwicket.configuration. If it does not exist check the servlet init parameter (
* <code><init-param><param-name>configuration</param-name></code>). If not
* found check the servlet context init paramert
@@ -531,8 +531,8 @@
}
/**
- * Gets a new request cycle processor for web requests. May be replaced by subclasses which
- * whishes to uses there own implementation of IRequestCycleProcessor.
+ * Gets a new request cycle processor for web requests. May be replaced by subclasses which wish
+ * to use their own implementation of IRequestCycleProcessor.
*
* NOTE this can't be moved to application as portlets use two different request cycle
* processors, and hence have two different methods for them, depending on the kind of request.
@@ -578,7 +578,7 @@
servletResponse) : new WebResponse(servletResponse));
}
- /*
+ /**
* Set the application key value
*/
protected final void setApplicationKey(String applicationKey)
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/request/WebRequestCodingStrategy.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/request/WebRequestCodingStrategy.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/request/WebRequestCodingStrategy.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/request/WebRequestCodingStrategy.java Sat Oct 13 17:46:03 2007
@@ -155,7 +155,7 @@
* conflicts. <br />
* For example: <br/> we mount Page1 on /page and Page2 on /page/test <br />
* Page1 uses a parameters encoder that only encodes parameter values <br />
- * now suppose we want to access Page1 with a single paramter param="test". we have a url
+ * now suppose we want to access Page1 with a single parameter param="test". we have a url
* collision since both pages can be access with /page/test <br />
* the sorting by longest path first guarantees that the iterator will return the mount
* /page/test before it returns mount /page therefore giving deterministic behavior to path
@@ -223,7 +223,7 @@
* Otherwise, one of the delegation methods will be called. In case you are using custom targets
* that are not part of the default target hierarchy, you need to override
* {@link #doEncode(RequestCycle, IRequestTarget)}, which will be called after the defaults
- * have been tried. When that doesn't provide a url either, and exception will be thrown saying
+ * have been tried. When that doesn't provide a url either, an exception will be thrown saying
* that encoding could not be done.
*
* @see org.apache.wicket.request.IRequestCodingStrategy#encode(org.apache.wicket.RequestCycle,
@@ -353,13 +353,17 @@
return requestCycle.getOriginalResponse().encodeURL(result);
}
- // Just return null intead of throwing an exception. So that it can be
+ // Just return null instead of throwing an exception. So that it can be
// handled better
return null;
}
/**
- * @see org.apache.wicket.request.IRequestCodingStrategy#encode(java.lang.CharSequence)
+ * Returns the given url encoded.
+ *
+ * @param url
+ * The URL to encode
+ * @return The encoded url
*/
public CharSequence encode(CharSequence url)
{
@@ -500,7 +504,7 @@
*
* If you override this method to behave differently then
* {@link #encode(RequestCycle, IBookmarkablePageRequestTarget)} should also be overridden to be
- * in sync with that behaviour.
+ * in sync with that behavior.
*
* @param request
* the incoming request
@@ -537,8 +541,8 @@
* Adds page related parameters (path and pagemap and optionally version and interface).
*
* If you override this method to behave different then also
- * {@link #encode(RequestCycle, IListenerInterfaceRequestTarget)} should be overridden to by in
- * sync with that behaviour.
+ * {@link #encode(RequestCycle, IListenerInterfaceRequestTarget)} should be overridden to be in
+ * sync with that behavior.
*
* @param request
* the incoming request
@@ -617,7 +621,7 @@
}
parameters.setUrlDepth(urlDepth);
- // Extract behaviour ID after last colon
+ // Extract behavior ID after last colon
final String behaviourId = pathComponents[pathComponents.length - 2];
parameters.setBehaviorId(behaviourId.length() != 0 ? behaviourId : null);
@@ -640,11 +644,11 @@
* override this method; hence if a mount is found, this method will not be called.
*
* If you override this method to behave different then also
- * {@link #encode(RequestCycle, ISharedResourceRequestTarget)} should be overridden to by in
- * sync with that behaviour.
+ * {@link #encode(RequestCycle, ISharedResourceRequestTarget)} should be overridden to be in
+ * sync with that behavior.
*
* @param request
- * the incomming request
+ * the incoming request
* @param parameters
* the parameters object to set the found values on
*/
@@ -695,8 +699,8 @@
* Encode a page class target.
*
* If you override this method to behave different then also
- * {@link #addBookmarkablePageParameters(Request, RequestParameters)} should be overridden to by
- * in sync with that behaviour.
+ * {@link #addBookmarkablePageParameters(Request, RequestParameters)} should be overridden to be
+ * in sync with that behavior.
*
* @param requestCycle
* the current request cycle
@@ -790,8 +794,8 @@
* Encode a shared resource target.
*
* If you override this method to behave different then also
- * {@link #addResourceParameters(Request, RequestParameters)} should be overridden to by in sync
- * with that behaviour.
+ * {@link #addResourceParameters(Request, RequestParameters)} should be overridden to be in sync
+ * with that behavior.
*
* @param requestCycle
* the current request cycle
@@ -838,8 +842,8 @@
* Encode a listener interface target.
*
* If you override this method to behave different then also
- * {@link #addInterfaceParameters(Request, RequestParameters)} should be overridden to by in
- * sync with that behaviour.
+ * {@link #addInterfaceParameters(Request, RequestParameters)} should be overridden to be in
+ * sync with that behavior.
*
* @param requestCycle
* the current request cycle
@@ -1008,7 +1012,7 @@
/**
* Checks if the specified path matches any mount, and if so returns the coding strategy for
- * that mount. Returns null if the path doesnt match any mounts.
+ * that mount. Returns null if the path doesn't match any mounts.
*
* NOTE: path here is not the mount - it is the full url path
*
@@ -1081,7 +1085,7 @@
* Gets the coding strategy for the specified mount path
*
* @param mount
- * mount paht
+ * mount path
* @return associated coding strategy or null if none
*/
public IRequestTargetUrlCodingStrategy strategyForMount(String mount)
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/RequestParameters.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/RequestParameters.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/RequestParameters.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/RequestParameters.java Sat Oct 13 17:46:03 2007
@@ -30,7 +30,7 @@
* <p>
* Object that abstracts common request parameters. It consists of possible
* optional parameters that can be translated from e.g. servlet request
- * parameters and serves of a strongly typed variant of these that is to be
+ * parameters and serves as a strongly typed variant of these that is to be
* created by the {@link org.apache.wicket.request.IRequestCycleProcessor}'s
* {@link org.apache.wicket.request.IRequestCodingStrategy}.
* </p>
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/target/component/listener/ListenerInterfaceRequestTarget.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/target/component/listener/ListenerInterfaceRequestTarget.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/target/component/listener/ListenerInterfaceRequestTarget.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/request/target/component/listener/ListenerInterfaceRequestTarget.java Sat Oct 13 17:46:03 2007
@@ -24,7 +24,7 @@
/**
* Target that denotes a page instance and a call to a component on that page
- * using an listener interface method.
+ * using a listener interface method.
*
* @author Eelco Hillenius
*/
@@ -72,4 +72,4 @@
onProcessEvents(requestCycle);
getRequestListenerInterface().invoke(getPage(), getTarget());
}
-}
\ No newline at end of file
+}
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/session/ISessionStore.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/session/ISessionStore.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/session/ISessionStore.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/session/ISessionStore.java Sat Oct 13 17:46:03 2007
@@ -28,8 +28,7 @@
/**
- * The actual store that is used by {@link org.apache.wicket.Session} to store
- * its attributes.
+ * The actual store that is used by {@link org.apache.wicket.Session} to store its attributes.
*
* @author Eelco Hillenius
* @author Johan Compagner
@@ -87,32 +86,29 @@
void setAttribute(Request request, String name, Object value);
/**
- * Get the session id for the provided request. It create is false and the
- * creation of the actual session is deferred, this method should return
- * null to reflect it doesn't have one.
+ * Get the session id for the provided request. If create is false and the creation of the
+ * actual session is deferred, this method should return null to reflect it doesn't have one.
*
* @param request
* The request
* @param create
- * Whether to create an actual session (typically an instance of
- * {@link HttpSession}) when not already done so
- * @return The session id for the provided request, possibly null if create
- * is false and the creation of the actual session was deferred
+ * Whether to create an actual session (typically an instance of {@link HttpSession})
+ * when not already done so
+ * @return The session id for the provided request, possibly null if create is false and the
+ * creation of the actual session was deferred
*/
String getSessionId(Request request, boolean create);
/**
* Retrieves the session for the provided request from this facade.
* <p>
- * This method should return null if it is not bound yet, so that Wicket can
- * recognize that it should create a session and call
- * {@link #bind(Request, Session)} right after that.
+ * This method should return null if it is not bound yet, so that Wicket can recognize that it
+ * should create a session and call {@link #bind(Request, Session)} right after that.
* </p>
*
* @param request
* The current request
- * @return The session for the provided request or null if the session was
- * not bound
+ * @return The session for the provided request or null if the session was not bound
*/
Session lookup(Request request);
@@ -120,7 +116,7 @@
* Adds the provided new session to this facade using the provided request.
*
* @param request
- * The request that triggered making a new sesion
+ * The request that triggered making a new session
* @param newSession
* The new session
*/
@@ -130,13 +126,13 @@
* Removes a session from this facade
*
* @param sessionId
- * The id of the session that must be unbinded.
+ * The id of the session that must be unbound.
*/
void unbind(String sessionId);
/**
- * Called at the start of a request. It can be used for example to rebuild
- * server state from the client request.
+ * Called at the start of a request. It can be used for example to rebuild server state from the
+ * client request.
*
* @param request
* The request object
@@ -144,8 +140,8 @@
void onBeginRequest(Request request);
/**
- * Called at the end of a request. It can be used for instance to release
- * temporary server state when using client state saving.
+ * Called at the end of a request. It can be used for instance to release temporary server state
+ * when using client state saving.
*
* @param request
* The request
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/settings/IRequestCycleSettings.java Sat Oct 13 17:46:03 2007
@@ -31,63 +31,54 @@
/**
* Interface for request related settings
* <p>
- * <i>bufferResponse </i> (defaults to true) - True if the application should
- * buffer responses. This does require some additional memory, but helps keep
- * exception displays accurate because the whole rendering process completes
- * before the page is sent to the user, thus avoiding the possibility of a
- * partially rendered page.
+ * <i>bufferResponse </i> (defaults to true) - True if the application should buffer responses. This
+ * does require some additional memory, but helps keep exception displays accurate because the whole
+ * rendering process completes before the page is sent to the user, thus avoiding the possibility of
+ * a partially rendered page.
* <p>
- * <i>renderStrategy </i>- Sets in what way the render part of a request is
- * handled. Basically, there are two different options:
+ * <i>renderStrategy </i>- Sets in what way the render part of a request is handled. Basically,
+ * there are two different options:
* <ul>
- * <li>Direct, ApplicationSettings.ONE_PASS_RENDER. Everything is handled in
- * one physical request. This is efficient, and is the best option if you want
- * to do sophisticated clustering. It does not however, shield you from what is
- * commonly known as the <i>Double submit problem </i></li>
+ * <li>Direct, ApplicationSettings.ONE_PASS_RENDER. Everything is handled in one physical request.
+ * This is efficient, and is the best option if you want to do sophisticated clustering. It does not
+ * however, shield you from what is commonly known as the <i>Double submit problem </i></li>
* <li>Using a redirect. This follows the pattern <a
- * href="http://www.theserverside.com/articles/article.tss?l=RedirectAfterPost"
- * >as described at the serverside </a> and that is commonly known as Redirect
- * after post. Wicket takes it one step further to do any rendering after a
- * redirect, so that not only form submits are shielded from the double submit
- * problem, but also the IRequestListener handlers (that could be e.g. a link
- * that deletes a row). With this pattern, you have two options to choose from:
+ * href="http://www.theserverside.com/articles/article.tss?l=RedirectAfterPost" >as described at the
+ * serverside </a> and that is commonly known as Redirect after post. Wicket takes it one step
+ * further to do any rendering after a redirect, so that not only form submits are shielded from the
+ * double submit problem, but also the IRequestListener handlers (that could be e.g. a link that
+ * deletes a row). With this pattern, you have two options to choose from:
* <ul>
- * <li>ApplicationSettings.REDIRECT_TO_RENDER. This option first handles the
- * 'action' part of the request, which is either page construction (bookmarkable
- * pages or the home page) or calling a IRequestListener handler, such as
- * Link.onClick. When that part is done, a redirect is issued to the render
- * part, which does all the rendering of the page and its components. <strong>Be
- * aware </strong> that this may mean, depending on whether you access any
- * models in the action part of the request, that attachement and detachement of
- * some models is done twice for a request.</li>
- * <li>ApplicationSettings.REDIRECT_TO_BUFFER. This option handles both the
- * action- and the render part of the request in one physical request, but
- * instead of streaming the result to the browser directly, it is kept in
- * memory, and a redirect is issue to get this buffered result (after which it
- * is immediately removed). This option currently is the default render
- * strategy, as it shields you from the double submit problem, while being more
- * efficient and less error prone regarding to detachable models.</li>
+ * <li>ApplicationSettings.REDIRECT_TO_RENDER. This option first handles the 'action' part of the
+ * request, which is either page construction (bookmarkable pages or the home page) or calling a
+ * IRequestListener handler, such as Link.onClick. When that part is done, a redirect is issued to
+ * the render part, which does all the rendering of the page and its components. <strong>Be aware
+ * </strong> that this may mean, depending on whether you access any models in the action part of
+ * the request, that attachment and detachment of some models is done twice for a request.</li>
+ * <li>ApplicationSettings.REDIRECT_TO_BUFFER. This option handles both the action- and the render
+ * part of the request in one physical request, but instead of streaming the result to the browser
+ * directly, it is kept in memory, and a redirect is issue to get this buffered result (after which
+ * it is immediately removed). This option currently is the default render strategy, as it shields
+ * you from the double submit problem, while being more efficient and less error prone regarding to
+ * detachable models.</li>
* </ul>
* </li>
* </ul>
- * Note that this parameter sets the default behavior, but that you can manually
- * set whether any redirecting is done by calling method
- * RequestCycle.setRedirect. Setting the redirect flag when the application is
- * configured to use ONE_PASS_RENDER, will result in a redirect of type
- * REDIRECT_TO_RENDER. When the application is configured to use
- * REDIRECT_TO_RENDER or REDIRECT_TO_BUFFER, setting the redirect flag to false,
- * will result in that request begin rendered and streamed in one pass.
+ * Note that this parameter sets the default behavior, but that you can manually set whether any
+ * redirecting is done by calling method RequestCycle.setRedirect. Setting the redirect flag when
+ * the application is configured to use ONE_PASS_RENDER, will result in a redirect of type
+ * REDIRECT_TO_RENDER. When the application is configured to use REDIRECT_TO_RENDER or
+ * REDIRECT_TO_BUFFER, setting the redirect flag to false, will result in that request begin
+ * rendered and streamed in one pass.
* <p>
- * More documentation is available about each setting in the setter method for
- * the property.
+ * More documentation is available about each setting in the setter method for the property.
*
* @author Igor Vaynberg (ivaynberg)
*/
public interface IRequestCycleSettings
{
/**
- * Enumerated type for different ways of handling the render part of
- * requests.
+ * Enumerated type for different ways of handling the render part of requests.
*/
public static class RenderStrategy extends EnumeratedType
{
@@ -100,66 +91,60 @@
}
/**
- * All logical parts of a request (the action and render part) are handled
- * within the same request. To enable a the client side redirect for a
- * request, users can set the 'redirect' property of {@link RequestCycle}to
- * true (getRequestCycle.setRedirect(true)), after which the behavior will
- * be like RenderStragegy 'REDIRECT_TO_RENDER'.
+ * All logical parts of a request (the action and render part) are handled within the same
+ * request. To enable a client side redirect for a request, users can set the 'redirect'
+ * property of {@link RequestCycle}to true (getRequestCycle.setRedirect(true)), after which the
+ * behavior will be like RenderStragegy 'REDIRECT_TO_RENDER'.
* <p>
- * This strategy is more efficient than the 'REDIRECT_TO_RENDER' strategy,
- * and doesn't have some of the potential problems of it, it also does not
- * solve the double submit problem. It is however the best option to use
- * when you want to do sophisticated (non-sticky session) clustering.
+ * This strategy is more efficient than the 'REDIRECT_TO_RENDER' strategy, and doesn't have some
+ * of the potential problems of it, it also does not solve the double submit problem. It is
+ * however the best option to use when you want to do sophisticated (non-sticky session)
+ * clustering.
* </p>
*/
public static final IRequestCycleSettings.RenderStrategy ONE_PASS_RENDER = new IRequestCycleSettings.RenderStrategy(
"ONE_PASS_RENDER");
/**
- * All logical parts of a request (the action and render part) are handled
- * within the same request, but instead of streaming the render result to
- * the browser directly, the result is cached on the server. A client side
- * redirect command is issued to the browser specifically to render this
- * request.
+ * All logical parts of a request (the action and render part) are handled within the same
+ * request, but instead of streaming the render result to the browser directly, the result is
+ * cached on the server. A client side redirect command is issued to the browser specifically to
+ * render this request.
*/
public static final IRequestCycleSettings.RenderStrategy REDIRECT_TO_BUFFER = new IRequestCycleSettings.RenderStrategy(
"REDIRECT_BUFFER");
/**
- * The render part of a request (opposed to the 'action part' which is
- * either the construction of a bookmarkable page or the execution of a
- * IRequestListener handler) is handled by a seperate request by issueing a
- * redirect request to the browser. This is commonly known as the 'redirect
- * after submit' pattern, though in our case, we use it for GET and POST
- * requests instead of just the POST requests. To cancel the client side
- * redirect for a request, users can set the 'redirect' property of
- * {@link RequestCycle}to false (getRequestCycle.setRedirect(false)).
+ * The render part of a request (opposed to the 'action part' which is either the construction
+ * of a bookmarkable page or the execution of a IRequestListener handler) is handled by a
+ * seperate request by issuing a redirect request to the browser. This is commonly known as the
+ * 'redirect after submit' pattern, though in our case, we use it for GET and POST requests
+ * instead of just the POST requests. To cancel the client side redirect for a request, users
+ * can set the 'redirect' property of {@link RequestCycle}to false
+ * (getRequestCycle.setRedirect(false)).
* <p>
- * This pattern solves the 'refresh' problem. While it is a common feature
- * of browsers to refresh/ reload a web page, this results in problems in
- * many dynamic web applications. For example, when you have a link with an
- * event handler that e.g. deletes a row from a list, you usually want to
- * ignore refresh requests after that link is clicked on. By using this
- * strategy, the refresh request only results in the re-rendering of the
- * page without executing the event handler again.
+ * This pattern solves the 'refresh' problem. While it is a common feature of browsers to
+ * refresh/ reload a web page, this results in problems in many dynamic web applications. For
+ * example, when you have a link with an event handler that e.g. deletes a row from a list, you
+ * usually want to ignore refresh requests after that link is clicked on. By using this
+ * strategy, the refresh request only results in the re-rendering of the page without executing
+ * the event handler again.
* </p>
* <p>
- * Though it solves the refresh problem, it introduces potential problems,
- * as the request that is logically one, are actually two seperate request.
- * Not only is this less efficient, but this also can mean that within the
- * same request attachement/ detachement of models is done twice (in case
- * you use models in the bookmarkable page constructors and IRequestListener
- * handlers). If you use this strategy, you should be aware of this
- * possibily, and should also be aware that for one logical request,
- * actually two instances of RequestCycle are created and processed.
+ * Though it solves the refresh problem, it introduces potential problems, as the request that
+ * is logically one, are actually two separate request. Not only is this less efficient, but
+ * this also can mean that within the same request attachment/ detachment of models is done
+ * twice (in case you use models in the bookmarkable page constructors and IRequestListener
+ * handlers). If you use this strategy, you should be aware of this possibility, and should also
+ * be aware that for one logical request, actually two instances of RequestCycle are created and
+ * processed.
* </p>
*/
public static final IRequestCycleSettings.RenderStrategy REDIRECT_TO_RENDER = new IRequestCycleSettings.RenderStrategy(
"CLIENT_SIDE_REDIRECT");
/**
- * Adds a response filter to the list. Filters are evaluated in the order
- * they have been added.
+ * Adds a response filter to the list. Filters are evaluated in the order they have been added.
*
* @param responseFilter
* The {@link IResponseFilter} that is added
@@ -172,12 +157,10 @@
boolean getBufferResponse();
/**
- * Gets whether Wicket should try to get extensive client info by
- * redirecting to
- * {@link BrowserInfoPage a page that polls for client capabilities}. This
- * method is used by the default implementation of
- * {@link WebRequestCycle#newClientInfo()}, so if that method is overriden,
- * there is no guarantee this method will be taken into account.
+ * Gets whether Wicket should try to get extensive client info by redirecting to
+ * {@link BrowserInfoPage a page that polls for client capabilities}. This method is used by
+ * the default implementation of {@link WebRequestCycle#newClientInfo()}, so if that method is
+ * overridden, there is no guarantee this method will be taken into account.
*
* @return Whether to gather extensive client info
*/
@@ -196,18 +179,17 @@
List getResponseFilters();
/**
- * In order to do proper form parameter decoding it is important that the
- * response and the following request have the same encoding. see
- * http://www.crazysquirrel.com/computing/general/form-encoding.jspx for
- * additional information.
+ * In order to do proper form parameter decoding it is important that the response and the
+ * following request have the same encoding. see
+ * http://www.crazysquirrel.com/computing/general/form-encoding.jspx for additional information.
*
* @return The request and response encoding
*/
String getResponseRequestEncoding();
/**
- * Gets the time that a request will by default be waiting for the previous
- * request to be handled before giving up.
+ * Gets the time that a request will by default be waiting for the previous request to be
+ * handled before giving up.
*
* @return The time out
*/
@@ -227,25 +209,21 @@
void setBufferResponse(boolean bufferResponse);
/**
- * Sets whether Wicket should try to get extensive client info by
- * redirecting to
- * {@link BrowserInfoPage a page that polls for client capabilities}. This
- * method is used by the default implementation of
- * {@link WebRequestCycle#newClientInfo()}, so if that method is overriden,
- * there is no guarantee this method will be taken into account.
+ * Sets whether Wicket should try to get extensive client info by redirecting to
+ * {@link BrowserInfoPage a page that polls for client capabilities}. This method is used by
+ * the default implementation of {@link WebRequestCycle#newClientInfo()}, so if that method is
+ * overridden, there is no guarantee this method will be taken into account.
*
* <p>
- * <strong>WARNING: </strong> though this facility should work transparently
- * in most cases, it is recommended that you trigger the roundtrip to get
- * the browser info somewhere where it hurts the least. The roundtrip will
- * be triggered the first time you call {@link Session#getClientInfo()} for
- * a session, and after the roundtrip a new request with the same info (url,
- * post parameters) is handled. So rather than calling this in the middle of
- * an implementation of a form submit method, which would result in the code
- * of that method before the call to {@link Session#getClientInfo()} to be
- * executed twice, you best call {@link Session#getClientInfo()} e.g. in a
- * page constructor or somewhere else where you didn't do a lot of
- * processing first.
+ * <strong>WARNING: </strong> though this facility should work transparently in most cases, it
+ * is recommended that you trigger the roundtrip to get the browser info somewhere where it
+ * hurts the least. The roundtrip will be triggered the first time you call
+ * {@link Session#getClientInfo()} for a session, and after the roundtrip a new request with the
+ * same info (url, post parameters) is handled. So rather than calling this in the middle of an
+ * implementation of a form submit method, which would result in the code of that method before
+ * the call to {@link Session#getClientInfo()} to be executed twice, you best call
+ * {@link Session#getClientInfo()} e.g. in a page constructor or somewhere else where you didn't
+ * do a lot of processing first.
* </p>
*
* @param gatherExtendedBrowserInfo
@@ -254,47 +232,40 @@
void setGatherExtendedBrowserInfo(boolean gatherExtendedBrowserInfo);
/**
- * Sets in what way the render part of a request is handled. Basically,
- * there are two different options:
+ * Sets in what way the render part of a request is handled. Basically, there are two different
+ * options:
* <ul>
- * <li>Direct, ApplicationSettings.ONE_PASS_RENDER. Everything is handled
- * in one physical request. This is efficient, and is the best option if you
- * want to do sophisticated clustering. It does not however, shield you from
- * what is commonly known as the <i>Double submit problem </i></li>
+ * <li>Direct, ApplicationSettings.ONE_PASS_RENDER. Everything is handled in one physical
+ * request. This is efficient, and is the best option if you want to do sophisticated
+ * clustering. It does not however, shield you from what is commonly known as the <i>Double
+ * submit problem </i></li>
* <li>Using a redirect. This follows the pattern <a
- * href="http://www.theserverside.com/articles/article.tss?l=RedirectAfterPost"
- * >as described at the serverside </a> and that is commonly known as
- * Redirect after post. Wicket takes it one step further to do any rendering
- * after a redirect, so that not only form submits are shielded from the
- * double submit problem, but also the IRequestListener handlers (that could
- * be e.g. a link that deletes a row). With this pattern, you have two
- * options to choose from:
+ * href="http://www.theserverside.com/articles/article.tss?l=RedirectAfterPost" >as described at
+ * the serverside </a> and that is commonly known as Redirect after post. Wicket takes it one
+ * step further to do any rendering after a redirect, so that not only form submits are shielded
+ * from the double submit problem, but also the IRequestListener handlers (that could be e.g. a
+ * link that deletes a row). With this pattern, you have two options to choose from:
* <ul>
- * <li>ApplicationSettings.REDIRECT_TO_RENDER. This option first handles
- * the 'action' part of the request, which is either page construction
- * (bookmarkable pages or the home page) or calling a IRequestListener
- * handler, such as Link.onClick. When that part is done, a redirect is
- * issued to the render part, which does all the rendering of the page and
- * its components. <strong>Be aware </strong> that this may mean, depending
- * on whether you access any models in the action part of the request, that
- * attachement and detachement of some models is done twice for a request.
- * </li>
- * <li>ApplicationSettings.REDIRECT_TO_BUFFER. This option handles both the
- * action- and the render part of the request in one physical request, but
- * instead of streaming the result to the browser directly, it is kept in
- * memory, and a redirect is issue to get this buffered result (after which
- * it is immediately removed). This option currently is the default render
- * strategy, as it shields you from the double submit problem, while being
- * more efficient and less error prone regarding to detachable models.</li>
+ * <li>ApplicationSettings.REDIRECT_TO_RENDER. This option first handles the 'action' part of
+ * the request, which is either page construction (bookmarkable pages or the home page) or
+ * calling a IRequestListener handler, such as Link.onClick. When that part is done, a redirect
+ * is issued to the render part, which does all the rendering of the page and its components.
+ * <strong>Be aware </strong> that this may mean, depending on whether you access any models in
+ * the action part of the request, that attachment and detachment of some models is done twice
+ * for a request. </li>
+ * <li>ApplicationSettings.REDIRECT_TO_BUFFER. This option handles both the action- and the
+ * render part of the request in one physical request, but instead of streaming the result to
+ * the browser directly, it is kept in memory, and a redirect is issue to get this buffered
+ * result (after which it is immediately removed). This option currently is the default render
+ * strategy, as it shields you from the double submit problem, while being more efficient and
+ * less error prone regarding to detachable models.</li>
* </ul>
- * Note that this parameter sets the default behavior, but that you can
- * manually set whether any redirecting is done by calling method
- * RequestCycle.setRedirect. Setting the redirect flag when the application
- * is configured to use ONE_PASS_RENDER, will result in a redirect of type
- * REDIRECT_TO_RENDER. When the application is configured to use
- * REDIRECT_TO_RENDER or REDIRECT_TO_BUFFER, setting the redirect flag to
- * false, will result in that request begin rendered and streamed in one
- * pass.
+ * Note that this parameter sets the default behavior, but that you can manually set whether any
+ * redirecting is done by calling method RequestCycle.setRedirect. Setting the redirect flag
+ * when the application is configured to use ONE_PASS_RENDER, will result in a redirect of type
+ * REDIRECT_TO_RENDER. When the application is configured to use REDIRECT_TO_RENDER or
+ * REDIRECT_TO_BUFFER, setting the redirect flag to false, will result in that request begin
+ * rendered and streamed in one pass.
*
* @param renderStrategy
* the render strategy that should be used by default.
@@ -302,10 +273,9 @@
void setRenderStrategy(IRequestCycleSettings.RenderStrategy renderStrategy);
/**
- * In order to do proper form parameter decoding it is important that the
- * response and the following request have the same encoding. see
- * http://www.crazysquirrel.com/computing/general/form-encoding.jspx for
- * additional information.
+ * In order to do proper form parameter decoding it is important that the response and the
+ * following request have the same encoding. see
+ * http://www.crazysquirrel.com/computing/general/form-encoding.jspx for additional information.
*
* Default encoding: UTF-8
*
@@ -315,8 +285,8 @@
void setResponseRequestEncoding(final String responseRequestEncoding);
/**
- * Sets the time that a request will by default be waiting for the previous
- * request to be handled before giving up.
+ * Sets the time that a request will by default be waiting for the previous request to be
+ * handled before giving up.
*
* @param timeout
*/
@@ -328,4 +298,4 @@
* @param unexpectedExceptionDisplay
*/
void setUnexpectedExceptionDisplay(final UnexpectedExceptionDisplay unexpectedExceptionDisplay);
-}
\ No newline at end of file
+}
Modified: wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/io/IObjectStreamFactory.java
URL: http://svn.apache.org/viewvc/wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/io/IObjectStreamFactory.java?rev=584462&r1=584461&r2=584462&view=diff
==============================================================================
--- wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/io/IObjectStreamFactory.java (original)
+++ wicket/trunk/jdk-1.4/wicket/src/main/java/org/apache/wicket/util/io/IObjectStreamFactory.java Sat Oct 13 17:46:03 2007
@@ -27,9 +27,8 @@
/**
- * Interface for serializing and deserializing so that we can very the
- * implementation of the {@link ObjectOutputStream} and
- * {@link ObjectInputStream} implementations.
+ * Interface for serializing and deserializing so that we can vary the implementation of the
+ * {@link ObjectOutputStream} and {@link ObjectInputStream} implementations.
*
* @see Objects#objectToByteArray(Object)
* @see Objects#byteArrayToObject(byte[])
@@ -84,11 +83,10 @@
}
/**
- * Gets a new instance of an {@link ObjectInputStream} with the provided
- * {@link InputStream}.
+ * Gets a new instance of an {@link ObjectInputStream} with the provided {@link InputStream}.
*
* @param in
- * The inpu stream that should be used for the reading
+ * The input stream that should be used for the reading
* @return a new object input stream instance
* @throws IOException
* if an I/O error occurs while reading stream header
@@ -96,8 +94,7 @@
ObjectInputStream newObjectInputStream(InputStream in) throws IOException;
/**
- * Gets a new instance of an {@link ObjectOutputStream} with the provided
- * {@link OutputStream}.
+ * Gets a new instance of an {@link ObjectOutputStream} with the provided {@link OutputStream}.
*
* @param out
* The output stream that should be used for the writing