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 /**
22 *
23 * <p>An enum that specifies the possible
24 * results of a call to {@link VisitCallback#visit VisitCallback.visit()}.
25 * </p>
26 *
27 * @see VisitCallback#visit VisitCallback.visit()
28 *
29 * @since 2.0
30 */
31 public enum VisitResult
32 {
33 /**
34 * This result indicates that the tree visit should descend into
35 * current component's subtree.
36 */
37 ACCEPT,
38
39 /**
40 * This result indicates that the tree visit should continue, but
41 * should skip the current component's subtree.
42 */
43 REJECT,
44
45 /**
46 * This result indicates that the tree visit should be terminated.
47 */
48 COMPLETE
49 }