javax.faces.bean.ReferencedBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jboss-jsf-api_2.3_spec Show documentation

JSR-000372: JavaServer(TM) Faces 2.3 API

There is a newer version: 3.1.0.SP02

Show newest version

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * 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 javax.faces.bean;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.annotation.Inherited;

/**
 * The presence of this annotation on a class is
 * equivalent to the referenced-bean element in the application
 * configuration resources.
 *
 * @since 2.0
 * @deprecated The referenced-bean concept was used for a design time promise
 * which however did not achieve widespread adoption. There is no direct 
 * replacement for this other than using the XML variant in faces-config.xml.
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
@Inherited
@Deprecated
public @interface ReferencedBean {

    /**
     * Taken to be the
     * referenced-bean-name. See class documentation for
     * {@link ManagedBean} for details.
     *
     * @return the referenced bean name.
     */
    String name() default "";
}