You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pluto-scm@portals.apache.org by ms...@apache.org on 2016/04/14 14:28:44 UTC
[04/50] [abbrv] portals-pluto git commit: Minor wording changes in
the Javadoc. Copied updated portlet API overview document into the Pluto
portlet_api project.
Minor wording changes in the Javadoc. Copied updated portlet API overview
document into the Pluto portlet_api project.
Project: http://git-wip-us.apache.org/repos/asf/portals-pluto/repo
Commit: http://git-wip-us.apache.org/repos/asf/portals-pluto/commit/5fb26a1d
Tree: http://git-wip-us.apache.org/repos/asf/portals-pluto/tree/5fb26a1d
Diff: http://git-wip-us.apache.org/repos/asf/portals-pluto/diff/5fb26a1d
Branch: refs/heads/master
Commit: 5fb26a1dd5c5209dfaa1fad07ed246dc8d30d1e7
Parents: aa5e8a3
Author: Scott Nicklous <ms...@apache.org>
Authored: Mon Jan 25 13:21:04 2016 +0100
Committer: Scott Nicklous <ms...@apache.org>
Committed: Mon Jan 25 13:22:42 2016 +0100
----------------------------------------------------------------------
.../java/javax/portlet/PortletResponse.java | 2 +-
.../javax/portlet/annotations/package-info.java | 1 -
.../portlet/filter/ActionParametersWrapper.java | 6 +-
.../portlet/filter/ActionRequestWrapper.java | 2 +-
.../portlet/filter/ActionResponseWrapper.java | 2 +-
.../javax/portlet/filter/ActionURLWrapper.java | 6 +-
.../javax/portlet/filter/BaseURLWrapper.java | 6 +-
.../filter/ClientDataRequestWrapper.java | 2 +-
.../portlet/filter/EventRequestWrapper.java | 2 +-
.../portlet/filter/EventResponseWrapper.java | 2 +-
.../portlet/filter/HeaderRequestWrapper.java | 2 +-
.../portlet/filter/HeaderResponseWrapper.java | 2 +-
.../portlet/filter/MimeResponseWrapper.java | 2 +-
.../filter/MutableActionParametersWrapper.java | 6 +-
.../filter/MutablePortletParametersWrapper.java | 6 +-
.../filter/MutablePortletStateWrapper.java | 6 +-
.../filter/MutableRenderParametersWrapper.java | 6 +-
.../MutableResourceParametersWrapper.java | 6 +-
.../portlet/filter/PortletConfigWrapper.java | 4 +-
.../portlet/filter/PortletContextWrapper.java | 4 +-
.../filter/PortletParametersWrapper.java | 6 +-
.../filter/PortletRequestDispatcherWrapper.java | 4 +-
.../portlet/filter/PortletSessionWrapper.java | 6 +-
.../portlet/filter/PortletStateWrapper.java | 6 +-
.../javax/portlet/filter/PortletURLWrapper.java | 6 +-
.../portlet/filter/RenderParametersWrapper.java | 6 +-
.../portlet/filter/RenderRequestWrapper.java | 2 +-
.../portlet/filter/RenderResponseWrapper.java | 2 +-
.../javax/portlet/filter/RenderURLWrapper.java | 6 +-
.../filter/ResourceParametersWrapper.java | 6 +-
.../portlet/filter/ResourceRequestWrapper.java | 2 +-
.../portlet/filter/ResourceResponseWrapper.java | 2 +-
.../portlet/filter/ResourceURLWrapper.java | 6 +-
.../filter/StateAwareResponseWrapper.java | 2 +-
portlet-api/src/main/javadoc/overview.html | 193 ++++++++++++++++++-
portlet-api/src/main/javadoc/portlet-api.css | 111 ++++++++++-
36 files changed, 363 insertions(+), 78 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/PortletResponse.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/PortletResponse.java b/portlet-api/src/main/java/javax/portlet/PortletResponse.java
index 3776370..ddc3e48 100644
--- a/portlet-api/src/main/java/javax/portlet/PortletResponse.java
+++ b/portlet-api/src/main/java/javax/portlet/PortletResponse.java
@@ -25,7 +25,7 @@
package javax.portlet;
/**
- * <div class="changed_modified_3_0">The</div>
+ * <span class="changed_modified_3_0">The</span>
* <CODE>PortletResponse</CODE> defines the base interface to assist a
* portlet in creating and sending a response to the client. The portlet
* container uses specialized versions of this interface when invoking a
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/annotations/package-info.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/package-info.java b/portlet-api/src/main/java/javax/portlet/annotations/package-info.java
index aa02ac5..82f2f2f 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/package-info.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/package-info.java
@@ -48,7 +48,6 @@
* {@link javax.portlet.annotations.HeaderMethod},
* {@link javax.portlet.annotations.RenderMethod},
* {@link javax.portlet.annotations.ServeResourceMethod}, or
- * {@link javax.portlet.annotations.PortletResources}.
* <p>
* Bean portlet methods can be contained in any valid bean class.
* The class needs not implement any portlet-specific interface or extend a portlet class.
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/ActionParametersWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ActionParametersWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ActionParametersWrapper.java
index 7f39fb4..956f55a 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ActionParametersWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ActionParametersWrapper.java
@@ -26,7 +26,7 @@ import javax.portlet.MutableActionParameters;
* <div class="changed_added_3_0">
* The <code>ActionParametersWrapper</code> provides a convenient
* implementation of the <code>ActionParameters</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -37,7 +37,7 @@ import javax.portlet.MutableActionParameters;
public class ActionParametersWrapper extends PortletParametersWrapper implements ActionParameters {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the ActionParameters is null.
*/
public ActionParametersWrapper(ActionParameters wrapped) {
@@ -58,7 +58,7 @@ public class ActionParametersWrapper extends PortletParametersWrapper implements
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the ActionParameters is null.
*/
public void setWrapped(ActionParameters wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/ActionRequestWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ActionRequestWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ActionRequestWrapper.java
index 2ebe37b..ac48e6a 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ActionRequestWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ActionRequestWrapper.java
@@ -31,7 +31,7 @@ import javax.portlet.ActionRequest;
* <span class="changed_modified_3_0">The</span>
* <code>ActionRequestWrapper</code> provides a convenient
* implementation of the <code>ActionRequest</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/ActionResponseWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ActionResponseWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ActionResponseWrapper.java
index 1598c7e..de727b8 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ActionResponseWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ActionResponseWrapper.java
@@ -34,7 +34,7 @@ import javax.portlet.RenderURL;
* <span class="changed_modified_3_0">The</span>
* <code>ActionResponseWrapper</code> provides a convenient
* implementation of the <code>ActionResponse</code> interface
- * that can be subclassed by developers wishing to adapt the ((ActionResponse)response).
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped response object.
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/ActionURLWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ActionURLWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ActionURLWrapper.java
index 25b254e..b1ddf72 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ActionURLWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ActionURLWrapper.java
@@ -26,7 +26,7 @@ import javax.portlet.MutableActionParameters;
* <div class="changed_added_3_0">
* The <code>ActionURLWrapper</code> provides a convenient
* implementation of the <code>ActionURL</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -37,7 +37,7 @@ import javax.portlet.MutableActionParameters;
public class ActionURLWrapper extends PortletURLWrapper implements ActionURL {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the ActionURL is null.
*/
public ActionURLWrapper(ActionURL wrapped) {
@@ -58,7 +58,7 @@ public class ActionURLWrapper extends PortletURLWrapper implements ActionURL {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the ActionURL is null.
*/
public void setWrapped(ActionURL wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/BaseURLWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/BaseURLWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/BaseURLWrapper.java
index 4fa2878..cd3ab2c 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/BaseURLWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/BaseURLWrapper.java
@@ -30,7 +30,7 @@ import javax.portlet.PortletSecurityException;
* <div class="changed_added_3_0">
* The <code>BaseURLWrapper</code> provides a convenient
* implementation of the <code>BaseURL</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -41,7 +41,7 @@ import javax.portlet.PortletSecurityException;
public class BaseURLWrapper extends PortletStateWrapper implements BaseURL {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the BaseURL is null.
*/
public BaseURLWrapper(BaseURL wrapped) {
@@ -63,7 +63,7 @@ public class BaseURLWrapper extends PortletStateWrapper implements BaseURL {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the BaseURL is null.
*/
public void setWrapped(BaseURL wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/ClientDataRequestWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ClientDataRequestWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ClientDataRequestWrapper.java
index a9f6589..95e0deb 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ClientDataRequestWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ClientDataRequestWrapper.java
@@ -28,7 +28,7 @@ import javax.portlet.ClientDataRequest;
/**
* <div class="changed_added_3_0"> The <code>ClientDataRequestWrapper</code>
* provides a convenient implementation of the <code>ClientDataRequest</code>
- * interface that can be subclassed by developers wishing to adapt the request.
+ * interface that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern. Methods default to
* calling through to the wrapped request object. </div>
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/EventRequestWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/EventRequestWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/EventRequestWrapper.java
index 6356e56..e74cc8c 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/EventRequestWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/EventRequestWrapper.java
@@ -31,7 +31,7 @@ import javax.portlet.EventRequest;
* <span class="changed_modified_3_0">The</span>
* <code>EventRequestWrapper</code> provides a convenient
* implementation of the <code>EventRequest</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/EventResponseWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/EventResponseWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/EventResponseWrapper.java
index 6d9e6b8..1755064 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/EventResponseWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/EventResponseWrapper.java
@@ -31,7 +31,7 @@ import javax.portlet.EventResponse;
* <span class="changed_modified_3_0">The</span>
* <code>EventResponseWrapper</code> provides a convenient
* implementation of the <code>EventResponse</code> interface
- * that can be subclassed by developers wishing to adapt the ((EventResponse)response).
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped response object.
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/HeaderRequestWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/HeaderRequestWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/HeaderRequestWrapper.java
index 5d0b5ee..bbe32eb 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/HeaderRequestWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/HeaderRequestWrapper.java
@@ -30,7 +30,7 @@ import javax.portlet.HeaderRequest;
* <div class="changed_added_3_0">
* The <code>HeaderRequestWrapper</code> provides a convenient
* implementation of the <code>HeaderRequest</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/HeaderResponseWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/HeaderResponseWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/HeaderResponseWrapper.java
index c3b40cf..c7251b7 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/HeaderResponseWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/HeaderResponseWrapper.java
@@ -23,7 +23,7 @@ import javax.portlet.HeaderResponse;
/**
* <div class="changed_added_3_0"> The <code>HeaderResponseWrapper</code>
* provides a convenient implementation of the <code>HeaderResponse</code>
- * interface that can be subclassed by developers wishing to adapt the Response.
+ * interface that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern. Methods default to
* calling through to the wrapped Response object. </div>
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/MimeResponseWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/MimeResponseWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/MimeResponseWrapper.java
index 0c3cf4e..9365d44 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/MimeResponseWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/MimeResponseWrapper.java
@@ -33,7 +33,7 @@ import javax.portlet.ResourceURL;
/**
* <div class="changed_added_3_0"> The <code>MimeResponseWrapper</code> provides
* a convenient implementation of the <code>MimeResponse</code> interface that
- * can be subclassed by developers wishing to adapt the response. This class
+ * can be subclassed by developers. This class
* implements the Wrapper or Decorator pattern. Methods default to calling
* through to the wrapped response object. </div>
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/MutableActionParametersWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/MutableActionParametersWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/MutableActionParametersWrapper.java
index 736a0ae..e1cba10 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/MutableActionParametersWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/MutableActionParametersWrapper.java
@@ -25,7 +25,7 @@ import javax.portlet.MutableActionParameters;
* <div class="changed_added_3_0">
* The <code>MutableActionParametersWrapper</code> provides a convenient
* implementation of the <code>MutableActionParameters</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -36,7 +36,7 @@ import javax.portlet.MutableActionParameters;
public class MutableActionParametersWrapper extends MutablePortletParametersWrapper implements MutableActionParameters {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutableActionParameters is null.
*/
public MutableActionParametersWrapper(MutableActionParameters wrapped) {
@@ -57,7 +57,7 @@ public class MutableActionParametersWrapper extends MutablePortletParametersWrap
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutableActionParameters is null.
*/
public void setWrapped(MutableActionParameters wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/MutablePortletParametersWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/MutablePortletParametersWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/MutablePortletParametersWrapper.java
index c546ee5..ef65c7c 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/MutablePortletParametersWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/MutablePortletParametersWrapper.java
@@ -27,7 +27,7 @@ import javax.portlet.PortletParameters;
* <div class="changed_added_3_0">
* The <code>MutablePortletParametersWrapper</code> provides a convenient
* implementation of the <code>MutablePortletParameters</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -39,7 +39,7 @@ public class MutablePortletParametersWrapper extends PortletParametersWrapper im
Mutable {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutablePortletParameters is null.
*/
public MutablePortletParametersWrapper(MutablePortletParameters wrapped) {
@@ -60,7 +60,7 @@ public class MutablePortletParametersWrapper extends PortletParametersWrapper im
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutablePortletParameters is null.
*/
public void setWrapped(MutablePortletParameters wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/MutablePortletStateWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/MutablePortletStateWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/MutablePortletStateWrapper.java
index ed15012..62c613f 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/MutablePortletStateWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/MutablePortletStateWrapper.java
@@ -31,7 +31,7 @@ import javax.portlet.WindowStateException;
* <div class="changed_added_3_0">
* The <code>MutablePortletStateWrapper</code> provides a convenient
* implementation of the <code>MutablePortletState</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -42,7 +42,7 @@ import javax.portlet.WindowStateException;
public class MutablePortletStateWrapper extends PortletStateWrapper implements MutablePortletState, Mutable {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutablePortletState is null.
*/
public MutablePortletStateWrapper(MutablePortletState wrapped) {
@@ -63,7 +63,7 @@ public class MutablePortletStateWrapper extends PortletStateWrapper implements M
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutablePortletState is null.
*/
public void setWrapped(MutablePortletState wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/MutableRenderParametersWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/MutableRenderParametersWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/MutableRenderParametersWrapper.java
index 65141af..8ad172c 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/MutableRenderParametersWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/MutableRenderParametersWrapper.java
@@ -25,7 +25,7 @@ import javax.portlet.MutableRenderParameters;
* <div class="changed_added_3_0">
* The <code>MutableRenderParametersWrapper</code> provides a convenient
* implementation of the <code>MutableRenderParameters</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -36,7 +36,7 @@ import javax.portlet.MutableRenderParameters;
public class MutableRenderParametersWrapper extends MutablePortletParametersWrapper implements MutableRenderParameters {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutableRenderParameters is null.
*/
public MutableRenderParametersWrapper(MutableRenderParameters wrapped) {
@@ -57,7 +57,7 @@ public class MutableRenderParametersWrapper extends MutablePortletParametersWrap
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutableRenderParameters is null.
*/
public void setWrapped(MutableRenderParameters wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/MutableResourceParametersWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/MutableResourceParametersWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/MutableResourceParametersWrapper.java
index 8322b1d..919b842 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/MutableResourceParametersWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/MutableResourceParametersWrapper.java
@@ -25,7 +25,7 @@ import javax.portlet.MutableResourceParameters;
* <div class="changed_added_3_0">
* The <code>MutableResourceParametersWrapper</code> provides a convenient
* implementation of the <code>MutableResourceParameters</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -37,7 +37,7 @@ public class MutableResourceParametersWrapper extends MutablePortletParametersWr
MutableResourceParameters {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutableResourceParameters is null.
*/
public MutableResourceParametersWrapper(MutableResourceParameters wrapped) {
@@ -58,7 +58,7 @@ public class MutableResourceParametersWrapper extends MutablePortletParametersWr
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the MutableResourceParameters is null.
*/
public void setWrapped(MutableResourceParameters wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/PortletConfigWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/PortletConfigWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/PortletConfigWrapper.java
index d251375..a977212 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/PortletConfigWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/PortletConfigWrapper.java
@@ -34,7 +34,7 @@ import javax.xml.namespace.QName;
* <div class="changed_added_3_0">
* The <code>PortletConfigWrapper</code> provides a convenient
* implementation of the <code>PortletConfig</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -69,7 +69,7 @@ public class PortletConfigWrapper implements PortletConfig {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the request is null.
*/
public void setWrapped(PortletConfig wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/PortletContextWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/PortletContextWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/PortletContextWrapper.java
index f9b1b54..50470f1 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/PortletContextWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/PortletContextWrapper.java
@@ -32,7 +32,7 @@ import javax.portlet.PortletRequestDispatcher;
* <div class="changed_added_3_0">
* The <code>PortletContextWrapper</code> provides a convenient
* implementation of the <code>PortletContext</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -67,7 +67,7 @@ public class PortletContextWrapper implements PortletContext {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the PortletContext is null.
*/
public void setPortletContext(PortletContext wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/PortletParametersWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/PortletParametersWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/PortletParametersWrapper.java
index 8bc8cd2..68d9c77 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/PortletParametersWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/PortletParametersWrapper.java
@@ -28,7 +28,7 @@ import javax.portlet.PortletParameters;
* <div class="changed_added_3_0">
* The <code>PortletParametersWrapper</code> provides a convenient
* implementation of the <code>PortletParameters</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -41,7 +41,7 @@ public class PortletParametersWrapper implements PortletParameters {
protected PortletParameters wrapped;
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the PortletParameters is null.
*/
public PortletParametersWrapper(PortletParameters wrapped) {
@@ -65,7 +65,7 @@ public class PortletParametersWrapper implements PortletParameters {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the PortletParameters is null.
*/
public void setWrapped(PortletParameters wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/PortletRequestDispatcherWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/PortletRequestDispatcherWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/PortletRequestDispatcherWrapper.java
index 4d0be19..39da72f 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/PortletRequestDispatcherWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/PortletRequestDispatcherWrapper.java
@@ -32,7 +32,7 @@ import javax.portlet.RenderResponse;
* <div class="changed_added_3_0">
* The <code>PortletRequestDispatcherWrapper</code> provides a convenient
* implementation of the <code>PortletRequestDispatcher</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -66,7 +66,7 @@ public class PortletRequestDispatcherWrapper implements PortletRequestDispatcher
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the request is null.
*/
public void setWrapped(PortletRequestDispatcher wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/PortletSessionWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/PortletSessionWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/PortletSessionWrapper.java
index d76e851..fbfa0c3 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/PortletSessionWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/PortletSessionWrapper.java
@@ -29,7 +29,7 @@ import javax.portlet.PortletSession;
* <div class="changed_added_3_0">
* The <code>PortletSessionWrapper</code> provides a convenient
* implementation of the <code>PortletSession</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -42,7 +42,7 @@ public class PortletSessionWrapper implements PortletSession {
protected PortletSession wrapped;
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the PortletSession is null.
*/
public PortletSessionWrapper(PortletSession wrapped) {
@@ -66,7 +66,7 @@ public class PortletSessionWrapper implements PortletSession {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the PortletSession is null.
*/
public void setWrapped(PortletSession wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/PortletStateWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/PortletStateWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/PortletStateWrapper.java
index aa69794..7f1e4e7 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/PortletStateWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/PortletStateWrapper.java
@@ -28,7 +28,7 @@ import javax.portlet.WindowState;
* <div class="changed_added_3_0">
* The <code>PortletStateWrapper</code> provides a convenient
* implementation of the <code>PortletState</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -41,7 +41,7 @@ public class PortletStateWrapper implements PortletState {
protected PortletState wrapped;
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the PortletState is null.
*/
public PortletStateWrapper(PortletState wrapped) {
@@ -65,7 +65,7 @@ public class PortletStateWrapper implements PortletState {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the PortletState is null.
*/
public void setWrapped(PortletState wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/PortletURLWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/PortletURLWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/PortletURLWrapper.java
index 56ae896..8661f47 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/PortletURLWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/PortletURLWrapper.java
@@ -31,7 +31,7 @@ import javax.portlet.annotations.PortletSerializable;
* <div class="changed_added_3_0">
* The <code>PortletURLWrapper</code> provides a convenient
* implementation of the <code>PortletURL</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -42,7 +42,7 @@ import javax.portlet.annotations.PortletSerializable;
public class PortletURLWrapper extends BaseURLWrapper implements PortletURL {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the PortletURL is null.
*/
public PortletURLWrapper(PortletURL wrapped) {
@@ -63,7 +63,7 @@ public class PortletURLWrapper extends BaseURLWrapper implements PortletURL {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the PortletURL is null.
*/
public void setWrapped(PortletURL wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/RenderParametersWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/RenderParametersWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/RenderParametersWrapper.java
index bbc566c..ca54bfb 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/RenderParametersWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/RenderParametersWrapper.java
@@ -26,7 +26,7 @@ import javax.portlet.RenderParameters;
* <div class="changed_added_3_0">
* The <code>RenderParametersWrapper</code> provides a convenient
* implementation of the <code>RenderParameters</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -37,7 +37,7 @@ import javax.portlet.RenderParameters;
public class RenderParametersWrapper extends PortletParametersWrapper implements RenderParameters {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the RenderParameters is null.
*/
public RenderParametersWrapper(RenderParameters wrapped) {
@@ -58,7 +58,7 @@ public class RenderParametersWrapper extends PortletParametersWrapper implements
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the RenderParameters is null.
*/
public void setWrapped(RenderParameters wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/RenderRequestWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/RenderRequestWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/RenderRequestWrapper.java
index 19c5051..2ecef38 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/RenderRequestWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/RenderRequestWrapper.java
@@ -30,7 +30,7 @@ import javax.portlet.RenderRequest;
* <span class="changed_modified_3_0">The</span>
* <code>RenderRequestWrapper</code> provides a convenient
* implementation of the <code>RenderRequest</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/RenderResponseWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/RenderResponseWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/RenderResponseWrapper.java
index b4fbe71..a48af0b 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/RenderResponseWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/RenderResponseWrapper.java
@@ -32,7 +32,7 @@ import javax.portlet.RenderResponse;
/**
* <span class="changed_modified_3_0">The</span> <code>RenderResponseWrapper</code> provides a convenient
* implementation of the <code>RenderResponse</code> interface
- * that can be subclassed by developers wishing to adapt the ((RenderResponse)response).
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped response object.
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/RenderURLWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/RenderURLWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/RenderURLWrapper.java
index 5c54a09..c07b21f 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/RenderURLWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/RenderURLWrapper.java
@@ -25,7 +25,7 @@ import javax.portlet.RenderURL;
* <div class="changed_added_3_0">
* The <code>RenderURLWrapper</code> provides a convenient
* implementation of the <code>RenderURL</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -36,7 +36,7 @@ import javax.portlet.RenderURL;
public class RenderURLWrapper extends PortletURLWrapper implements RenderURL {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the RenderURL is null.
*/
public RenderURLWrapper(RenderURL wrapped) {
@@ -57,7 +57,7 @@ public class RenderURLWrapper extends PortletURLWrapper implements RenderURL {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the RenderURL is null.
*/
public void setWrapped(RenderURL wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/ResourceParametersWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ResourceParametersWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ResourceParametersWrapper.java
index 57a8752..964b428 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ResourceParametersWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ResourceParametersWrapper.java
@@ -26,7 +26,7 @@ import javax.portlet.ResourceParameters;
* <div class="changed_added_3_0">
* The <code>ResourceParametersWrapper</code> provides a convenient
* implementation of the <code>ResourceParameters</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -37,7 +37,7 @@ import javax.portlet.ResourceParameters;
public class ResourceParametersWrapper extends PortletParametersWrapper implements ResourceParameters {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the ResourceParameters is null.
*/
public ResourceParametersWrapper(ResourceParameters wrapped) {
@@ -58,7 +58,7 @@ public class ResourceParametersWrapper extends PortletParametersWrapper implemen
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the ResourceParameters is null.
*/
public void setWrapped(ResourceParameters wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/ResourceRequestWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ResourceRequestWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ResourceRequestWrapper.java
index f10284c..5ce2388 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ResourceRequestWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ResourceRequestWrapper.java
@@ -33,7 +33,7 @@ import javax.portlet.ResourceRequest;
* <span class="changed_modified_3_0">The</span>
* <code>ResourceRequestWrapper</code> provides a convenient
* implementation of the <code>ResourceRequest</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java
index ca2d129..42fa22a 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ResourceResponseWrapper.java
@@ -32,7 +32,7 @@ import javax.portlet.ResourceResponse;
* <span class="changed_modified_3_0">The</span>
* <code>ResourceResponseWrapper</code> provides a convenient
* implementation of the <code>ResourceResponse</code> interface
- * that can be subclassed by developers wishing to adapt the ((ResourceResponse)response).
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped response object.
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/ResourceURLWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/ResourceURLWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/ResourceURLWrapper.java
index 237a5bf..894b65f 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/ResourceURLWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/ResourceURLWrapper.java
@@ -26,7 +26,7 @@ import javax.portlet.ResourceURL;
* <div class="changed_added_3_0">
* The <code>ResourceURLWrapper</code> provides a convenient
* implementation of the <code>ResourceURL</code> interface
- * that can be subclassed by developers wishing to adapt the request.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped request object.
* </div>
@@ -37,7 +37,7 @@ import javax.portlet.ResourceURL;
public class ResourceURLWrapper extends BaseURLWrapper implements ResourceURL {
/**
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the ResourceURL is null.
*/
public ResourceURLWrapper(ResourceURL wrapped) {
@@ -58,7 +58,7 @@ public class ResourceURLWrapper extends BaseURLWrapper implements ResourceURL {
/**
* Sets the wrapped object.
*
- * @param the wrapped object to set.
+ * @param wrapped the wrapped object to set.
* @throws java.lang.IllegalArgumentException if the ResourceURL is null.
*/
public void setWrapped(ResourceURL wrapped) {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/java/javax/portlet/filter/StateAwareResponseWrapper.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/filter/StateAwareResponseWrapper.java b/portlet-api/src/main/java/javax/portlet/filter/StateAwareResponseWrapper.java
index 94568d5..174755e 100644
--- a/portlet-api/src/main/java/javax/portlet/filter/StateAwareResponseWrapper.java
+++ b/portlet-api/src/main/java/javax/portlet/filter/StateAwareResponseWrapper.java
@@ -34,7 +34,7 @@ import javax.xml.namespace.QName;
* <div class="changed_added_3_0">
* The <code>StateAwareResponseWrapper</code> provides a convenient
* implementation of the <code>StateAwareResponse</code> interface
- * that can be subclassed by developers wishing to adapt the Response.
+ * that can be subclassed by developers.
* This class implements the Wrapper or Decorator pattern.
* Methods default to calling through to the wrapped Response object.
* </div>
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/javadoc/overview.html
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/javadoc/overview.html b/portlet-api/src/main/javadoc/overview.html
index 25ab44b..661cb10 100644
--- a/portlet-api/src/main/javadoc/overview.html
+++ b/portlet-api/src/main/javadoc/overview.html
@@ -5,7 +5,11 @@
</HEAD>
<BODY>
This document provides the interface descriptions for the JSR 362 Portlet Specification 3.0 Working Document.
- <P>The interfaces described here are not normative and are subject to change at any time.</P>
+ The interfaces described here are not normative and are subject to change at any time.
+ <p>
+ The portlet hub JavaScript API documentation can be found
+ <a href="../jsdoc/index.html" target="_top">here</a>.
+ </p>
<p>Color coding for description changes in Version 3.0:
<span class="changed_modified_3_0">Changed text</span> ::
<span class="changed_added_3_0">Added text</span> ::
@@ -16,6 +20,183 @@
<!-- change class below to "indexContainer" to activate color changebars in the change history -->
<div class="indexContainer-not">
<ul>
+ <li>
+ 20160125:
+ Added clarification to
+ {@link javax.portlet.PortletResponse PortletResponse} addProperty and setProperty
+ method descriptions.
+ Removed {@link javax.portlet.BaseURL BaseURL} getAuthenticated and setAuthenticated methods.
+ Added wrappers according to
+ <a href="https://java.net/jira/browse/PORTLETSPEC3-62">PORTLETSPEC3-62</a>,
+ (see {@link javax.portlet.filter filter package}).
+ Update following annotations for consistency with spec & RI:
+ {@link javax.portlet.annotations.DestroyMethod DestroyMethod},
+ {@link javax.portlet.annotations.EventMethod EventMethod},
+ {@link javax.portlet.annotations.HeaderMethod HeaderMethod},
+ {@link javax.portlet.annotations.InitMethod InitMethod},
+ {@link javax.portlet.annotations.PortletSessionScoped PortletSessionScoped}.
+ Added {@link javax.portlet.annotations.PortletRequestScoped PortletRequestScoped} annotation.
+ </li>
+ <li>
+ 20151208:
+ Several changes to portlet annotations to improve consistency with respect to the portlet
+ deployment descriptor. Updated classes:
+ {@link javax.portlet.annotations.InitParameter InitParameter},
+ {@link javax.portlet.annotations.PortletConfiguration PortletConfiguration},
+ {@link javax.portlet.annotations.PortletRequestFilter PortletRequestFilter},
+ {@link javax.portlet.annotations.RuntimeOption RuntimeOption},
+ {@link javax.portlet.annotations.SecurityRoleRef SecurityRoleRef},
+ {@link javax.portlet.annotations.Supports Supports}.
+ </li>
+ <li>
+ 20151005:
+ Added annotations and interfaces for conditional dispatching:
+ {@link javax.portlet.ConditionalDispatcher ConditionalDispatcher},
+ {@link javax.portlet.MethodToken MethodToken},
+ and
+ {@link javax.portlet.annotations.ConditionalDispatchMethod ConditionalDispatchMethod}.
+ Updated
+ {@link javax.portlet.annotations.HeaderMethod HeaderMethod},
+ {@link javax.portlet.annotations.RenderMethod RenderMethod}, and
+ {@link javax.portlet.annotations.ServeResourceMethod ServeResourceMethod}.
+ </li>
+ <li>
+ 20150930:
+ Added
+ {@link javax.portlet.filter.HeaderFilterChain HeaderFilterChain}
+ and updated
+ {@link javax.portlet.filter.HeaderFilter HeaderFilter} to use it.
+ </li>
+ <li>
+ 20150923:
+ Added method annotations
+ {@link javax.portlet.annotations.InitMethod}, and
+ {@link javax.portlet.annotations.DestroyMethod}.
+ Added filter and wrappers for header phase. Added new wrappers
+ for requests and responses not yet wrapped and modified
+ existing wrappers to use them. New classes:
+ {@link javax.portlet.filter.ClientDataRequestWrapper},
+ {@link javax.portlet.filter.HeaderFilter},
+ {@link javax.portlet.filter.HeaderRequestWrapper},
+ {@link javax.portlet.filter.HeaderResponseWrapper},
+ {@link javax.portlet.filter.MimeResponseWrapper}, and
+ {@link javax.portlet.filter.StateAwareResponseWrapper}.
+ Modified classes:
+ {@link javax.portlet.filter.ActionRequestWrapper},
+ {@link javax.portlet.filter.ActionResponseWrapper},
+ {@link javax.portlet.filter.RenderRequestWrapper},
+ {@link javax.portlet.filter.RenderResponseWrapper},
+ {@link javax.portlet.filter.EventRequestWrapper},
+ {@link javax.portlet.filter.EventResponseWrapper},
+ {@link javax.portlet.filter.PortletRequestWrapper},
+ {@link javax.portlet.filter.PortletResponseWrapper},
+ {@link javax.portlet.filter.ResourceRequestWrapper}, and
+ {@link javax.portlet.filter.ResourceResponseWrapper}.
+ </li>
+ <li>
+ 20150922:
+ Added interfaces and annotations for conditional dispatching.
+ Added classes:
+ {@link javax.portlet.MethodToken},
+ {@link javax.portlet.ConditionalDispatcher}, and
+ {@link javax.portlet.annotations.ConditionalDispatchMethod}.
+ </li>
+ <li>
+ 20150921: Modified annotation classes to conform to latest spec draft.
+ Added dedicated HeaderRequest and HeaderResponse interfaces to allow portlets
+ to add response headers and generate markup for the overall portal
+ response document <code>HEAD</code> section.
+ Deprecated {@link javax.portlet.RenderResponse#setTitle RenderResponse#setTitle}
+ since it is more appropriate on the HeaderResponse object.
+ Added classes:
+ {@link javax.portlet.HeaderRequest},
+ {@link javax.portlet.HeaderResponse}, and
+ {@link javax.portlet.HeaderPortlet}.
+ Modified classes:
+ {@link javax.portlet.annotations.RenderMethod},
+ {@link javax.portlet.annotations.HeaderMethod}, and
+ {@link javax.portlet.annotations.ServeResourceMethod}.
+ </li>
+ <li>
+ 20150911: Modified and added annotation classes in order to allow complete
+ portlet application configuration and portlet configuration through annotations.
+ Added classes:
+ {@link javax.portlet.annotations.UserAttribute},
+ {@link javax.portlet.annotations.EventDefinition},
+ {@link javax.portlet.annotations.PortletApplication},
+ {@link javax.portlet.annotations.PortletConfigurations},
+ {@link javax.portlet.annotations.PublicRenderParameterDefinition}, and
+ {@link javax.portlet.annotations.SecurityRoleRef}.
+ Modified classes:
+ {@link javax.portlet.annotations.ActionMethod},
+ {@link javax.portlet.annotations.CustomPortletMode},
+ {@link javax.portlet.annotations.CustomWindowState},
+ {@link javax.portlet.annotations.Dependency},
+ {@link javax.portlet.annotations.EventMethod},
+ {@link javax.portlet.annotations.PortletConfiguration},
+ {@link javax.portlet.annotations.PortletQName},
+ {@link javax.portlet.annotations.PortletStateScoped},
+ {@link javax.portlet.annotations.Preference}, and
+ {@link javax.portlet.annotations.Supports}.
+ </li>
+ <li>
+ 20150907: Modified classes for configuration through annotations.
+ Added class {@link javax.portlet.annotations.PortletConfigurations} to allow
+ for configuration of multiple portlets within a single annotation.
+ </li>
+ <li>20150817: Fixed some inconsistencies associated with the custom CDI scope annotations.
+ Changed classes:
+ {@link javax.portlet.PortletURL#setBeanParameter PortletURL.setBeanParameter}.
+ Updated annotations:
+ {@link javax.portlet.annotations.PortletSessionScoped} and
+ {@link javax.portlet.annotations.URLFactory}.
+ </li>
+ <li>20150812: Update for
+ <a href="https://java.net/jira/browse/PORTLETSPEC3-56">PORTLETSPEC3-56</a>,
+ <a href="https://java.net/jira/browse/PORTLETSPEC3-55">PORTLETSPEC3-55</a>, and
+ <a href="https://java.net/jira/browse/PORTLETSPEC3-49">PORTLETSPEC3-49</a>.
+ Changed classes:
+ {@link javax.portlet.MimeResponse.Copy}.
+ Added method:
+ {@link javax.portlet.ActionResponse#getRedirectURL ActionResponse.getRedirectURL()}.
+ Updated annotations:
+ {@link javax.portlet.annotations.HeaderMethod},
+ {@link javax.portlet.annotations.RenderMethod}, and
+ {@link javax.portlet.annotations.ServeResourceMethod}.
+ </li>
+ <li>20150806: Update for
+ <a href="https://java.net/jira/browse/PORTLETSPEC3-54">
+ PORTLETSPEC3-54
+ </a>
+ Add Configuration Annotations for Custom Portlet Mode and Window State.
+ Changed class:
+ {@link javax.portlet.annotations.PortletConfiguration}.
+ Added annotation classes:
+ {@link javax.portlet.annotations.Supports},
+ {@link javax.portlet.annotations.CustomPortletMode},
+ {@link javax.portlet.annotations.CustomWindowState}.
+ </li>
+ <li>20150629: Added API proposal for injectable bean portlet objects. See:
+ {@link javax.portlet.annotations Annotations package info file}.
+ </li>
+ <li>20150618: Added API proposal for an annotation-based configuration interface. See:
+ {@link javax.portlet.annotations Annotations package info file}.
+ </li>
+ <li>20150225: Update for PORTLETSPEC3-50: Updated methods
+ {@link javax.portlet.MimeResponse#createRenderURL MimeResponse.createRenderURL())},
+ {@link javax.portlet.MimeResponse#createActionURL MimeResponse.createActionURL())},
+ {@link javax.portlet.MutablePortletParameters#set MutablePortletParameters.set()},
+ {@link javax.portlet.MutablePortletParameters#add MutablePortletParameters.add()},
+ {@link javax.portlet.PortletURLGenerationListener#filterRenderURL PortletURLGenerationListener.filterRenderURL()},
+ {@link javax.portlet.PortletURLGenerationListener#filterActionURL PortletURLGenerationListener.filterActionURL()}.
+ Added method
+ {@link javax.portlet.PortletParameters#size PortletParameters.size()}.
+ See
+ <a href="https://java.net/projects/portletspec3/pages/PortletConfiguration#PORTLETSPEC3-50">
+ PORTLETSPEC3-50
+ </a>
+ for discussion.
+ </li>
<li>20150202: Updated PORTLETSPEC3-18: Updated methods
{@link javax.portlet.PortletConfig#getPortletModes PortletConfig.getPortletModes(String)} and
{@link javax.portlet.PortletConfig#getWindowStates PortletConfig.getWindowStates(String)}.
@@ -37,7 +218,7 @@
<a href="../jsdoc/PortletInit.html#newParameters">newParameters</a>,
<a href="../jsdoc/PortletInit.html#newState">newState</a>.
<br>
- Added {@link javax.portlet.ResourceRequest#getPageState ResourceRequest#getPageState()} method
+ Added {@link javax.portlet.ResourceRequest#PAGE_STATE ResourceRequest#PAGE_STATE} constant
in support of the Portlet Hub partial action processing sequence.
</li>
<li>20140603: Resolved PORTLETSPEC3-43: Renamed some methods to reduce redundancy. See:
@@ -95,23 +276,21 @@
<li>20130829: PORTLETSPEC3-32: Changes in public render parameter handling on action URL. See
method descriptions
{@link javax.portlet.MimeResponse#createActionURL() createActionURL()} and
- {@link javax.portlet.MimeResponse#createActionURL(ParameterCopyOption) createActionURL(ParameterCopyOption)}.
+ {@link javax.portlet.MimeResponse#createActionURL(Copy) createActionURL(Copy)}.
See updated spec description
<a href="https://java.net/projects/portletspec3/pages/PortletURLs#PORTLETSPEC3-32">
portlet URLs
</a>.
</li>
<li>20130829: PORTLETSPEC3-30: Added new URL create methods to MimeResponse:
- {@link javax.portlet.MimeResponse#createRenderURL(ParameterCopyOption) createRenderURL(ParameterCopyOption)} and
- {@link javax.portlet.MimeResponse#createActionURL(ParameterCopyOption) createActionURL(ParameterCopyOption)}.
+ {@link javax.portlet.MimeResponse#createRenderURL(Copy) createRenderURL(Copy)} and
+ {@link javax.portlet.MimeResponse#createActionURL(Copy) createActionURL(Copy)}.
Updated
{@link javax.portlet.filter.RenderResponseWrapper RenderResponseWrapper} and
{@link javax.portlet.filter.ResourceResponseWrapper ResourceResponseWrapper}
accordingly.
</li>
<li>20130828: PORTLETSPEC3-13: Added several methods to BaseURL:
- {@link javax.portlet.BaseURL#setAuthenticated setAuthenticated},
- {@link javax.portlet.BaseURL#getAuthenticated getAuthenticated},
{@link javax.portlet.RenderURL#setFragmentIdentifier setFragmentIdentifier} and
{@link javax.portlet.RenderURL#getFragmentIdentifier getFragmentIdentifier}.
See
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/5fb26a1d/portlet-api/src/main/javadoc/portlet-api.css
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/javadoc/portlet-api.css b/portlet-api/src/main/javadoc/portlet-api.css
index 66a0d30..0861e7e 100644
--- a/portlet-api/src/main/javadoc/portlet-api.css
+++ b/portlet-api/src/main/javadoc/portlet-api.css
@@ -509,10 +509,13 @@ h1.hidden {
/* the href with the caret makes the links in the overview document work. */
/* the href with exact file specifier makes the links in the package lists work. */
+.indexContainer a[href*="BaseURL.html"],
.indexContainer a[href*="PortletConfig.html"],
.indexContainer a[href*="PortletPreferences.html"],
.indexContainer a[href*="GenericPortlet.html"],
.indexContainer a[href*="ActionRequest.html"],
+.indexContainer a[href*="ActionResponse.html"],
+.indexContainer a[href*="PortletResponse.html"],
.indexContainer a[href*="PortletRequest.html"],
.indexContainer a[href*="PortletURL.html"],
.indexContainer a[href*="PortletMode.html"],
@@ -521,7 +524,6 @@ h1.hidden {
.indexContainer a[href*="RenderResponse.html"],
.indexContainer a[href*="ResourceRequest.html"],
.indexContainer a[href*="PortletSession.html"],
-.indexContainer a[href*="BaseURL.html"],
.indexContainer a[href*="StateAwareResponse.html"],
.indexContainer a[href*="EventResponse.html"],
.indexContainer a[href*="MimeResponse.html"],
@@ -529,10 +531,15 @@ h1.hidden {
.indexContainer a[href*="ResourceResponse.html"],
.indexContainer a[href*="ActionRequestWrapper.html"],
.indexContainer a[href*="ActionResponseWrapper.html"],
+.indexContainer a[href*="EventRequestWrapper.html"],
.indexContainer a[href*="EventResponseWrapper.html"],
.indexContainer a[href*="PortletRequestWrapper.html"],
+.indexContainer a[href*="PortletResponseWrapper.html"],
+.indexContainer a[href*="RenderRequestWrapper.html"],
+.indexContainer a[href*="RenderResponseWrapper.html"],
.indexContainer a[href*="ResourceRequestWrapper.html"],
.indexContainer a[href*="ResourceResponseWrapper.html"],
+.indexContainer a[href*="RenderRequestWrapper.html"]
.indexContainer a[href*="RenderResponseWrapper.html"]
{
cursor: url(resources/changed_modified_3_0_cursor.png), auto;
@@ -544,9 +551,85 @@ h1.hidden {
/* List of added files */
+.indexContainer a[href*="ActionMethod.html"],
+.indexContainer a[href*="ActionParam.html"],
+.indexContainer a[href*="BeanPortlet.html"],
+.indexContainer a[href*="ClientDataRequestWrapper.html"],
+.indexContainer a[href*="ConditionalDispatcher.html"],
+.indexContainer a[href*="ConditionalDispatchMethod.html"],
+.indexContainer a[href*="ContentTypeSupport.html"],
+.indexContainer a[href*="ContextPath.html"],
+.indexContainer a[href*="Dependency.html"],
+.indexContainer a[href*="DestroyMethod.html"],
+.indexContainer a[href*="EventMethod.html"],
+.indexContainer a[href*="HeaderFilter.html"],
+.indexContainer a[href*="HeaderFilterChain.html"],
+.indexContainer a[href*="HeaderRequest.html"],
+.indexContainer a[href*="HeaderRequestWrapper.html"],
+.indexContainer a[href*="HeaderResponse.html"],
+.indexContainer a[href*="HeaderResponseWrapper.html"],
+.indexContainer a[href*="HeaderPortlet.html"],
+.indexContainer a[href*="HeaderMethod.html"],
+.indexContainer a[href*="InitMethod.html"],
+.indexContainer a[href*="InitParameter.html"],
+.indexContainer a[href*="RuntimeOption.html"],
+.indexContainer a[href*="LocaleString.html"],
+.indexContainer a[href*="package-info.html"],
+.indexContainer a[href*="MethodToken.html"],
+.indexContainer a[href*="MimeResponseWrapper.html"],
+.indexContainer a[href*="Namespace.html"],
+.indexContainer a[href*="PortletApplication.html"],
+.indexContainer a[href*="PortletConfiguration.html"],
+.indexContainer a[href*="PortletConfigurations.html"],
+.indexContainer a[href*="EventDefinition.html"],
+.indexContainer a[href*="PortletQName.html"],
+.indexContainer a[href*="PortletRequestFilter.html"],
+.indexContainer a[href*="PortletRequestScoped.html"],
+.indexContainer a[href*="PortletResources.html"],
+.indexContainer a[href*="PortletSerializable.html"],
+.indexContainer a[href*="PortletSessionScoped.html"],
+.indexContainer a[href*="PortletStateScoped.html"],
+.indexContainer a[href*="PortletListener.html"],
+.indexContainer a[href*="PortletListener.URLType.html"],
+.indexContainer a[href*="Preference.html"],
+.indexContainer a[href*="PreferencesValidator.html"],
+.indexContainer a[href*="PublicRenderParameterDefinition.html"],
+.indexContainer a[href*="RenderMethod.html"],
+.indexContainer a[href*="RenderParam.html"],
+.indexContainer a[href*="ResourceParam.html"],
+.indexContainer a[href*="ServeResourceMethod.html"],
+.indexContainer a[href*="SecurityRoleRef.html"],
+.indexContainer a[href*="StateAwareResponseWrapper.html"],
+.indexContainer a[href*="URLFactory.html"],
+.indexContainer a[href*="UserAttribute.html"],
+.indexContainer a[href*="WindowId.html"],
+.indexContainer a[href*="CustomPortletMode.html"],
+.indexContainer a[href*="CustomWindowState.html"],
+.indexContainer a[href*="Supports.html"],
+
+.indexContainer a[href*="ActionParametersWrapper.html"],
+.indexContainer a[href*="ActionURLWrapper.html"],
+.indexContainer a[href*="BaseURLWrapper.html"],
+.indexContainer a[href*="MutableActionParametersWrapper.html"],
+.indexContainer a[href*="MutablePortletParametersWrapper.html"],
+.indexContainer a[href*="MutablePortletStateWrapper.html"],
+.indexContainer a[href*="MutableRenderParametersWrapper.html"],
+.indexContainer a[href*="MutableResourceParametersWrapper.html"],
+.indexContainer a[href*="PortletConfigWrapper.html"],
+.indexContainer a[href*="PortletContextWrapper.html"],
+.indexContainer a[href*="PortletParametersWrapper.html"],
+.indexContainer a[href*="PortletRequestDispatcherWrapper.html"],
+.indexContainer a[href*="PortletSessionWrapper.html"],
+.indexContainer a[href*="PortletStateWrapper.html"],
+.indexContainer a[href*="PortletURLWrapper.html"],
+.indexContainer a[href*="RenderParametersWrapper.html"],
+.indexContainer a[href*="RenderURLWrapper.html"],
+.indexContainer a[href*="ResourceParametersWrapper.html"],
+.indexContainer a[href*="ResourceURLWrapper.html"],
+
.indexContainer a[href*="ActionURL.html"],
.indexContainer a[href*="RenderURL.html"],
-.indexContainer a[href*="MimeResponse.ParameterCopyOption.html"],
+.indexContainer a[href*="MimeResponse.Copy.html"],
.indexContainer a[href*="Mutable.html"],
.indexContainer a[href*="MutablePortletParameters.html"],
.indexContainer a[href*="PortletParameters.html"],
@@ -565,3 +648,27 @@ h1.hidden {
border-left-width:thin; border-right:none;
border-top:none; border-bottom:none; border-color:green
}
+
+
+.codebox {
+ font-family: 'Courier New', Courier, monospace;
+ margin: 0px 4px 8px 4px;
+ padding: 3px;
+ border:thin solid blue;
+ min-height: 10px;
+ background-color: #CFF;
+ display: inline-block;
+}
+
+table.ovtable {
+ border-collapse: collapse;
+}
+
+table.ovtable th, td {
+ border: 1px solid black;
+ padding: 2px 3px 2px 3px;
+}
+
+ul.nospace {
+ margin: 5px 0px;
+}