Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
VisitHint |
|
| 0.0;0 |
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 hints that impact | |
24 | * the behavior of a component tree visit.</p> | |
25 | * | |
26 | * @see VisitContext#getHints VisitContext.getHints() | |
27 | * | |
28 | * @since 2.0 | |
29 | */ | |
30 | 12 | public enum VisitHint |
31 | { | |
32 | /** | |
33 | * Hint that indicates that only the rendered subtree should be visited. | |
34 | */ | |
35 | 2 | SKIP_UNRENDERED, |
36 | ||
37 | /** | |
38 | * Hint that indicates that only non-transient subtrees should be visited. | |
39 | */ | |
40 | 2 | SKIP_TRANSIENT, |
41 | ||
42 | /** | |
43 | * Hint that indicates that the visit is being performed as part of | |
44 | * lifecycle phase execution and as such phase-specific actions | |
45 | * (initialization) may be taken. | |
46 | */ | |
47 | 2 | EXECUTE_LIFECYCLE, |
48 | ||
49 | /** | |
50 | * Hint that indicates that the visit should traverse only full component | |
51 | * instances and not "virtual" ones like UIData rows and so on. | |
52 | * | |
53 | * @since 2.1 | |
54 | */ | |
55 | 2 | SKIP_ITERATION, |
56 | } |