All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.

There is a newer version: 2.2.20
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

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 automatically registers the class with the runtime as a managed * bean class. Classes must be scanned for the presence of this * annotation at application startup, before any requests have been * serviced.

* *
* *

The value of the {@link #name} attribute is taken to be the * managed-bean-name. If the value of the name * attribute is unspecified or is the empty String, the * managed-bean-name is derived from taking the unqualified * class name portion of the fully qualified class name and converting * the first character to lower case. For example, if the * ManagedBean annotation is on a class with the fully * qualified class name com.foo.Bean, and there is no * name attribute on the annotation, the * managed-bean-name is taken to be bean. The * fully qualified class name of the class to which this annotation is * attached is taken to be the managed-bean-class.

*

The scope of the managed bean is declared using one of {@link * NoneScoped}, {@link RequestScoped}, {@link ViewScoped}, {@link * SessionScoped}, {@link ApplicationScoped}, or {@link CustomScoped} * annotations. If the scope annotations are omitted, the bean must be * handled as if the {@link RequestScoped} annotation is present.

*

If the value of the {@link #eager} attribute is * true, and the managed-bean-scope value is * "application", the runtime must instantiate this class when the * application starts. This instantiation and storing of the instance * must happen before any requests are serviced. If eager is * unspecified or false, or the * managed-bean-scope is something other than * "application", the default "lazy" instantiation and scoped storage of * the managed bean happens.

* *

When the runtime processes this annotation, if a managed bean * exists whose name is equal to the derived managed-bean-name, * a FacesException must be thrown and the * application must not be placed in service.

* *

A class tagged with this annotation must have a public * zero-argument constructor. If such a constructor is not defined on * the class, a FacesException must be thrown and the * application must not be placed in service.

* *
* @since 2.0 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @Inherited public @interface ManagedBean { /**

Taken to be the * managed-bean-name. See class documentation for * details.

*/ String name() default ""; /**

Taken to be the value of the * eager attribute of the managed-bean. * See class documentation for details.

*/ boolean eager() default false; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy