jakarta.faces.component.visit.VisitResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of myfaces-api Show documentation

The public API classes of the Apache MyFaces CORE JSF-2.1 project

There is a newer version: 4.1.0-RC3

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package jakarta.faces.component.visit;

/**
 *
 * An enum that specifies the possible 
 * results of a call to {@link VisitCallback#visit VisitCallback.visit()}.
 * 
 *
 * @see VisitCallback#visit VisitCallback.visit()
 * 
 * @since 2.0
 */
public enum VisitResult
{
    /**
     * This result indicates that the tree visit should descend into
     * current component's subtree.
     */ 
    ACCEPT,

    /**
     * This result indicates that the tree visit should continue, but
     * should skip the current component's subtree.
     */ 
    REJECT,

    /**
     * This result indicates that the tree visit should be terminated.
     */ 
    COMPLETE
}