jakarta.faces.annotation.FacesConfig Maven / Gradle / Ivy

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2021 Contributors to Eclipse Foundation.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.faces.annotation;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import jakarta.enterprise.util.AnnotationLiteral;
import jakarta.enterprise.util.Nonbinding;
import jakarta.inject.Qualifier;

/**
 * 
 * The presence of this annotation on a class deployed within an application 
 * guarantees activation of Jakarta Faces and its CDI specific features, even when 
 * /WEB-INF/faces-config.xml is absent and FacesServlet is not explicitly registered.
 * 
 */
@Qualifier
@Target(TYPE)
@Retention(RUNTIME)
public @interface FacesConfig {


    /**
     * 
     * Supports inline instantiation of the {@link FacesConfig} qualifier.
     * 
     *
     * @since 4.0
     */
    public static final class Literal extends AnnotationLiteral implements FacesConfig {
        private static final long serialVersionUID = 1L;

        /**
         * Instance of the {@link FacesConfig} qualifier.
         */
        public static final Literal INSTANCE = new Literal();

        @Override
        public Version version() {
            return null; // non binding, so not used
        }
    }

    /**
     * The Faces spec version
     * 
     * @deprecated It has no effect anymore as per Jakarta Faces version 4.0; the actual impl version should be leading. 
     */
    @Deprecated(forRemoval = true, since = "4.0")
    public static enum Version {

        /**
         * 
         * This value indicates CDI should be used for Jakarta Expression Language resolution as well as enabling Jakarta Server
         * Faces CDI injection, as specified in Section 5.6.3 "CDI for EL Resolution" and Section 5.9 "CDI Integration".
         * 
         */
        JSF_2_3

    }

    /**
     * 
     * The value of this attribute indicates that features corresponding to this version must be enabled for this
     * application.
     * 
     *
     * @return the spec version for which the features must be enabled.
     * 
     * @deprecated It has no effect anymore as per Jakarta Faces version 4.0; the actual impl version should be leading. 
     */
    @Nonbinding
    @Deprecated(forRemoval = true, since = "4.0")
    Version version() default Version.JSF_2_3;

}