portals-pluto-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From msnickl...@apache.org
Subject [09/50] [abbrv] portals-pluto git commit: Corrections in javadoc and license text
Date Thu, 14 Apr 2016 12:28:49 GMT
Corrections in javadoc and license text


Project: http://git-wip-us.apache.org/repos/asf/portals-pluto/repo
Commit: http://git-wip-us.apache.org/repos/asf/portals-pluto/commit/724f7ac9
Tree: http://git-wip-us.apache.org/repos/asf/portals-pluto/tree/724f7ac9
Diff: http://git-wip-us.apache.org/repos/asf/portals-pluto/diff/724f7ac9

Branch: refs/heads/master
Commit: 724f7ac952838750507d0daf33eeef1c0d0c974f
Parents: 0e13b58
Author: Scott Nicklous <msnicklous@apache.org>
Authored: Fri Feb 26 08:37:15 2016 +0100
Committer: Scott Nicklous <msnicklous@apache.org>
Committed: Fri Feb 26 08:37:15 2016 +0100

----------------------------------------------------------------------
 .../java/javax/portlet/MutablePortletState.java | 109 ++++++++++++-------
 .../main/java/javax/portlet/PortletState.java   |  24 ++++
 .../javax/portlet/annotations/HeaderMethod.java |  19 +++-
 .../javax/portlet/annotations/RenderMethod.java |   2 -
 4 files changed, 107 insertions(+), 47 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/724f7ac9/portlet-api/src/main/java/javax/portlet/MutablePortletState.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/MutablePortletState.java b/portlet-api/src/main/java/javax/portlet/MutablePortletState.java
index c7ecf24..e5d1d04 100644
--- a/portlet-api/src/main/java/javax/portlet/MutablePortletState.java
+++ b/portlet-api/src/main/java/javax/portlet/MutablePortletState.java
@@ -1,3 +1,27 @@
+/*  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+/*
+ * This source code implements specifications defined by the Java
+ * Community Process. In order to remain compliant with the specification
+ * DO NOT add / change / or delete method signatures!
+ */
+
 package javax.portlet;
 
 
@@ -51,47 +75,6 @@ public interface MutablePortletState extends PortletState, Mutable {
 
    /**
     * <div class="changed_added_3_0">
-    * Sets the window state of a portlet to the given window state.
-    * <p>
-    * Possible values are the standard window states and any custom window
-    * states supported by the portal and the portlet. Standard window states
-    * are:
-    * <ul>
-    * <li>MINIMIZED
-    * <li>NORMAL
-    * <li>MAXIMIZED
-    * </ul>
-    * <p>
-    * Not more than one window state can be set.
-    * If more than one window state is set, only the last one set
-    * is valid.
-    * </div>
-    * 
-    * @param windowState
-    *            the new portlet window state
-    * 
-    * @exception WindowStateException
-    *                   if the portlet cannot switch to this state,
-    *                   because the portal does not support this state, the portlet has not

-    *                   declared in its deployment descriptor that it supports this state,
or the current
-    *                   user is not allowed to switch to this state.
-    *                   The <code>PortletRequest.isWindowStateAllowed()</code>
method can be used
-    *                   to check if the portlet can set a given window state.
-    * @exception java.lang.IllegalStateException
-    *                if the method is invoked after <code>sendRedirect</code>
-    *                has been called.
-    * @exception java.lang.IllegalArgumentException
-    *                if the input parameter is <code>null</code>.
-    * 
-    * @since 3.0
-    * 
-    */
-
-   public void setWindowState(WindowState windowState)
-         throws WindowStateException;
-
-   /**
-    * <div class="changed_added_3_0">
     * Sets the portlet mode of a portlet to the given portlet mode.
     * <p>
     * Possible values are the standard portlet modes and any custom portlet
@@ -130,8 +113,50 @@ public interface MutablePortletState extends PortletState, Mutable {
     *                
     * @since 3.0
     */
-
+   
    public void setPortletMode(PortletMode portletMode)
          throws PortletModeException;
 
+
+   /**
+    * <div class="changed_added_3_0">
+    * Sets the window state of a portlet to the given window state.
+    * <p>
+    * Possible values are the standard window states and any custom window
+    * states supported by the portal and the portlet. Standard window states
+    * are:
+    * <ul>
+    * <li>MINIMIZED
+    * <li>NORMAL
+    * <li>MAXIMIZED
+    * </ul>
+    * <p>
+    * Not more than one window state can be set.
+    * If more than one window state is set, only the last one set
+    * is valid.
+    * </div>
+    * 
+    * @param windowState
+    *            the new portlet window state
+    * 
+    * @exception WindowStateException
+    *                   if the portlet cannot switch to this state,
+    *                   because the portal does not support this state, the portlet has not

+    *                   declared in its deployment descriptor that it supports this state,
or the current
+    *                   user is not allowed to switch to this state.
+    *                   The <code>PortletRequest.isWindowStateAllowed()</code>
method can be used
+    *                   to check if the portlet can set a given window state.
+    * @exception java.lang.IllegalStateException
+    *                if the method is invoked after <code>sendRedirect</code>
+    *                has been called.
+    * @exception java.lang.IllegalArgumentException
+    *                if the input parameter is <code>null</code>.
+    * 
+    * @since 3.0
+    * 
+    */
+
+   public void setWindowState(WindowState windowState)
+         throws WindowStateException;
+
 }
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/724f7ac9/portlet-api/src/main/java/javax/portlet/PortletState.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/PortletState.java b/portlet-api/src/main/java/javax/portlet/PortletState.java
index 9e04522..f1f5aa4 100644
--- a/portlet-api/src/main/java/javax/portlet/PortletState.java
+++ b/portlet-api/src/main/java/javax/portlet/PortletState.java
@@ -1,3 +1,27 @@
+/*  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+/*
+ * This source code implements specifications defined by the Java
+ * Community Process. In order to remain compliant with the specification
+ * DO NOT add / change / or delete method signatures!
+ */
+
 package javax.portlet;
 
 /**

http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/724f7ac9/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 42935b1..a9dce7e 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/HeaderMethod.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/HeaderMethod.java
@@ -36,10 +36,23 @@ import java.lang.annotation.Target;
  * <div class='changed_added_3_0'>
  * Designates a method corresponding to the renderHeaders method of 
  * the <code>HeaderPortlet</code> interface.
- * The annotated method must have the following signature:
+ * The annotated method must have one of the following signatures:
+ * <ul>
+ * <li>
+ * <code>public void &lt;methodName&gt;(HeaderRequest, HeaderResponse)</code>
  * <p>
- *    <code>public void &lt;methodName&gt;(HeaderRequest, HeaderResponse)</code>
- * <p>   
+ * This corresponds to the <code>renderHeaders</code> method.
+ * </li>   
+ * <li>
+ * <code>public String &lt;methodName&gt;()</code>
+ * <p>
+ * The String returned by the method will be made available to the portal for
+ * inclusion in the document head section. 
+ * </li>   
+ * <li>
+ * <code>public void &lt;methodName&gt;()</code>
+ * </li>   
+ * </ul> 
  * where the method name can be freely selected.
  * <p>
  * The method declaration may contain a throws clause. Exceptions declared in the 

http://git-wip-us.apache.org/repos/asf/portals-pluto/blob/724f7ac9/portlet-api/src/main/java/javax/portlet/annotations/RenderMethod.java
----------------------------------------------------------------------
diff --git a/portlet-api/src/main/java/javax/portlet/annotations/RenderMethod.java b/portlet-api/src/main/java/javax/portlet/annotations/RenderMethod.java
index 7ccc463..a4bb1c4 100644
--- a/portlet-api/src/main/java/javax/portlet/annotations/RenderMethod.java
+++ b/portlet-api/src/main/java/javax/portlet/annotations/RenderMethod.java
@@ -35,8 +35,6 @@ import java.lang.annotation.Target;
  * <div class='changed_added_3_0'>
  * Designates a method corresponding to the portlet API render method.
  * The annotated method must have one of the following signatures:
- * <p>
- * The annotated method must have one of the following signatures:
  * <ul>
  * <li>
  * <code>public void &lt;methodName&gt;(RenderRequest, RenderResponse)</code>


Mime
View raw message