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 *
28 * @since 2.0
29 */
30 public interface VisitCallback
31 {
32 /**
33 * <p>This method is called during component tree visits by
34 * {@link VisitContext#invokeVisitCallback VisitContext.invokeVisitCallback()}
35 * to visit the specified component. At the point in time when this
36 * method is called, the argument {@code target} is guaranteed
37 * to be in the proper state with respect to its ancestors in the
38 * View.</p>
39 *
40 * @param context the {@link VisitContext} for this tree visit.
41 *
42 * @param target the {@link UIComponent} to visit
43 *
44 * @return a {@link VisitResult} that indicates whether to continue
45 * visiting the component's subtree, skip visiting the component's
46 * subtree or end the visit.
47 */
48 public VisitResult visit(VisitContext context, UIComponent target);
49 }