    001    // Copyright 2007, 2009, 2010 The Apache Software Foundation
    002    //
    003    // Licensed under the Apache License, Version 2.0 (the "License");
    004    // you may not use this file except in compliance with the License.
    005    // You may obtain a copy of the License at
    006    //
    007    //      http://www.apache.org/licenses/LICENSE-2.0
    008    //
    009    // Unless required by applicable law or agreed to in writing, software
    010    // distributed under the License is distributed on an "AS IS" BASIS,
    011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    012    // See the License for the specific language governing permissions and
    013    // limitations under the License.
    014
    015    package org.apache.tapestry5.annotations;
    016
    017    import java.lang.annotation.Documented;
    018    import static java.lang.annotation.ElementType.FIELD;
    019    import java.lang.annotation.Retention;
    020    import static java.lang.annotation.RetentionPolicy.RUNTIME;
    021    import java.lang.annotation.Target;
    022
    023    import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
    024    import org.apache.tapestry5.ioc.annotations.UseWith;
    025    import org.apache.tapestry5.services.Session;
    026
    027    /**
    028     * Used to map a property of a page or component to value stored in session.
    029     *
    030     * @since 5.2.0
    031     */
    032    @Target(FIELD)
    033    @Documented
    034    @Retention(RUNTIME)
    035    @UseWith({COMPONENT,MIXIN,PAGE})
    036    public @interface SessionAttribute
    037    {
    038
    039        /**
    040         * Name of a the {@link Session} attribute to which the field will be mapped; if not specified,
    041         * defaults to the name of the field.
    042         */
    043        String value() default "";
    044    }