    001// Licensed under the Apache License, Version 2.0 (the "License");
    002// you may not use this file except in compliance with the License.
    003// You may obtain a copy of the License at
    004//
    005//     http://www.apache.org/licenses/LICENSE-2.0
    006//
    007// Unless required by applicable law or agreed to in writing, software
    008// distributed under the License is distributed on an "AS IS" BASIS,
    009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    010// See the License for the specific language governing permissions and
    011// limitations under the License.
    012
    013package org.apache.tapestry5.annotations;
    014
    015import org.apache.tapestry5.ioc.annotations.UseWith;
    016
    017import java.lang.annotation.Documented;
    018import java.lang.annotation.Retention;
    019import java.lang.annotation.Target;
    020
    021import static java.lang.annotation.ElementType.FIELD;
    022import static java.lang.annotation.RetentionPolicy.RUNTIME;
    023import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
    024
    025/**
    026 * Annotation for fields for which accessor methods (getters and setters) should be created.  This can help when
    027 * defining the kind of placeholder properties often used in components, though the disadvantage is that you can't
    028 * access the fields in a unit test, and you may get compiler warnings about unused private variables.
    029 *
    030 * The annotation <em>will not</em> overwrite an existing getter or setter method; if you put a Property annotation on a
    031 * field that already has a getter or a setter you will see a runtime exception.
    032 */
    033@Target(FIELD)
    034@Documented
    035@Retention(RUNTIME)
    036@UseWith({COMPONENT,MIXIN,PAGE})
    037public @interface Property
    038{
    039    /**
    040     * Whether to create a readable property (i.e., generate a getter method).
    041     */
    042    boolean read() default true;
    043
    044    /**
    045     * Whether to create a writeable property (i.e., generate a setter method).
    046     */
    047    boolean write() default true;
    048}