001// Copyright 2005 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.tapestry.annotations;
016
017import java.lang.annotation.Documented;
018import java.lang.annotation.ElementType;
019import java.lang.annotation.Retention;
020import java.lang.annotation.RetentionPolicy;
021import java.lang.annotation.Target;
022
023/**
024 * An annotation used to provide the initial value of a transient or persistent property.
025 * 
026 * @author Howard M. Lewis Ship
027 * @since 4.0
028 * @see org.apache.tapestry.annotations.PersistAnnotationWorker
029 * @see org.apache.tapestry.annotations.InitialValueAnnotationWorker
030 */
031@Target(
032{ ElementType.METHOD })
033@Retention(RetentionPolicy.RUNTIME)
034@Documented
035public @interface InitialValue {
036    /**
037     * The initial value for the property as a binding reference that is evaluated when the page is
038     * first constructed, and again every time the page is detached and returned to the page pool.
039     * The default binding prefix is "ognl:".
040     */
041    String value();
042}