From portal-commits at lists.jboss.org Mon Apr 28 07:31:17 2008
Content-Type: multipart/mixed; boundary="===============7575485767995151189=="
MIME-Version: 1.0
From: portal-commits at lists.jboss.org
To: portal-commits at lists.jboss.org
Subject: [portal-commits] JBoss Portal SVN: r10727 -
 modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/tree.
Date: Mon, 28 Apr 2008 07:31:17 -0400
Message-ID: <E1JqRZl-0003sY-4B@committer01.frg.pub.inap.atl.jboss.com>

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

Author: julien(a)jboss.com
Date: 2008-04-28 07:31:16 -0400 (Mon, 28 Apr 2008)
New Revision: 10727

Modified:
   modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/p=
resentation/model/tree/UINode.java
Log:
added a bit of javadoc

Modified: modules/presentation/trunk/presentation/src/main/java/org/jboss/p=
ortal/presentation/model/tree/UINode.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
--- modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/=
presentation/model/tree/UINode.java	2008-04-28 11:29:14 UTC (rev 10726)
+++ modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/=
presentation/model/tree/UINode.java	2008-04-28 11:31:16 UTC (rev 10727)
@@ -27,16 +27,33 @@
 import java.util.Collection;
 =

 /**
+ * The node interface provides a pull style api for interacting with the s=
tructural context.
+ *
  * @author <a href=3D"mailto:julien(a)jboss-portal.org">Julien Viet</a>
  * @version $Revision: 630 $
  */
 public interface UINode
 {
 =

+   /**
+    * Returns the related ui object.
+    *
+    * @return the ui object
+    */
    UIObject getObject();
 =

+   /**
+    * Returns the parent node or null if it does not exist.
+    *
+    * @return the parent node
+    */
    UINode getParent();
-   =

+
+   /**
+    * Returns a collection of children nodes.
+    *
+    * @return the children
+    */
    Collection<UINode> getChildren();
 =

 }


--===============7575485767995151189==--