10:20 p.m.
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/PortalNodeEventContext.java
trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListener.java
Log:
updated a bit the portal api javadoc
Modified: trunk/api/src/main/org/jboss/portal/api/event/PortalEvent.java
===================================================================
--- 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="mailto:julien@jboss.org">Julien Viet</a>
* @version $Revision$
Modified: trunk/api/src/main/org/jboss/portal/api/node/PortalNode.java
===================================================================
--- 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="mailto:julien@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
===================================================================
--- 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="mailto:julien@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 IllegalArgumentException;
/**
+ * 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 IllegalArgumentException;
/**
- *
+ * Affect the authentication mode of the transport protocol that the URL will
designate.
+ * A null value indicates that it should reuse the value of the incoming 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 incoming transport.
*/
void setSecure(Boolean wantSecure);
/**
- *
+ * Affet the URL generation by creating either a relative or an absolute URL.
*/
void setRelative(boolean relative);
Modified: trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEvent.java
===================================================================
--- 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="mailto:julien@jboss.org">Julien Viet</a> */
+/**
+ * Base class for all portal node events.
+ *
+ * @author <a href="mailto:julien@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 == null)
{
@@ -40,6 +48,11 @@
this.node = 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/PortalNodeEventContext.java
===================================================================
---
trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.java 2007-01-25
21:09:21 UTC (rev 6099)
+++
trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventContext.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="mailto:julien@jboss.org">Julien Viet</a>
* @version $Revision$
*/
Modified: trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListener.java
===================================================================
---
trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListener.java 2007-01-25
21:09:21 UTC (rev 6099)
+++
trunk/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListener.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="mailto:julien@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 or null to keep
the same event
*/
PortalNodeEvent onEvent(PortalNodeEventContext context, PortalNodeEvent event);
}