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 as...@apache.org on 2018/03/26 19:13:58 UTC
[3/4] portals-pluto git commit: PLUTO-695 Add the missing "since 3.0"
and CSS class "changed_added_3_0" to javadoc and remove the unnecessary
"@since 3.0"
PLUTO-695 Add the missing "since 3.0" and CSS class "changed_added_3_0" to javadoc and remove the unnecessary "@since 3.0"
Project: http://git-wip-us.apache.org/repos/asf/portals-pluto/repo
Commit: http://git-wip-us.apache.org/repos/asf/portals-pluto/commit/f75cca78
Tree: http://git-wip-us.apache.org/repos/asf/portals-pluto/tree/f75cca78
Diff: http://git-wip-us.apache.org/repos/asf/portals-pluto/diff/f75cca78
Branch: refs/heads/master
Commit: f75cca78f73907497bca93b2d22e7d21b32f0cb1
Parents: 240c3a9
Author: Leon Chi <ch...@qq.com>
Authored: Fri Mar 9 16:04:15 2018 +0800
Committer: Neil Griffin <ne...@gmail.com>
Committed: Mon Mar 26 14:42:15 2018 -0400
----------------------------------------------------------------------
.../java/javax/portlet/ActionParameters.java | 2 -
.../src/main/java/javax/portlet/ActionURL.java | 1 -
.../main/java/javax/portlet/GenericPortlet.java | 10 +++++
.../main/java/javax/portlet/HeaderRequest.java | 2 +
.../main/java/javax/portlet/HeaderResponse.java | 14 +++++++
.../javax/portlet/MutablePortletParameters.java | 13 ------
.../javax/portlet/MutableRenderParameters.java | 2 -
.../java/javax/portlet/MutableRenderState.java | 5 ---
.../java/javax/portlet/PortletAsyncContext.java | 24 -----------
.../java/javax/portlet/PortletAsyncEvent.java | 15 -------
.../javax/portlet/PortletAsyncListener.java | 8 ----
.../main/java/javax/portlet/PortletMode.java | 6 +++
.../java/javax/portlet/PortletParameters.java | 6 ---
.../java/javax/portlet/RenderParameters.java | 4 --
.../main/java/javax/portlet/RenderState.java | 3 --
.../src/main/java/javax/portlet/RenderURL.java | 2 -
.../java/javax/portlet/ResourceParameters.java | 1 -
.../java/javax/portlet/ResourceRequest.java | 4 ++
.../java/javax/portlet/ResourceResponse.java | 4 ++
.../main/java/javax/portlet/WindowState.java | 6 +++
.../javax/portlet/annotations/ActionMethod.java | 7 +++-
.../javax/portlet/annotations/ContextPath.java | 2 +
.../portlet/annotations/CustomPortletMode.java | 10 +++--
.../portlet/annotations/CustomWindowState.java | 6 ++-
.../javax/portlet/annotations/Dependency.java | 8 ++++
.../portlet/annotations/DestroyMethod.java | 5 ++-
.../portlet/annotations/EventDefinition.java | 12 ++++--
.../javax/portlet/annotations/EventMethod.java | 9 +++--
.../javax/portlet/annotations/HeaderMethod.java | 12 ++++++
.../javax/portlet/annotations/InitMethod.java | 5 ++-
.../portlet/annotations/InitParameter.java | 8 +++-
.../javax/portlet/annotations/LocaleString.java | 6 ++-
.../javax/portlet/annotations/Multipart.java | 12 ++++++
.../javax/portlet/annotations/Namespace.java | 2 +
.../portlet/annotations/PortletApplication.java | 20 ++++++----
.../annotations/PortletConfiguration.java | 42 +++++++++++++-------
.../annotations/PortletConfigurations.java | 4 ++
.../annotations/PortletLifecycleFilter.java | 13 +++---
.../portlet/annotations/PortletListener.java | 12 ++++--
.../javax/portlet/annotations/PortletName.java | 2 +
.../PortletPreferencesValidator.java | 5 ++-
.../javax/portlet/annotations/PortletQName.java | 6 +++
.../annotations/PortletRequestScoped.java | 3 +-
.../annotations/PortletSerializable.java | 8 +++-
.../annotations/PortletSessionScoped.java | 5 ++-
.../javax/portlet/annotations/Preference.java | 8 ++++
.../PublicRenderParameterDefinition.java | 10 +++--
.../javax/portlet/annotations/RenderMethod.java | 13 +++++-
.../portlet/annotations/RenderStateScoped.java | 6 ++-
.../portlet/annotations/RuntimeOption.java | 6 +++
.../portlet/annotations/SecurityRoleRef.java | 8 ++--
.../annotations/ServeResourceMethod.java | 19 ++++++++-
.../javax/portlet/annotations/Supports.java | 8 ++--
.../portlet/annotations/UserAttribute.java | 6 ++-
.../javax/portlet/annotations/WindowId.java | 2 +
.../javax/portlet/annotations/package-info.java | 2 +
.../portlet/filter/ActionParametersWrapper.java | 1 +
.../javax/portlet/filter/ActionURLWrapper.java | 1 +
.../javax/portlet/filter/BaseURLWrapper.java | 1 +
.../filter/ClientDataRequestWrapper.java | 2 +
.../java/javax/portlet/filter/HeaderFilter.java | 4 +-
.../javax/portlet/filter/HeaderFilterChain.java | 2 +
.../portlet/filter/HeaderRequestWrapper.java | 4 +-
.../portlet/filter/HeaderResponseWrapper.java | 2 +
.../portlet/filter/MimeResponseWrapper.java | 2 +
.../filter/MutableActionParametersWrapper.java | 1 +
.../filter/MutablePortletParametersWrapper.java | 1 +
.../filter/MutableRenderParametersWrapper.java | 1 +
.../filter/MutableRenderStateWrapper.java | 1 +
.../MutableResourceParametersWrapper.java | 1 +
.../portlet/filter/PortalContextWrapper.java | 5 +++
.../filter/PortletAsyncContextWrapper.java | 1 +
.../portlet/filter/PortletConfigWrapper.java | 5 +++
.../portlet/filter/PortletContextWrapper.java | 5 +++
.../filter/PortletParametersWrapper.java | 5 +++
.../filter/PortletRequestDispatcherWrapper.java | 6 +++
.../portlet/filter/PortletSessionWrapper.java | 5 +++
.../javax/portlet/filter/PortletURLWrapper.java | 1 +
.../portlet/filter/RenderParametersWrapper.java | 1 +
.../portlet/filter/RenderStateWrapper.java | 5 +++
.../javax/portlet/filter/RenderURLWrapper.java | 1 +
.../filter/ResourceParametersWrapper.java | 1 +
.../portlet/filter/ResourceURLWrapper.java | 1 +
.../filter/StateAwareResponseWrapper.java | 2 +
84 files changed, 355 insertions(+), 157 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/ActionParameters.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/ActionParameters.java b/portlet-api/src/main/java/javax/portlet/ActionParameters.java
index 35248ed..4db2786 100644
--- a/portlet-api/src/main/java/javax/portlet/ActionParameters.java
+++ b/portlet-api/src/main/java/javax/portlet/ActionParameters.java
@@ -52,8 +52,6 @@ public interface ActionParameters extends PortletParameters
* </div>
*
* @return Mutable clone of ActionParameters object
- *
- * @since 3.0
*/
public MutableActionParameters clone();
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/ActionURL.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/ActionURL.java b/portlet-api/src/main/java/javax/portlet/ActionURL.java
index 1f54f2a..b3b9241 100644
--- a/portlet-api/src/main/java/javax/portlet/ActionURL.java
+++ b/portlet-api/src/main/java/javax/portlet/ActionURL.java
@@ -54,7 +54,6 @@ public interface ActionURL extends PortletURL
*
* @return a <code>MutableActionParameters</code> object representing
* the action parameters.
- * @since 3.0
* @see ActionParameters
* @see MutableActionParameters
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/GenericPortlet.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/GenericPortlet.java b/portlet-api/src/main/java/javax/portlet/GenericPortlet.java
index 93c0b77..6441d43 100644
--- a/portlet-api/src/main/java/javax/portlet/GenericPortlet.java
+++ b/portlet-api/src/main/java/javax/portlet/GenericPortlet.java
@@ -75,11 +75,15 @@ import javax.xml.namespace.QName;
public abstract class GenericPortlet implements Portlet, PortletConfig, EventPortlet, ResourceServingPortlet, HeaderPortlet {
/**
+ * <div class="changed_added_3_0">
* This property is set by the container if the container
* has a cached response for the given validation tag. The property can be
* retrieved using the <code>getProperty</code> method.
* <P>
* The value is <code>"javax.portlet.automaticResourceDispatching"</code>.
+ * </div>
+ *
+ * @since 3.0
*/
public static final String AUTOMATIC_RESOURCE_DISPATCH = "javax.portlet.automaticResourceDispatching";
@@ -941,6 +945,8 @@ public abstract class GenericPortlet implements Portlet, PortletConfig, EventPor
* if the streaming causes an I/O problem
*
* @see #processAction(ActionRequest, ActionResponse)
+ *
+ * @since 3.0
*/
protected boolean dispatchAnnotatedActionMethod(String name, ActionRequest request,
ActionResponse response) throws PortletException, java.io.IOException {
@@ -1004,6 +1010,8 @@ public abstract class GenericPortlet implements Portlet, PortletConfig, EventPor
* if the streaming causes an I/O problem
*
* @see #processEvent(EventRequest, EventResponse)
+ *
+ * @since 3.0
*/
protected boolean dispatchAnnotatedEventMethod(String name, EventRequest request,
EventResponse response) throws PortletException, java.io.IOException {
@@ -1070,6 +1078,8 @@ public abstract class GenericPortlet implements Portlet, PortletConfig, EventPor
* if the streaming causes an I/O problem
*
* @see #doDispatch(RenderRequest, RenderResponse)
+ *
+ * @since 3.0
*/
protected boolean dispatchAnnotatedRenderMethod(String name, RenderRequest request,
RenderResponse response) throws PortletException, java.io.IOException {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/HeaderRequest.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/HeaderRequest.java b/portlet-api/src/main/java/javax/portlet/HeaderRequest.java
index ba283fb..22f1b70 100644
--- a/portlet-api/src/main/java/javax/portlet/HeaderRequest.java
+++ b/portlet-api/src/main/java/javax/portlet/HeaderRequest.java
@@ -36,6 +36,8 @@ package javax.portlet;
*
*@see HeaderResponse
*@see HeaderPortlet
+ *
+ * @since 3.0
*/
public interface HeaderRequest extends RenderRequest {
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/HeaderResponse.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/HeaderResponse.java b/portlet-api/src/main/java/javax/portlet/HeaderResponse.java
index af36cef..7a2f55c 100644
--- a/portlet-api/src/main/java/javax/portlet/HeaderResponse.java
+++ b/portlet-api/src/main/java/javax/portlet/HeaderResponse.java
@@ -51,13 +51,17 @@ package javax.portlet;
* @see HeaderPortlet
* @see PortletResponse
* @see MimeResponse
+ *
+ * @since 3.0
*/
public interface HeaderResponse extends MimeResponse {
/**
+ * <div class="changed_added_3_0">
* This method sets the title of the portlet.
* <p>
* The value can be a text String
+ * </div>
*
* @param title
* portlet title as text String or resource URI
@@ -65,6 +69,7 @@ public interface HeaderResponse extends MimeResponse {
public void setTitle(String title);
/**
+ * <div class="changed_added_3_0">
* Sets the MIME type for the header response. The portlet should set the
* content type before calling {@link #getWriter} or
* {@link #getPortletOutputStream}.
@@ -75,6 +80,7 @@ public interface HeaderResponse extends MimeResponse {
* The portlet container will ignore any character encoding
* specified as part of the content type for <code>render</code>
* calls.
+ * </div>
*
* @param type
* the content MIME type
@@ -89,22 +95,27 @@ public interface HeaderResponse extends MimeResponse {
public void setContentType(String type);
/**
+ * <div class="changed_added_3_0">
* Data written to the <code>HeaderResponse</code> writer is added
* to the aggregated portal document <code>HEAD</code> section.
* <p>
* {@inheritDoc}
+ * </div>
*/
public java.io.PrintWriter getWriter() throws java.io.IOException;
/**
+ * <div class="changed_added_3_0">
* Data written to the <code>HeaderResponse</code> output stream is added
* to the aggregated portal document <code>HEAD</code> section.
* <p>
* {@inheritDoc}
+ * </div>
*/
public java.io.OutputStream getPortletOutputStream() throws java.io.IOException;
/**
+ * <div class="changed_added_3_0">
* Adds a dependency on a page-level resource that is managed by the portal.
* <p>
* When a portlet is aggregated onto a page, it may designate resources such as
@@ -138,6 +149,7 @@ public interface HeaderResponse extends MimeResponse {
* <p>
* The manner in which the portal maps the specified name, scope, and version to
* specific resources is left to the portal implementation.
+ * </div>
*
* @param name the resource name
* @param scope the resource scope, may be <code>null</code> or empty
@@ -153,6 +165,7 @@ public interface HeaderResponse extends MimeResponse {
public void addDependency(String name, String scope, String version);
/**
+ * <div class="changed_added_3_0">
* Adds a dependency on a page-level resource that is managed by the portal
* and adds a resource for addition to the page for the dependency.
* <p>
@@ -172,6 +185,7 @@ public interface HeaderResponse extends MimeResponse {
* portlet on the same page provides a resource with the same name and scope but
* a version of 2.1.0, the aggregating portal may choose to include the later
* version of the resource on the page.
+ * </div>
*
* @param name the resource name
* @param scope the resource scope, may be <code>null</code> or empty
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/MutablePortletParameters.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/MutablePortletParameters.java b/portlet-api/src/main/java/javax/portlet/MutablePortletParameters.java
index 1d2266b..4d6a08f 100644
--- a/portlet-api/src/main/java/javax/portlet/MutablePortletParameters.java
+++ b/portlet-api/src/main/java/javax/portlet/MutablePortletParameters.java
@@ -61,8 +61,6 @@ public interface MutablePortletParameters extends PortletParameters, Mutable {
* the name of a parameter; or an
* empty <code>Set</code> if the
* MutablePortletParameters object has no parameters.
- *
- * @since 3.0
*/
public Set<String> getNames();
@@ -88,8 +86,6 @@ public interface MutablePortletParameters extends PortletParameters, Mutable {
* @return The previous parameter value, or
* <code>null</code> if there was no previous value.
*
- * @since 3.0
- *
* @exception java.lang.IllegalArgumentException
* if name is <code>null</code>.
*/
@@ -123,8 +119,6 @@ public interface MutablePortletParameters extends PortletParameters, Mutable {
* @return The previous parameter value array, or
* <code>null</code> if there was no previous value.
*
- * @since 3.0
- *
* @exception java.lang.IllegalArgumentException
* if name is <code>null</code>
*/
@@ -145,8 +139,6 @@ public interface MutablePortletParameters extends PortletParameters, Mutable {
* if name is <code>null</code>.
*
* @return <code>true</code> if the parameter name was present.
- *
- * @since 3.0
*/
public boolean removeParameter (String name);
@@ -164,8 +156,6 @@ public interface MutablePortletParameters extends PortletParameters, Mutable {
* @param params - input portlet parameters
*
* @return MutablePortletParameters object containing the previous values
- *
- * @since 3.0
*/
public MutablePortletParameters set(PortletParameters params);
@@ -185,8 +175,6 @@ public interface MutablePortletParameters extends PortletParameters, Mutable {
* @param params - input portlet parameters
*
* @return MutablePortletParameters object containing the previous values
- *
- * @since 3.0
*/
public MutablePortletParameters add(PortletParameters params);
@@ -196,7 +184,6 @@ public interface MutablePortletParameters extends PortletParameters, Mutable {
* <div class="changed_added_3_0">
* Clears all parameters.
* </div>
- * @since 3.0
*/
public void clear();
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/MutableRenderParameters.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/MutableRenderParameters.java b/portlet-api/src/main/java/javax/portlet/MutableRenderParameters.java
index 164b5a1..9652cc2 100644
--- a/portlet-api/src/main/java/javax/portlet/MutableRenderParameters.java
+++ b/portlet-api/src/main/java/javax/portlet/MutableRenderParameters.java
@@ -57,7 +57,6 @@ public interface MutableRenderParameters extends
* Clears all private parameters that are present in the
* <code>MutableRenderParameters</code> object.
* </div>
- * @since 3.0
*/
public void clearPrivate();
@@ -68,7 +67,6 @@ public interface MutableRenderParameters extends
* Clears all public parameters that are present in the
* <code>MutableRenderParameters</code> object.
* </div>
- * @since 3.0
*/
public void clearPublic();
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/MutableRenderState.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/MutableRenderState.java b/portlet-api/src/main/java/javax/portlet/MutableRenderState.java
index 74e6a77..047a359 100644
--- a/portlet-api/src/main/java/javax/portlet/MutableRenderState.java
+++ b/portlet-api/src/main/java/javax/portlet/MutableRenderState.java
@@ -63,7 +63,6 @@ public interface MutableRenderState extends RenderState, Mutable {
*
* @return a <code>MutableRenderParameters</code> object representing
* the private and public render parameters
- * @since 3.0
* @see PortletParameters
* @see RenderParameters
* @see MutablePortletParameters
@@ -110,8 +109,6 @@ public interface MutableRenderState extends RenderState, Mutable {
* has been called.
* @exception java.lang.IllegalArgumentException
* if the input parameter is <code>null</code>.
- *
- * @since 3.0
*/
public void setPortletMode(PortletMode portletMode)
@@ -151,8 +148,6 @@ public interface MutableRenderState extends RenderState, Mutable {
* @exception java.lang.IllegalArgumentException
* if the input parameter is <code>null</code>.
*
- * @since 3.0
- *
*/
public void setWindowState(WindowState windowState)
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/PortletAsyncContext.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/PortletAsyncContext.java b/portlet-api/src/main/java/javax/portlet/PortletAsyncContext.java
index 0963752..ef3c685 100644
--- a/portlet-api/src/main/java/javax/portlet/PortletAsyncContext.java
+++ b/portlet-api/src/main/java/javax/portlet/PortletAsyncContext.java
@@ -75,8 +75,6 @@ public interface PortletAsyncContext {
* @see PortletAsyncListener
* @see PortletAsyncEvent
*
- * @since 3.0
- *
* @param listener the listener to be added
* @throws IllegalStateException
* if this method is called after the container-initiated dispatch, during which
@@ -116,8 +114,6 @@ public interface PortletAsyncContext {
* @see PortletAsyncListener
* @see PortletAsyncEvent
*
- * @since 3.0
- *
* @param listener the listener to be added
* @param request the request object to be included in the <code>PortletAsyncEvent</code>
* @param response the response object to be included in the <code>PortletAsyncEvent</code>
@@ -150,8 +146,6 @@ public interface PortletAsyncContext {
* container.
* </div>
*
- * @since 3.0
- *
* @throws IllegalStateException
* if this method is called before an asynchronous processing cycle was started,
* after it has already been completed, or after a call to
@@ -176,8 +170,6 @@ public interface PortletAsyncContext {
* about Managed Beans and resource injection.
* </div>
*
- * @since 3.0
- *
* @param cls the class to be instantiated
* @return the instantiated class
* @throws PortletException if the given class cannot be instantiated
@@ -241,8 +233,6 @@ public interface PortletAsyncContext {
* <code>complete()</code> method may be called.
* </div>
*
- * @since 3.0
- *
* @throws IllegalStateException
* if called before an asynchronous processing cycle has been started,
* if one of the dispatch methods has been called but the <code>startAsync</code> method has not
@@ -271,8 +261,6 @@ public interface PortletAsyncContext {
* See {@link #dispatch()} for additional details, including error handling.
* </div>
*
- * @since 3.0
- *
* @param path the path of the dispatch target, scoped to the PortletContext from which
* this PortletAsyncContext was initialized
* @throws IllegalStateException
@@ -288,8 +276,6 @@ public interface PortletAsyncContext {
* <code>ResourceRequest.startAsync()</code> or <code>ResourceRequest.startAsync(ServletRequest, ServletResponse)</code>.
* </div>
*
- * @since 3.0
- *
* @return The resource request object
* @throws IllegalStateException
* if one of the dispatch methods has been called but the <code>startAsync</code> method has not
@@ -303,8 +289,6 @@ public interface PortletAsyncContext {
* <code>ResourceRequest.startAsync()</code> or <code>ResourceRequest.startAsync(ServletRequest, ServletResponse)</code>.
* </div>
*
- * @since 3.0
- *
* @return The resource response object
* @throws IllegalStateException
* if one of the dispatch methods has been called but the <code>startAsync</code> method has not
@@ -323,8 +307,6 @@ public interface PortletAsyncContext {
* A timeout value of zero or less indicates no timeout.
* </div>
*
- * @since 3.0
- *
* @return the timeout in milliseconds
*/
public long getTimeout();
@@ -340,8 +322,6 @@ public interface PortletAsyncContext {
* be preserved for the duration of the asynchronous operation, or may be released.
* </div>
*
- * @since 3.0
- *
* @return
* <code>true</code> if this <code>PortletAsyncContext</code> was initialized with the original
* request and response objects by calling <code>ResourceRequest.startAsync()</code>,
@@ -372,8 +352,6 @@ public interface PortletAsyncContext {
* The default value is 30000 ms.
* </div>
*
- * @since 3.0
- *
* @param time the timeout in milliseconds
*/
public void setTimeout(long time);
@@ -385,8 +363,6 @@ public interface PortletAsyncContext {
* contextual information to the <code>Runnable</code>.
* </div>
*
- * @since 3.0
- *
* @param run the asynchronous handler
* @throws IllegalStateException
* if this method is called before an asynchronous processing cycle was started,
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/PortletAsyncEvent.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/PortletAsyncEvent.java b/portlet-api/src/main/java/javax/portlet/PortletAsyncEvent.java
index 7829890..e94426d 100644
--- a/portlet-api/src/main/java/javax/portlet/PortletAsyncEvent.java
+++ b/portlet-api/src/main/java/javax/portlet/PortletAsyncEvent.java
@@ -47,8 +47,6 @@ public class PortletAsyncEvent {
* and <code>Throwable</code>.
* </div>
*
- * @since 3.0
- *
* @param context
* @param request
* @param response
@@ -67,7 +65,6 @@ public class PortletAsyncEvent {
* <code>PortletAsyncContext</code>, <code>ResourceRequest</code>, and <code>ResourceResponse</code>.
* </div>
*
- * @since 3.0
* @param context
* @param request
* @param response
@@ -85,8 +82,6 @@ public class PortletAsyncEvent {
* <code>PortletAsyncContext</code> and <code>Throwable</code>.
* </div>
*
- * @since 3.0
- *
* @param context
* @param throwable
*/
@@ -103,8 +98,6 @@ public class PortletAsyncEvent {
* <code>PortletAsyncContext</code>.
* </div>
*
- * @since 3.0
- *
* @param context
*/
public PortletAsyncEvent(PortletAsyncContext context) {
@@ -119,8 +112,6 @@ public class PortletAsyncEvent {
* Gets the portlet asynchronous context object associated with the event.
* </div>
*
- * @since 3.0
- *
* @return the portlet asynchronous context
*/
public PortletAsyncContext getPortletAsyncContext() {
@@ -138,8 +129,6 @@ public class PortletAsyncEvent {
* the returned resource request will be <code>null</code>.
* </div>
*
- * @since 3.0
- *
* @return the resource request provided to the constructor, or <code>null</code>
* if no resource request was provided.
*/
@@ -158,8 +147,6 @@ public class PortletAsyncEvent {
* the returned resource response will be <code>null</code>.
* </div>
*
- * @since 3.0
- *
* @return the resource response provided to the constructor, or <code>null</code>
* if no resource response was provided.
*/
@@ -172,8 +159,6 @@ public class PortletAsyncEvent {
* Gets the <code>Throwable</code> associated with the event.
* </div>
*
- * @since 3.0
- *
* @return The <code>Throwable</code> that was used to initialize the event, or <code>null</code>
* if no <code>Throwable</code> was provided.
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/PortletAsyncListener.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/PortletAsyncListener.java b/portlet-api/src/main/java/javax/portlet/PortletAsyncListener.java
index 0b825da..86aed87 100644
--- a/portlet-api/src/main/java/javax/portlet/PortletAsyncListener.java
+++ b/portlet-api/src/main/java/javax/portlet/PortletAsyncListener.java
@@ -54,8 +54,6 @@ public interface PortletAsyncListener {
* within this method.
* </div>
*
- * @since 3.0
- *
* @param evt the <code>PortletAsyncEvent</code> indicating that an asynchronous operation has been completed
* @throws IOException if an I/O related error has occurred during the processing
*/
@@ -81,8 +79,6 @@ public interface PortletAsyncListener {
* within this method.
* </div>
*
- * @since 3.0
- *
* @param evt the PortletAsyncEvent indicating that an asynchronous operation has
* encountered an error
* @throws IOException if an I/O related error has occurred during the processing
@@ -113,8 +109,6 @@ public interface PortletAsyncListener {
* event.
* </div>
*
- * @since 3.0
- *
* @param evt the PortletAsyncEvent indicating that an asynchronous operation
* is being initiated
* @throws IOException if an I/O related error has occurred during the processing
@@ -142,8 +136,6 @@ public interface PortletAsyncListener {
*
* </div>
*
- * @since 3.0
- *
* @param evt the PortletAsyncEvent indicating that an asynchronous operation has
* timed out
* @throws IOException if an I/O related error has occurred during the processing
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/PortletMode.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/PortletMode.java b/portlet-api/src/main/java/javax/portlet/PortletMode.java
index 0c7d435..a6d8c25 100644
--- a/portlet-api/src/main/java/javax/portlet/PortletMode.java
+++ b/portlet-api/src/main/java/javax/portlet/PortletMode.java
@@ -50,6 +50,8 @@ public class PortletMode {
* This mode may not be used to set the portlet mode in the <code>setPortletMode</code> method.
* <p>
* The string value for this mode is <code>"undefined"</code>. </div>
+ *
+ * @since 3.0
*/
public final static PortletMode UNDEFINED = new PortletMode("undefined");
@@ -92,7 +94,11 @@ public class PortletMode {
private String _name;
/**
+ * <div class="changed_added_3_0">
* No-arg constructor to make object proxyable
+ * </div>
+ *
+ * @since 3.0
*/
public PortletMode() {
_name = "undefined";
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/PortletParameters.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/PortletParameters.java b/portlet-api/src/main/java/javax/portlet/PortletParameters.java
index 2eeecf8..dd4e3b0 100644
--- a/portlet-api/src/main/java/javax/portlet/PortletParameters.java
+++ b/portlet-api/src/main/java/javax/portlet/PortletParameters.java
@@ -136,7 +136,6 @@ public interface PortletParameters
*
* @see #getValues
* @see #getNames
- * @since 3.0
*
* @exception java.lang.IllegalArgumentException
* if name is <code>null</code>.
@@ -164,7 +163,6 @@ public interface PortletParameters
* empty <code>Set</code> if the
* PortletParameters object has no parameters.
*
- * @since 3.0
*/
public Set<String> getNames();
@@ -191,7 +189,6 @@ public interface PortletParameters
* if the parameter does not exist.
*
* @see #getValue
- * @since 3.0
*
* @exception java.lang.IllegalArgumentException
* if name is <code>null</code>.
@@ -209,7 +206,6 @@ public interface PortletParameters
* @return <code>true</code> if the object contains no parameters.
* <code>false</code> otherwise
*
- * @since 3.0
*/
public boolean isEmpty ();
@@ -222,7 +218,6 @@ public interface PortletParameters
*
* @return the number of parameters in this object
*
- * @since 3.0
*/
public int size();
@@ -237,7 +232,6 @@ public interface PortletParameters
*
* @return Mutable clone of PortletParameters object
*
- * @since 3.0
*/
public MutablePortletParameters clone();
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/RenderParameters.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/RenderParameters.java b/portlet-api/src/main/java/javax/portlet/RenderParameters.java
index 0ec8abc..0bb03ba 100644
--- a/portlet-api/src/main/java/javax/portlet/RenderParameters.java
+++ b/portlet-api/src/main/java/javax/portlet/RenderParameters.java
@@ -45,8 +45,6 @@ public interface RenderParameters extends PortletParameters
* </div>
*
* @return Mutable clone of RenderParameters object
- *
- * @since 3.0
*/
public MutableRenderParameters clone();
@@ -69,8 +67,6 @@ public interface RenderParameters extends PortletParameters
*
* @exception java.lang.IllegalArgumentException
* if name is <code>null</code>.
- *
- * @since 3.0
*/
public boolean isPublic (String name);
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/RenderState.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/RenderState.java b/portlet-api/src/main/java/javax/portlet/RenderState.java
index 09d3232..5b0d48c 100644
--- a/portlet-api/src/main/java/javax/portlet/RenderState.java
+++ b/portlet-api/src/main/java/javax/portlet/RenderState.java
@@ -56,7 +56,6 @@ public interface RenderState {
*
* @return an immutable <code>RenderParameters</code> object representing
* the private and public render parameters
- * @since 3.0
* @see PortletParameters
* @see RenderParameters
*/
@@ -72,7 +71,6 @@ public interface RenderState {
* @return the portlet mode. If the portlet mode is not available,
* {@link PortletMode#UNDEFINED} is returned.
* @see PortletMode
- * @since 3.0
*/
public PortletMode getPortletMode();
@@ -86,7 +84,6 @@ public interface RenderState {
* @return the window state. If the window state is not available,
* {@link WindowState#UNDEFINED} is returned.
* @see WindowState
- * @since 3.0
*/
public WindowState getWindowState();
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/RenderURL.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/RenderURL.java b/portlet-api/src/main/java/javax/portlet/RenderURL.java
index 2ae0bfb..f0bfbae 100644
--- a/portlet-api/src/main/java/javax/portlet/RenderURL.java
+++ b/portlet-api/src/main/java/javax/portlet/RenderURL.java
@@ -66,7 +66,6 @@ public interface RenderURL extends PortletURL
* @param fragment
* The fragment identifier to be added to the URL
*
- * @since 3.0
*
* @see #getFragmentIdentifier
*/
@@ -87,7 +86,6 @@ public interface RenderURL extends PortletURL
* The fragment identifier set on the URL, or
* <code>null</code> if no fragment identifier has been set.
*
- * @since 3.0
* @see #setFragmentIdentifier
*/
public String getFragmentIdentifier();
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/ResourceParameters.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/ResourceParameters.java b/portlet-api/src/main/java/javax/portlet/ResourceParameters.java
index 5f2c7aa..6a9009e 100644
--- a/portlet-api/src/main/java/javax/portlet/ResourceParameters.java
+++ b/portlet-api/src/main/java/javax/portlet/ResourceParameters.java
@@ -52,7 +52,6 @@ public interface ResourceParameters extends PortletParameters
*
* @return Mutable clone of ResourceParameters object
*
- * @since 3.0
*/
public MutableResourceParameters clone();
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/ResourceRequest.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/ResourceRequest.java b/portlet-api/src/main/java/javax/portlet/ResourceRequest.java
index 1b793a1..58f7885 100644
--- a/portlet-api/src/main/java/javax/portlet/ResourceRequest.java
+++ b/portlet-api/src/main/java/javax/portlet/ResourceRequest.java
@@ -187,6 +187,8 @@ public interface ResourceRequest extends ClientDataRequest {
* The portlet mode UNDEFINED will be returned if the cache level is
* set to <code>ResourceURL.FULL</code>.
* </span>
+ *
+ * @since 3.0
*/
public PortletMode getPortletMode ();
@@ -207,6 +209,8 @@ public interface ResourceRequest extends ClientDataRequest {
* The window state UNDEFINED will be returned if the cache level is
* set to <code>ResourceURL.FULL</code>.
* </span>
+ *
+ * @since 3.0
*/
public WindowState getWindowState ();
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/ResourceResponse.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/ResourceResponse.java b/portlet-api/src/main/java/javax/portlet/ResourceResponse.java
index 1fe5fff..680329e 100644
--- a/portlet-api/src/main/java/javax/portlet/ResourceResponse.java
+++ b/portlet-api/src/main/java/javax/portlet/ResourceResponse.java
@@ -184,6 +184,8 @@ public interface ResourceResponse extends MimeResponse {
* triggering this <code>serveResource</code> call
* is not <code>PAGE</code> and thus does not allow
* for creating render URLs.
+ *
+ * @since 3.0
*/
public RenderURL createRenderURL(Copy option);
@@ -202,6 +204,8 @@ public interface ResourceResponse extends MimeResponse {
* triggering this <code>serveResource</code> call
* is not <code>PAGE</code> and thus does not allow
* for creating action URLs.
+ *
+ * @since 3.0
*/
public ActionURL createActionURL(Copy option);
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/WindowState.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/WindowState.java b/portlet-api/src/main/java/javax/portlet/WindowState.java
index fcaf234..962632e 100644
--- a/portlet-api/src/main/java/javax/portlet/WindowState.java
+++ b/portlet-api/src/main/java/javax/portlet/WindowState.java
@@ -45,6 +45,8 @@ public class WindowState {
* This mode may not be used to set the window state in the <code>setWindowState</code> method.
* <p>
* The string value for this mode is <code>"undefined"</code>. </div>
+ *
+ * @since 3.0
*/
public final static WindowState UNDEFINED = new WindowState("undefined");
@@ -77,7 +79,11 @@ public class WindowState {
private String _name;
/**
+ * <div class="changed_added_3_0">
* No-arg constructor to make object proxyable
+ * </div>
+ *
+ * @since 3.0
*/
public WindowState() {
_name = "undefined";
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/ActionMethod.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/ActionMethod.java b/portlet-api/src/main/java/javax/portlet/annotations/ActionMethod.java
index 477f97e..6535f59 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/ActionMethod.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/ActionMethod.java
@@ -50,19 +50,23 @@ import static java.lang.annotation.RetentionPolicy.*;
*
* @see javax.portlet.Portlet#processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse) processAction
*
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({METHOD})
public @interface ActionMethod {
/**
+ * <div class='changed_added_3_0'>
* The portlet name for the annotated method.
+ * </div>
*
* @return The portlet name
*/
String portletName();
/**
+ * <div class='changed_added_3_0'>
* The action name.
* <p>
* If an action name is specified, the bean enabler will dispatch Action requests with
@@ -70,13 +74,14 @@ public @interface ActionMethod {
* <p>
* An ActionMethod with an empty action name will receive all
* Action requests not dispatched to other named ActionMethods.
+ * </div>
*
* @return The action name
*/
String actionName() default "";
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The QName definitions of the events published by this method.
* </div>
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/ContextPath.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/ContextPath.java b/portlet-api/src/main/java/javax/portlet/annotations/ContextPath.java
index c8eb651..356503e 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/ContextPath.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/ContextPath.java
@@ -51,6 +51,8 @@ import static java.lang.annotation.RetentionPolicy.*;
* </div>
*
* @see javax.portlet.PortletRequest#getContextPath() getContextPath
+ *
+ * @since 3.0
*/
@Qualifier @Retention(RUNTIME) @Target({METHOD, FIELD, PARAMETER})
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/CustomPortletMode.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/CustomPortletMode.java b/portlet-api/src/main/java/javax/portlet/annotations/CustomPortletMode.java
index 45774a6..200e3fc 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/CustomPortletMode.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/CustomPortletMode.java
@@ -38,12 +38,14 @@ import static java.lang.annotation.RetentionPolicy.*;
* represent a custom portlet mode.
* It cannot be used as a stand-alone portlet annotation.
* </div>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({ANNOTATION_TYPE})
public @interface CustomPortletMode {
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* Provides locale-specific text describing the custom portlet mode for use by the portal application or by tools.
* </div>
*
@@ -52,7 +54,7 @@ public @interface CustomPortletMode {
LocaleString[] description() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The custom portlet mode name.
* <p>
* The name by which the portlet mode is identified.
@@ -63,14 +65,14 @@ public @interface CustomPortletMode {
String name();
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The portal managed flag.
* <p>
* If set to <code>true</code>, the custom portlet mode will be managed by the portal.
* If set to <code>false</code>, the custom portlet mode will be managed by the portlet.
* </div>
*
- * @return The portal managed flag setting
+ * @return The portal managed flag setting
*/
boolean portalManaged() default true;
}
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/CustomWindowState.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/CustomWindowState.java b/portlet-api/src/main/java/javax/portlet/annotations/CustomWindowState.java
index bee3f36..6ba823f 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/CustomWindowState.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/CustomWindowState.java
@@ -38,12 +38,14 @@ import static java.lang.annotation.RetentionPolicy.*;
* represent a custom window state.
* It cannot be used as a stand-alone portlet annotation.
* </div>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({ANNOTATION_TYPE})
public @interface CustomWindowState {
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* Provides locale-specific text describing the custom window state for use by the portal application or by tools.
* </div>
*
@@ -52,7 +54,7 @@ public @interface CustomWindowState {
LocaleString[] description() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The custom window state name.
* <p>
* The name by which the window state is identified.
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/Dependency.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/Dependency.java b/portlet-api/src/main/java/javax/portlet/annotations/Dependency.java
index 0e2ce0f..2abe1ce 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/Dependency.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/Dependency.java
@@ -41,26 +41,34 @@ import static java.lang.annotation.RetentionPolicy.*;
* <p>
* This annotation cannot be used as a stand-alone portlet annotation.
* </div>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({ANNOTATION_TYPE})
public @interface Dependency {
/**
+ * <div class='changed_added_3_0'>
* The resource name.
+ * </div>
*
* @return The resource name
*/
String name();
/**
+ * <div class='changed_added_3_0'>
* The scope name.
+ * </div>
*
* @return The name of the scope containing the resource
*/
String scope() default "";
/**
+ * <div class='changed_added_3_0'>
* The minimum acceptable module version.
+ * </div>
*
* @return The minimum acceptable module version
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/DestroyMethod.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/DestroyMethod.java b/portlet-api/src/main/java/javax/portlet/annotations/DestroyMethod.java
index 52256d9..ffeba0a 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/DestroyMethod.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/DestroyMethod.java
@@ -61,14 +61,17 @@ import static java.lang.annotation.RetentionPolicy.*;
* </div>
*
* @see javax.portlet.Portlet#destroy()
- *
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({METHOD})
public @interface DestroyMethod {
/**
+ * <div class='changed_added_3_0'>
* The portlet name for the annotated method.
+ * </div>
*
* @return The portlet name
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/EventDefinition.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/EventDefinition.java b/portlet-api/src/main/java/javax/portlet/annotations/EventDefinition.java
index 591c14a..188f267 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/EventDefinition.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/EventDefinition.java
@@ -38,11 +38,14 @@ import static java.lang.annotation.RetentionPolicy.*;
* represent a single event.
* It cannot be used as a stand-alone portlet annotation.
* </div>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({ANNOTATION_TYPE})
public @interface EventDefinition {
/**
+ * <div class='changed_added_3_0'>
* The event Qname.
* <p>
* The local part of the QName should be a non-empty String.
@@ -50,6 +53,7 @@ public @interface EventDefinition {
* event handling methods.
* <p>
* The event qname must be unique within the portlet application.
+ * </div>
*
* @see javax.portlet.Event
* @see javax.portlet.StateAwareResponse#setEvent(javax.xml.namespace.QName, java.io.Serializable)
@@ -62,11 +66,13 @@ public @interface EventDefinition {
PortletQName qname();
/**
+ * <div class='changed_added_3_0'>
* The event payload type associated with the specified QName.
* Each QName may have only a single event payload type associated with it.
* The payload type must be serializable and must have a valid JAXB binding.
* <p>
* The default value <code>void.class</code> indicates that the event has no payload.
+ * </div>
*
* @see javax.portlet.Event
* @see javax.portlet.StateAwareResponse#setEvent(javax.xml.namespace.QName, java.io.Serializable)
@@ -77,7 +83,7 @@ public @interface EventDefinition {
Class<?> payloadType() default void.class;
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* Provides locale-specific text describing the event for use by the portal application or by tools.
* </div>
*
@@ -86,7 +92,7 @@ public @interface EventDefinition {
LocaleString[] description() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The display-name type contains a locale-specific short name that is intended to be displayed by tools.
* It is used by display-name elements.
* The display name need not be unique.
@@ -97,7 +103,7 @@ public @interface EventDefinition {
LocaleString[] displayName() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The qualified name aliases for this event.
* </div>
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/EventMethod.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/EventMethod.java b/portlet-api/src/main/java/javax/portlet/annotations/EventMethod.java
index b735580..677ab09 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/EventMethod.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/EventMethod.java
@@ -49,21 +49,24 @@ import static java.lang.annotation.RetentionPolicy.*;
* </div>
*
* @see javax.portlet.EventPortlet#processEvent(javax.portlet.EventRequest, javax.portlet.EventResponse) processEvent
- *
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({METHOD})
public @interface EventMethod {
/**
+ * <div class='changed_added_3_0'>
* The portlet name for the annotated method.
+ * </div>
*
* @return The portlet name
*/
String portletName();
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The processing event QName definitions supported by this method.
* <p>
* At least one processing event QName must be specified.
@@ -77,7 +80,7 @@ public @interface EventMethod {
PortletQName[] processingEvents();
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The QName definitions of the events published by this method.
* </div>
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/HeaderMethod.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/HeaderMethod.java b/portlet-api/src/main/java/javax/portlet/annotations/HeaderMethod.java
index 3be5048..fe0ec3b 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/HeaderMethod.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/HeaderMethod.java
@@ -72,12 +72,15 @@ import java.lang.annotation.Target;
* @see javax.portlet.PortletResponse the add and set properties methods of PortletResponse
* @see javax.portlet.MimeResponse#MARKUP_HEAD_ELEMENT MimeResponse#MARKUP_HEAD_ELEMENT
* @see javax.portlet.HeaderPortlet
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({METHOD})
public @interface HeaderMethod {
/**
+ * <div class='changed_added_3_0'>
* The portlet names for which the header method applies.
* <p>
* The annotated method can apply to multiple portlets within the portlet
@@ -88,12 +91,14 @@ public @interface HeaderMethod {
* to indicate that the resource declarations are to apply to all portlets in
* the portlet application.
* If specified, the wildcard character must appear alone in the first array element.
+ * </div>
*
* @return The portlet names
*/
String[] portletNames();
/**
+ * <div class='changed_added_3_0'>
* The portlet mode rendered by the annotated method.
* <p>
* If an portlet mode is specified, the bean enabler will dispatch Header requests with
@@ -101,18 +106,21 @@ public @interface HeaderMethod {
* <p>
* If this field is empty, the method will be executed for all
* Header requests not dispatched by portlet mode to other HeaderMethods.
+ * </div>
*
* @return The portlet mode
*/
String portletMode() default "";
/**
+ * <div class='changed_added_3_0'>
* Sets the content type, or the MIME type, of content generated by the method.
* The content type will be set before the annotated method body is executed.
* <p>
* If this field is empty or set to the wildcard, no content type will be set.
* The portlet can then set the content type using the portlet API
* <code>HeaderResponse#setContentType</code> method.
+ * </div>
*
* @see javax.portlet.HeaderResponse#setContentType(String) HeaderResponse#setContentType
*
@@ -121,6 +129,7 @@ public @interface HeaderMethod {
String contentType() default "*/*";
/**
+ * <div class='changed_added_3_0'>
* Specifies a resource, such as a JSP, an HTML file, or a servlet to be included.
* <p>
* The resource will be included using the
@@ -128,6 +137,7 @@ public @interface HeaderMethod {
* has been executed.
* <p>
* If this field is empty, no resource will be included.
+ * </div>
*
* @see javax.portlet.PortletRequestDispatcher
* @see javax.portlet.PortletRequestDispatcher#include(javax.portlet.PortletRequest, javax.portlet.PortletResponse) PortletRequestDispatcher#include
@@ -137,12 +147,14 @@ public @interface HeaderMethod {
String include() default "";
/**
+ * <div class='changed_added_3_0'>
* The ordinal number for this annotated method.
* <p>
* The ordinal number determines the order of execution if multiple methods
* are annotated.
* Annotated methods with a lower ordinal number are executed before methods with
* a higher ordinal number.
+ * </div>
*
* @return The ordinal number
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/InitMethod.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/InitMethod.java b/portlet-api/src/main/java/javax/portlet/annotations/InitMethod.java
index 1684ebc..236ea81 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/InitMethod.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/InitMethod.java
@@ -59,14 +59,17 @@ import static java.lang.annotation.RetentionPolicy.*;
* </div>
*
* @see javax.portlet.Portlet#init(javax.portlet.PortletConfig)
- *
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({METHOD})
public @interface InitMethod {
/**
+ * <div class='changed_added_3_0'>
* The portlet name for the annotated method.
+ * </div>
*
* @return The portlet name
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/InitParameter.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/InitParameter.java b/portlet-api/src/main/java/javax/portlet/annotations/InitParameter.java
index 721a91e..3265e9e 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/InitParameter.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/InitParameter.java
@@ -38,26 +38,32 @@ import static java.lang.annotation.RetentionPolicy.*;
* represent name-value pairs.
* It cannot be used as a stand-alone portlet annotation.
* </div>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({ANNOTATION_TYPE})
public @interface InitParameter {
/**
+ * <div class='changed_added_3_0'>
* The parameter name.
+ * </div>
*
* @return The parameter name
*/
String name();
/**
+ * <div class='changed_added_3_0'>
* The parameter value
+ * </div>
*
* @return The parameter value
*/
String value();
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* Provides locale-specific text describing the initialization parameter for use by the portal application or by tools.
* </div>
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/LocaleString.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/LocaleString.java b/portlet-api/src/main/java/javax/portlet/annotations/LocaleString.java
index a23346c..78bca8c 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/LocaleString.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/LocaleString.java
@@ -38,12 +38,14 @@ import static java.lang.annotation.RetentionPolicy.*;
* represent information describing the portlet.
* It cannot be used as a stand-alone portlet annotation.
* </div>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({ANNOTATION_TYPE})
public @interface LocaleString {
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The locale for the locale-specific string.
* <p>
* The locale is specified as a language tag as defined in
@@ -59,7 +61,9 @@ public @interface LocaleString {
String locale() default "en";
/**
+ * <div class='changed_added_3_0'>
* The parameter value
+ * </div>
*
* @return The parameter value
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/Multipart.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/Multipart.java b/portlet-api/src/main/java/javax/portlet/annotations/Multipart.java
index 0f86dbe..c40b41d 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/Multipart.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/Multipart.java
@@ -43,41 +43,53 @@ import static java.lang.annotation.RetentionPolicy.*;
* </div>
*
* @see javax.servlet.annotation.MultipartConfig
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({ANNOTATION_TYPE})
public @interface Multipart {
/**
+ * <div class='changed_added_3_0'>
* Flag indicating if the portlet supports multipart forms.
* Must be set to <code>true</code> to activate multipart forms support.
+ * </div>
*
* @return <code>true</code> if multipart forms are supported; <code>false</code> otherwise.
*/
boolean supported();
/**
+ * <div class='changed_added_3_0'>
* The size threshold after which the file will be written to disk.
+ * </div>
*
* @return The file size threshold
*/
int fileSizeThreshold() default 0;
/**
+ * <div class='changed_added_3_0'>
* The directory location where files will be stored.
+ * </div>
*
* @return The directory location
*/
String location() default "";
/**
+ * <div class='changed_added_3_0'>
* The maximum size allowed for uploaded files.
+ * </div>
*
* @return The maximum size allowed for uploaded files
*/
long maxFileSize() default -1L;
/**
+ * <div class='changed_added_3_0'>
* The maximum size allowed for multipart/form-data requests.
+ * </div>
*
* @return The maximum size allowed for multipart/form-data requests
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/Namespace.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/Namespace.java b/portlet-api/src/main/java/javax/portlet/annotations/Namespace.java
index bbe6b2f..e4972f9 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/Namespace.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/Namespace.java
@@ -51,6 +51,8 @@ import static java.lang.annotation.RetentionPolicy.*;
* </div>
*
* @see javax.portlet.PortletResponse#getNamespace() getNamespace
+ *
+ * @since 3.0
*/
@Qualifier @Retention(RUNTIME) @Target({METHOD, FIELD, PARAMETER})
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletApplication.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletApplication.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletApplication.java
index 63cc7de..e9c47cb 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletApplication.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletApplication.java
@@ -42,26 +42,32 @@ import static java.lang.annotation.RetentionPolicy.*;
* Values of configuration parameters appearing in the deployment descriptor have
* precedence over the corresponding values defined in the annotation.
* </div>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({TYPE})
public @interface PortletApplication {
/**
+ * <div class='changed_added_3_0'>
* The portlet API version required by this portlet application.
+ * </div>
*
* @return The portlet API version
*/
String version() default "3.0";
/**
+ * <div class='changed_added_3_0'>
* The portlet container runtime options.
+ * </div>
*
* @return An array of portlet container runtime options
*/
RuntimeOption[] runtimeOptions() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The public render parameters used by the portlet.
* </div>
*
@@ -70,7 +76,7 @@ public @interface PortletApplication {
PublicRenderParameterDefinition[] publicParams() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The events defined for the portlet.
* This includes the processing events as well as the publishing events.
* <p>
@@ -89,7 +95,7 @@ public @interface PortletApplication {
EventDefinition[] events() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The resource bundle name for this portlet.
* Name of the resource bundle containing the language specific
* portlet information in different languages.
@@ -103,7 +109,7 @@ public @interface PortletApplication {
String resourceBundle() default "";
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The custom portlet modes defined for this portlet.
* </div>
*
@@ -112,7 +118,7 @@ public @interface PortletApplication {
CustomPortletMode[] customPortletModes() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The custom window states defined for this portlet.
* </div>
*
@@ -121,7 +127,7 @@ public @interface PortletApplication {
CustomWindowState[] customWindowStates() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The default QName namespace URI.
* <p>
* The default namespace URI is used when no namespace URI is specified
@@ -133,7 +139,7 @@ public @interface PortletApplication {
String defaultNamespaceURI() default "";
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The user aattribute declarations.
* </div>
*
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletConfiguration.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletConfiguration.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletConfiguration.java
index ca94586..55df55e 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletConfiguration.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletConfiguration.java
@@ -42,33 +42,41 @@ import static java.lang.annotation.RetentionPolicy.*;
* Values of configuration parameters appearing in the deployment descriptor have
* precedence over the corresponding values defined in the annotation.
* </div>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({TYPE})
public @interface PortletConfiguration {
/**
+ * <div class='changed_added_3_0'>
* The portlet name for the annotated type.
+ * </div>
*
* @return The portlet name
*/
String portletName();
/**
+ * <div class='changed_added_3_0'>
* The portlet initialization parameters.
+ * </div>
*
* @return An array of initialization parameters
*/
InitParameter[] initParams() default {};
/**
+ * <div class='changed_added_3_0'>
* The portlet container runtime options.
+ * </div>
*
* @return An array of portlet runtime options
*/
RuntimeOption[] runtimeOptions() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The locales supported by the portlet.
* An array of String values, each of which represents a single locale.
* <p>
@@ -85,7 +93,7 @@ public @interface PortletConfiguration {
String[] supportedLocales() default {"en"};
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* Locale specific static title for this portlet.
* </div>
*
@@ -94,7 +102,7 @@ public @interface PortletConfiguration {
LocaleString[] title() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* Locale specific short version of the static title.
* </div>
*
@@ -103,7 +111,7 @@ public @interface PortletConfiguration {
LocaleString[] shortTitle() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The display-name type contains a locale-specific short name that is intended to be displayed by tools.
* It is used by display-name elements.
* The display name need not be unique.
@@ -114,7 +122,7 @@ public @interface PortletConfiguration {
LocaleString[] displayName() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The portlet description.
* It provides locale-specific text describing the portlet for use by the portal application or by tools.
* </div>
@@ -124,7 +132,7 @@ public @interface PortletConfiguration {
LocaleString[] description() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* Locale specific keywords associated with this portlet.
* The keywords are separated by commas within the value of the
* <code>LocaleString</code> array element.
@@ -135,7 +143,7 @@ public @interface PortletConfiguration {
LocaleString[] keywords() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The portlet preferences.
* </div>
*
@@ -144,7 +152,7 @@ public @interface PortletConfiguration {
Preference[] prefs() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The public render parameter identifiers used by the portlet.
* </div>
*
@@ -153,7 +161,7 @@ public @interface PortletConfiguration {
String[] publicParams() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The resource bundle name for this portlet.
* Name of the resource bundle containing the language specific
* portlet information in different languages.
@@ -167,7 +175,7 @@ public @interface PortletConfiguration {
String resourceBundle() default "";
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The supported portlet modes and window states for a given <code>MIME</code> type.
* </div>
*
@@ -176,7 +184,7 @@ public @interface PortletConfiguration {
Supports[] supports() default {@Supports(mimeType="text/html")};
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* The cache scope, which defines whether generated portlet content is private
* for the user or can be shared across different users.
* <p>
@@ -193,7 +201,7 @@ public @interface PortletConfiguration {
boolean cacheScopePublic() default false;
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* Expiration-time defines the time in seconds after which the portlet output expires.
* A value of -1 indicates that the output never expires.
* <p>
@@ -205,7 +213,7 @@ public @interface PortletConfiguration {
int cacheExpirationTime() default 0;
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The dependencies the portlet may have on external resources.
* The resources can represent client-side prerequisites such as JavaScript libraries
* or stylesheet resources that are shared among portlets.
@@ -216,7 +224,7 @@ public @interface PortletConfiguration {
Dependency[] dependencies() default {};
/**
- * <div class='container-change'>
+ * <div class='container-change changed_added_3_0'>
* The security role references.
* </div>
*
@@ -225,21 +233,25 @@ public @interface PortletConfiguration {
SecurityRoleRef[] roleRefs() default {};
/**
+ * <div class='changed_added_3_0'>
* Declares whether the portlet supports asynchronous operation mode.
* <p>
* If this flag is set, any resource method used by this portlet will
* be marked as supporting asynchronous operation.
* Asynchronous support applies to resource methods only.
- *
+ * </div>
+ *
* @return <code>true</code> if the method supports asynchronous mode.
*/
boolean asyncSupported() default false;
/**
+ * <div class='changed_added_3_0'>
* Provides multipart configuration data for the portlet.
* <p>
* The <code>{@literal @}Multipart</code> annotation <code>supported</code>
* element must be set to <code>true</code> to activate multipart form support.
+ * </div>
*
* @return The multipart configuration data.
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletConfigurations.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletConfigurations.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletConfigurations.java
index 9aa1f62..ebd71d2 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletConfigurations.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletConfigurations.java
@@ -37,13 +37,17 @@ import static java.lang.annotation.RetentionPolicy.*;
* Annotation for configuration of multiple portlets.
* @see PortletConfiguration
* </div>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({TYPE})
public @interface PortletConfigurations {
/**
+ * <div class='changed_added_3_0'>
* The portlet configurations. Each array entry contains the configuration
* for a single portlet.
+ * </div>
*
* @return An array of portlet configurations
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletLifecycleFilter.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletLifecycleFilter.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletLifecycleFilter.java
index 7019ee6..d4efb1f 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletLifecycleFilter.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletLifecycleFilter.java
@@ -62,7 +62,8 @@ import static java.lang.annotation.RetentionPolicy.*;
* @see javax.portlet.filter.EventFilter
* @see javax.portlet.filter.RenderFilter
* @see javax.portlet.filter.ResourceFilter
- *
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({TYPE})
@@ -82,7 +83,7 @@ public @interface PortletLifecycleFilter {
String filterName() default "";
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* The portlet names for which the request filter applies.
* <p>
* The annotated request filter can apply to multiple portlets within the portlet
@@ -99,7 +100,7 @@ public @interface PortletLifecycleFilter {
String[] portletNames() default "*";
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* The filter initialization parameters.
* </div>
*
@@ -108,7 +109,7 @@ public @interface PortletLifecycleFilter {
InitParameter[] initParams() default {};
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* The display-name type contains a language-specific short name that is intended to be displayed by tools.
* </div>
*
@@ -117,7 +118,7 @@ public @interface PortletLifecycleFilter {
LocaleString[] displayName() default {};
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* The portlet filter description
* providing locale-specific text describing the portlet filter for use by the portal application or by tools.
* </div>
@@ -127,7 +128,7 @@ public @interface PortletLifecycleFilter {
LocaleString[] description() default {};
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* The ordinal number for this annotated method.
* <p>
* The ordinal number determines the order of execution if multiple methods
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletListener.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletListener.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletListener.java
index 77ead30..23d1f7e 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletListener.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletListener.java
@@ -41,39 +41,43 @@ import static java.lang.annotation.RetentionPolicy.*;
* </div>
*
* @see javax.portlet.PortletURLGenerationListener
- *
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({TYPE})
public @interface PortletListener {
/**
+ * <div class='changed_added_3_0'>
* The listener name.
* <p>
* The listener name is not required. If a listener name is provided, the listener configuration
* may be addressed through the listener name in the portlet deployment descriptor to modify
* or remove the listener.
* <p>
- *
+ * </div>
*
* @return The listener name
*/
String listenerName() default "";
/**
+ * <div class='changed_added_3_0'>
* The ordinal number for this annotated method.
* <p>
* The ordinal number determines the order of execution if multiple methods
* are annotated for a given URL type.
* Annotated methods with a lower ordinal number are executed before methods with
* a higher ordinal number.
+ * </div>
*
* @return The ordinal number
*/
int ordinal() default 0;
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* The display-name type contains a language-specific short name that is intended to be displayed by tools.
* </div>
*
@@ -82,7 +86,7 @@ public @interface PortletListener {
LocaleString[] displayName() default {};
/**
- * <div class='not-supported'>
+ * <div class='not-supported changed_added_3_0'>
* The portlet listener description
* providing locale-specific text describing the portlet listener for use by the portal application or by tools.
* </div>
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletName.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletName.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletName.java
index 15e50cd..97f9df1 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletName.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletName.java
@@ -51,6 +51,8 @@ import static java.lang.annotation.RetentionPolicy.*;
* </div>
*
* @see javax.portlet.PortletResponse#getNamespace() getNamespace
+ *
+ * @since 3.0
*/
@Qualifier @Retention(RUNTIME) @Target({METHOD, FIELD, PARAMETER})
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletPreferencesValidator.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletPreferencesValidator.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletPreferencesValidator.java
index ea02a36..ed4a3a2 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletPreferencesValidator.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletPreferencesValidator.java
@@ -43,13 +43,15 @@ import static java.lang.annotation.RetentionPolicy.*;
* </div>
*
* @see javax.portlet.PreferencesValidator
- *
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({TYPE})
public @interface PortletPreferencesValidator {
/**
+ * <div class='changed_added_3_0'>
* The portlet names for which the validator applies.
* <p>
* The annotated validator method can apply to multiple portlets within the portlet
@@ -59,6 +61,7 @@ public @interface PortletPreferencesValidator {
* A wildcard character '*' can be specified in the first portletName array element
* to indicate that the validator is to apply to all portlets in the portlet application.
* If specified, the wildcard character must appear alone in the first array element.
+ * </div>
*
* @return The portlet names
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletQName.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletQName.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletQName.java
index 3c5fccd..31019d9 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletQName.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletQName.java
@@ -52,11 +52,14 @@ import static java.lang.annotation.RetentionPolicy.*;
*
* @see javax.xml.namespace.QName javax.xml.namespace.QName
* @see <a href="http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/#QName">W3C Qname definition</a>
+ *
+ * @since 3.0
*/
@Retention(RUNTIME) @Target({ANNOTATION_TYPE})
public @interface PortletQName {
/**
+ * <div class='changed_added_3_0'>
* The QName namespace URI.
* <p>
* If the QName namespace URI is empty, the default value is used.
@@ -74,6 +77,7 @@ public @interface PortletQName {
* The value javax.xml.XMLConstants.NULL_NS_URI
* </li>
* </ul>
+ * </div>
*
* @return The QName namespace URI.
*
@@ -82,9 +86,11 @@ public @interface PortletQName {
String namespaceURI();
/**
+ * <div class='changed_added_3_0'>
* The local part.
* <p>
* local-part should be a non-empty String.
+ * </div>
*
* @return The qname local part.
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletRequestScoped.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletRequestScoped.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletRequestScoped.java
index 17ebf66..d6e45f6 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletRequestScoped.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletRequestScoped.java
@@ -41,7 +41,8 @@ import javax.enterprise.context.NormalScope;
* <div class='changed_added_3_0'>
* Provides a CDI custom scope for the portlet request.
* </div>
- *
+ *
+ * @since 3.0
*/
@Retention(RUNTIME)
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletSerializable.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletSerializable.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletSerializable.java
index 0eef0f1..9cbef97 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletSerializable.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletSerializable.java
@@ -43,10 +43,13 @@ package javax.portlet.annotations;
* </div>
*
* @see RenderStateScoped
+ *
+ * @since 3.0
*/
public interface PortletSerializable {
/**
+ * <div class='changed_added_3_0'>
* The portlet bean container calls this method after {@link ActionMethod}
* or {@link EventMethod} execution to obtain the bean state.
* <p>
@@ -57,12 +60,14 @@ public interface PortletSerializable {
* <p>
* If no bean data has been set, this method should return an empty array or
* <code>null</code> in order to avoid setting extraneous parameters.
+ * </div>
*
* @return The bean state as a string array.
*/
public String[] serialize();
/**
+ * <div class='changed_added_3_0'>
* The bean portlet container calls this method at the beginning of every portlet
* request method that uses the bean.
* <p>
@@ -76,7 +81,8 @@ public interface PortletSerializable {
* <p>
* If the state array is empty, the bean implementation should provide approriate
* default values for its internal variables.
- *
+ * </div>
+ *
* @param state The bean state as string array.
* The array will be empty if bean data has not yet been set.
*/
http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/f75cca78/portlet-api/src/main/java/javax/portlet/annotations/PortletSessionScoped.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/PortletSessionScoped.java b/portlet-api/src/main/java/javax/portlet/annotations/PortletSessionScoped.java
index d35f5b1..88ff262 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/PortletSessionScoped.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/PortletSessionScoped.java
@@ -44,7 +44,8 @@ import static java.lang.annotation.RetentionPolicy.*;
* Note that a portlet session scoped bean must implement
* <code>java.io.Serializable</code>, since it will be stored in the portlet session.
* </div>
- *
+ *
+ * @since 3.0
*/
@Retention(RUNTIME)
@@ -55,6 +56,7 @@ import static java.lang.annotation.RetentionPolicy.*;
public @interface PortletSessionScoped {
/**
+ * <div class='changed_added_3_0'>
* The portlet scope into which the annotated bean is to be placed. Can be set to
* the following values:
* <ul>
@@ -66,6 +68,7 @@ public @interface PortletSessionScoped {
* The effect of this scope is the same as using the CDI @SessionScoped annotation.
* </li>
* </ul>
+ * </div>
*
* @return The portlet scope
*