1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package javax.faces.component.visit;
20
21 import javax.faces.component.UIComponent;
22
23 /**
24 * <p>A simple callback interface that enables
25 * taking action on a specific UIComponent (either facet or child) during
26 * a component tree visit.</p>
27 * @author Simon Lessard (latest modification by $Author: bommel $)
28 * @version $Revision: 1187701 $ $Date: 2011-10-22 07:21:54 -0500 (Sat, 22 Oct 2011) $
29 *
30 * @since 2.0
31 */
32 public interface VisitCallback
33 {
34 /**
35 * <p>This method is called during component tree visits by
36 * {@link VisitContext#invokeVisitCallback VisitContext.invokeVisitCallback()}
37 * to visit the specified component. At the point in time when this
38 * method is called, the argument {@code target} is guaranteed
39 * to be in the proper state with respect to its ancestors in the
40 * View.</p>
41 *
42 * @param context the {@link VisitContext} for this tree visit.
43 *
44 * @param target the {@link UIComponent} to visit
45 *
46 * @return a {@link VisitResult} that indicates whether to continue
47 * visiting the component's subtree, skip visiting the component's
48 * subtree or end the visit.
49 */
50 public VisitResult visit(VisitContext context, UIComponent target);
51 }