javax.faces.bean.ManagedProperty Maven / Gradle / Ivy
Show all versions of jsf-api Show documentation
/*
* 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;
/**
* The presence of this annotation on a
* field of a class annotated with {@link ManagedBean} instructs the
* system to inject a value into this property as described in section
* JSF.5.3 of the spec prose document in the
* <managed-property> subsection. The time of
* instantiation is dictated by the value of the attributes on the usage
* of ManagedBean and by the application logic itself. The
* value of the {@link #value} attribute may be a literal
* String or a ValueExpression. If the
* latter, the expression must not be evaluated until the bean is
* instantiated. The value of the name attribute is taken to be the
* managed-property-name for this property. If not specified,
* the managed-property-name is taken to be the name of the
* field to which this is attribute is attached.
*
* If this annotation is present on a class
* that does not have the ManagedBean annotation, the
* implementation must take no action on this annotation.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ManagedProperty {
/** Taken to be the
* managed-property-name. See class documentation for
* details.
*/
String name() default "";
/** Taken to be the value that is
* injected into the field. See class documentation for
* details.
*/
String value();
}