001// Copyright 2008, 2009 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 015package org.apache.tapestry5.annotations; 016 017import java.lang.annotation.Documented; 018import static java.lang.annotation.ElementType.FIELD; 019import java.lang.annotation.Retention; 020import static java.lang.annotation.RetentionPolicy.RUNTIME; 021import java.lang.annotation.Target; 022 023import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*; 024import org.apache.tapestry5.ioc.annotations.UseWith; 025 026/** 027 * Annotation for fields for which accessor methods (getters and setters) should be created. This can help when 028 * defining the kind of placeholder properties often used in components, though the disadvantage is that you can't 029 * access the fields in a unit test, and you may get compiler warnings about unused private variables. 030 * <p/> 031 * The annotation <em>will not</em> overwrite an existing getter or setter method; if you put a Property annotation on a 032 * field that already has a getter or a setter you will see a runtime exception. 033 */ 034@Target(FIELD) 035@Documented 036@Retention(RUNTIME) 037@UseWith({COMPONENT,MIXIN,PAGE}) 038public @interface Property 039{ 040 /** 041 * Whether to create a readable property (i.e., generate a getter method). 042 */ 043 boolean read() default true; 044 045 /** 046 * Whether to create a writeable property (i.e., generate a setter method). 047 */ 048 boolean write() default true; 049}