1   // Copyright 2006 The Apache Software Foundation
    2   //
    3   // Licensed under the Apache License, Version 2.0 (the "License");
    4   // you may not use this file except in compliance with the License.
    5   // You may obtain a copy of the License at
    6   //
    7   //     http://www.apache.org/licenses/LICENSE-2.0
    8   //
    9   // Unless required by applicable law or agreed to in writing, software
   10   // distributed under the License is distributed on an "AS IS" BASIS,
   11   // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12   // See the License for the specific language governing permissions and
   13   // limitations under the License.
   14   
   15   package org.apache.tapestry5.annotations;
   16   
   17   import org.apache.tapestry5.services.Environment;
   18   
   19   import java.lang.annotation.Documented;
   20   import static java.lang.annotation.ElementType.FIELD;
   21   import java.lang.annotation.Retention;
   22   import static java.lang.annotation.RetentionPolicy.RUNTIME;
   23   import java.lang.annotation.Target;
   24   
   25   /**
   26    * Defines a field that is replaced at runtime with a read-only value obtained from the {@link Environment} service.
   27    */
   28   @Target(FIELD)
   29   @Documented
   30   @Retention(RUNTIME)
   31   public @interface Environmental
   32   {
   33       /**
   34        * The value determines if the environmental service to be injected is required or not. In most cases, it is, so the
   35        * default is true.
   36        */
   37       boolean value() default true;
   38   }