1 package org.apache.beehive.controls.api.context; 2 /* 3 * Copyright 2004 The Apache Software Foundation. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 * $Header:$ 18 */ 19 20 import java.lang.annotation.ElementType; 21 import java.lang.annotation.Retention; 22 import java.lang.annotation.RetentionPolicy; 23 import java.lang.annotation.Target; 24 25 /** 26 * The Context annotation type is used to annotate a field within a control implementation 27 * class that refers to a contextual service. The Java Controls runtime will automatically 28 * initialize the field value to an appropriate provider of the requested service, or will 29 * throw a construction or deserialization error if no such provider is available. 30 * 31 * The following is a simple example: 32 * 33 * <code><pre> 34 * <sp>@ControlImplementation 35 * public class MyControlImpl 36 * { 37 * <sp>@Context 38 * ControlContext myContext; 39 * } 40 * </pre></code> 41 * This example declares a field named <code>myContext</code> that will automatically be 42 * initialized by the Java Controls runtime to refer to a provider of the 43 * <code>ControlContext</code> contextual service. 44 */ 45 @Retention(RetentionPolicy.RUNTIME) 46 @Target({ElementType.FIELD}) 47 public @interface Context 48 { 49 50 } 51