You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by ma...@apache.org on 2009/11/30 15:23:55 UTC
svn commit: r885431 - in
/myfaces/core/trunk/api/src/main/java/javax/faces/component/visit:
VisitCallback.java VisitHint.java VisitResult.java
Author: matzew
Date: Mon Nov 30 14:23:54 2009
New Revision: 885431
URL: http://svn.apache.org/viewvc?rev=885431&view=rev
Log:
ported some JavaDoc over from Trinidad's API on Tree Visiting ...
Modified:
myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitCallback.java
myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitHint.java
myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitResult.java
Modified: myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitCallback.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitCallback.java?rev=885431&r1=885430&r2=885431&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitCallback.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitCallback.java Mon Nov 30 14:23:54 2009
@@ -21,6 +21,9 @@
import javax.faces.component.UIComponent;
/**
+ * <p>A simple callback interface that enables
+ * taking action on a specific UIComponent (either facet or child) during
+ * a component tree visit.</p>
* @author Simon Lessard (latest modification by $Author: slessard $)
* @version $Revision: 696523 $ $Date: 2009-03-14 16:45:40 -0400 (mer., 17 sept. 2008) $
*
@@ -28,5 +31,21 @@
*/
public interface VisitCallback
{
+ /**
+ * <p>This method is called during component tree visits by
+ * {@link VisitContext#invokeVisitCallback VisitContext.invokeVisitCallback()}
+ * to visit the specified component. At the point in time when this
+ * method is called, the argument {@code target} is guaranteed
+ * to be in the proper state with respect to its ancestors in the
+ * View.</p>
+ *
+ * @param context the {@link VisitContext} for this tree visit.
+ *
+ * @param target the {@link UIComponent} to visit
+ *
+ * @return a {@link VisitResult} that indicates whether to continue
+ * visiting the component's subtree, skip visiting the component's
+ * subtree or end the visit.
+ */
public VisitResult visit(VisitContext context, UIComponent target);
-}
+}
\ No newline at end of file
Modified: myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitHint.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitHint.java?rev=885431&r1=885430&r2=885431&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitHint.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitHint.java Mon Nov 30 14:23:54 2009
@@ -19,6 +19,11 @@
package javax.faces.component.visit;
/**
+ *
+ * <p>An enum that specifies hints that impact
+ * the behavior of a component tree visit.</p>
+ *
+ * @see VisitContext#getHints VisitContext.getHints()
* @author Simon Lessard (latest modification by $Author: slessard $)
* @version $Revision: 696523 $ $Date: 2009-03-14 16:46:33 -0400 (mer., 17 sept. 2008) $
*
@@ -26,7 +31,20 @@
*/
public enum VisitHint
{
- EXECUTE_LIFECYCLE,
+ /**
+ * Hint that indicates that only the rendered subtree should be visited.
+ */
+ SKIP_UNRENDERED,
+
+ /**
+ * Hint that indicates that only non-transient subtrees should be visited.
+ */
SKIP_TRANSIENT,
- SKIP_UNRENDERED;
-}
+
+ /**
+ * Hint that indicates that the visit is being performed as part of
+ * lifecycle phase execution and as such phase-specific actions
+ * (initialization) may be taken.
+ */
+ EXECUTE_LIFECYCLE
+}
\ No newline at end of file
Modified: myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitResult.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitResult.java?rev=885431&r1=885430&r2=885431&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitResult.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/component/visit/VisitResult.java Mon Nov 30 14:23:54 2009
@@ -19,6 +19,13 @@
package javax.faces.component.visit;
/**
+ *
+ * <p>An enum that specifies the possible
+ * results of a call to {@link VisitCallback#visit VisitCallback.visit()}.
+ * </p>
+ *
+ * @see VisitCallback#visit VisitCallback.visit()
+ *
* @author Simon Lessard (latest modification by $Author: slessard $)
* @version $Revision: 696523 $ $Date: 2009-03-14 16:46:04 -0400 (mer., 17 sept. 2008) $
*
@@ -26,7 +33,20 @@
*/
public enum VisitResult
{
+ /**
+ * This result indicates that the tree visit should descend into
+ * current component's subtree.
+ */
ACCEPT,
- COMPLETE,
- REJECT;
-}
+
+ /**
+ * This result indicates that the tree visit should continue, but
+ * should skip the current component's subtree.
+ */
+ REJECT,
+
+ /**
+ * This result indicates that the tree visit should be terminated.
+ */
+ COMPLETE
+}
\ No newline at end of file