From portal-commits at lists.jboss.org Thu Jan 25 16:20:39 2007
Content-Type: multipart/mixed; boundary="===============1169112739597322494=="
MIME-Version: 1.0
From: portal-commits at lists.jboss.org
To: portal-commits at lists.jboss.org
Subject: [portal-commits] JBoss Portal SVN: r6100 - in
 trunk/api/src/main/org/jboss/portal/api: node and 1 other directories.
Date: Thu, 25 Jan 2007 16:20:38 -0500
Message-ID: <E1HAC1O-0004Ij-VQ@committer01.frg.pub.inap.atl.jboss.com>

--===============1169112739597322494==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: julien(a)jboss.com
Date: 2007-01-25 16:20:38 -0500 (Thu, 25 Jan 2007)
New Revision: 6100

Modified:
   trunk/api/src/main/org/jboss/portal/api/event/PortalEvent.java
   trunk/api/src/main/org/jboss/portal/api/node/PortalNode.java
   trunk/api/src/main/org/jboss/portal/api/node/PortalNodeURL.java
   trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEvent.java
   trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContex=
t.java
   trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListen=
er.java
Log:
updated a bit the portal api javadoc

Modified: trunk/api/src/main/org/jboss/portal/api/event/PortalEvent.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/api/src/main/org/jboss/portal/api/event/PortalEvent.java	2007-01-=
25 21:09:21 UTC (rev 6099)
+++ trunk/api/src/main/org/jboss/portal/api/event/PortalEvent.java	2007-01-=
25 21:20:38 UTC (rev 6100)
@@ -23,7 +23,7 @@
 package org.jboss.portal.api.event;
 =

 /**
- * Base event class for all portal events.
+ * Base event class for portal events.
  *
  * @author <a href=3D"mailto:julien(a)jboss.org">Julien Viet</a>
  * @version $Revision$

Modified: trunk/api/src/main/org/jboss/portal/api/node/PortalNode.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/api/src/main/org/jboss/portal/api/node/PortalNode.java	2007-01-25=
 21:09:21 UTC (rev 6099)
+++ trunk/api/src/main/org/jboss/portal/api/node/PortalNode.java	2007-01-25=
 21:20:38 UTC (rev 6100)
@@ -26,6 +26,8 @@
 import java.util.Map;
 =

 /**
+ * Represents a portal node, a first class entity for the portal.
+ *
  * @author <a href=3D"mailto:julien(a)jboss.org">Julien Viet</a>
  * @version $Revision$
  */
@@ -52,13 +54,6 @@
    int getType();
 =

    /**
-    * The node id which identifies the node in the context of its root.
-    *
-    * @return the node id
-    */
-//   String getId();
-
-   /**
     * Return the root node of this node.
     *
     * @return the root node

Modified: trunk/api/src/main/org/jboss/portal/api/node/PortalNodeURL.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/api/src/main/org/jboss/portal/api/node/PortalNodeURL.java	2007-01=
-25 21:09:21 UTC (rev 6099)
+++ trunk/api/src/main/org/jboss/portal/api/node/PortalNodeURL.java	2007-01=
-25 21:20:38 UTC (rev 6100)
@@ -23,33 +23,45 @@
 package org.jboss.portal.api.node;
 =

 /**
+ * An URL which can target a portal node.
+ *
  * @author <a href=3D"mailto:julien(a)jboss.org">Julien Viet</a>
  * @version $Revision$
  */
 public interface PortalNodeURL
 {
    /**
+    * Set a parameter on the URL.
     *
+    * @param name the parameter name
+    * @param value the parameter value
+    * @throws IllegalArgumentException if the name is null
     */
-   void setParameter(String name, String value);
+   void setParameter(String name, String value) throws IllegalArgumentExce=
ption;
 =

    /**
+    * Set a parameter on the URL.
     *
+    * @param name the parameter name
+    * @param values the parameter values
+    * @throws IllegalArgumentException if the name is null
     */
-   void setParameter(String name, String[] values);
+   void setParameter(String name, String[] values) throws IllegalArgumentE=
xception;
 =

    /**
-    *
+    * Affect the authentication mode of the transport protocol that the UR=
L will designate.
+    * A null value indicates that it should reuse the value of the incomin=
g transport.
     */
    void setAuthenticated(Boolean wantAuthenticated);
 =

    /**
-    *
+    * Affect the security mode of the transport protocol that the URL will=
 designate.
+    * A null value indicates that it should reuse the value of the incomin=
g transport.
     */
    void setSecure(Boolean wantSecure);
 =

    /**
-    *
+    * Affet the URL generation by creating either a relative or an absolut=
e URL.
     */
    void setRelative(boolean relative);
 =


Modified: trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEven=
t.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEvent.java=
	2007-01-25 21:09:21 UTC (rev 6099)
+++ trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEvent.java=
	2007-01-25 21:20:38 UTC (rev 6100)
@@ -24,14 +24,22 @@
 =

 import org.jboss.portal.api.node.PortalNode;
 =

-/** @author <a href=3D"mailto:julien(a)jboss.org">Julien Viet</a> */
+/**
+ * Base class for all portal node events.
+ *
+ * @author <a href=3D"mailto:julien(a)jboss.org">Julien Viet</a>
+ */
 public abstract class PortalNodeEvent
 {
 =

-   /** The portal node. */
+   /** The portal node targetted by this event. */
    protected final PortalNode node;
 =

-   public PortalNodeEvent(PortalNode node)
+   /**
+    * @param node the node the event targets
+    * @throws IllegalArgumentException if the node argument is null
+    */
+   public PortalNodeEvent(PortalNode node) throws IllegalArgumentException
    {
       if (node =3D=3D null)
       {
@@ -40,6 +48,11 @@
       this.node =3D node;
    }
 =

+   /**
+    * Returns the portal node targetted by the event.
+    *
+    * @return the portal node
+    */
    public PortalNode getNode()
    {
       return node;

Modified: trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEven=
tContext.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventConte=
xt.java	2007-01-25 21:09:21 UTC (rev 6099)
+++ trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventConte=
xt.java	2007-01-25 21:20:38 UTC (rev 6100)
@@ -26,6 +26,8 @@
 import org.jboss.portal.spi.NavigationalStateContext;
 =

 /**
+ * The context in which a <code>PortalNodeEvent</code> is dispatched.
+ * =

  * @author <a href=3D"mailto:julien(a)jboss.org">Julien Viet</a>
  * @version $Revision$
  */

Modified: trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEven=
tListener.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListe=
ner.java	2007-01-25 21:09:21 UTC (rev 6099)
+++ trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListe=
ner.java	2007-01-25 21:20:38 UTC (rev 6100)
@@ -23,6 +23,8 @@
 package org.jboss.portal.api.node.event;
 =

 /**
+ * A listener for portal events
+ *
  * @author <a href=3D"mailto:julien(a)jboss.org">Julien Viet</a>
  * @version $Revision$
  */
@@ -31,9 +33,9 @@
    /**
     * Dispatch an event to the listener.
     *
-    * @param context the bubbler to perform the event bubbling control
-    * @param event   the fired event
-    * @return the next event or null to keep the same event
+    * @param context the context in which the event is triggered
+    * @param event the fired event
+    * @return an possible new events that will replace the current event o=
r null to keep the same event
     */
    PortalNodeEvent onEvent(PortalNodeEventContext context, PortalNodeEvent=
 event);
 }


--===============1169112739597322494==--