View Javadoc

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   * @author Simon Lessard (latest modification by $Author: bommel $)
30   * @version $Revision: 1187701 $ $Date: 2011-10-22 12:21:54 +0000 (Sat, 22 Oct 2011) $
31   *
32   * @since 2.0
33   */
34  public enum VisitResult
35  {
36      /**
37       * This result indicates that the tree visit should descend into
38       * current component's subtree.
39       */ 
40      ACCEPT,
41  
42      /**
43       * This result indicates that the tree visit should continue, but
44       * should skip the current component's subtree.
45       */ 
46      REJECT,
47  
48      /**
49       * This result indicates that the tree visit should be terminated.
50       */ 
51      COMPLETE
52  }