michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *      http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  *  Unless required by applicable law or agreed to in writing, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: package ch.boye.httpclientandroidlib.annotation;
michael@0: 
michael@0: import java.lang.annotation.Documented;
michael@0: import java.lang.annotation.ElementType;
michael@0: import java.lang.annotation.Retention;
michael@0: import java.lang.annotation.RetentionPolicy;
michael@0: import java.lang.annotation.Target;
michael@0: 
michael@0: /**
michael@0:  * The field or method to which this annotation is applied can only be accessed
michael@0:  * when holding a particular lock, which may be a built-in (synchronization) lock,
michael@0:  * or may be an explicit java.util.concurrent.Lock.
michael@0:  *
michael@0:  * The argument determines which lock guards the annotated field or method:
michael@0:  * <ul>
michael@0:  * <li>
michael@0:  * <code>this</code> : The intrinsic lock of the object in whose class the field is defined.
michael@0:  * </li>
michael@0:  * <li>
michael@0:  * <code>class-name.this</code> : For inner classes, it may be necessary to disambiguate 'this';
michael@0:  * the <em>class-name.this</em> designation allows you to specify which 'this' reference is intended
michael@0:  * </li>
michael@0:  * <li>
michael@0:  * <code>itself</code> : For reference fields only; the object to which the field refers.
michael@0:  * </li>
michael@0:  * <li>
michael@0:  * <code>field-name</code> : The lock object is referenced by the (instance or static) field
michael@0:  * specified by <em>field-name</em>.
michael@0:  * </li>
michael@0:  * <li>
michael@0:  * <code>class-name.field-name</code> : The lock object is reference by the static field specified
michael@0:  * by <em>class-name.field-name</em>.
michael@0:  * </li>
michael@0:  * <li>
michael@0:  * <code>method-name()</code> : The lock object is returned by calling the named nil-ary method.
michael@0:  * </li>
michael@0:  * <li>
michael@0:  * <code>class-name.class</code> : The Class object for the specified class should be used as the lock object.
michael@0:  * </li>
michael@0:  * <p>
michael@0:  * Based on code developed by Brian Goetz and Tim Peierls and concepts
michael@0:  * published in 'Java Concurrency in Practice' by Brian Goetz, Tim Peierls,
michael@0:  * Joshua Bloch, Joseph Bowbeer, David Holmes and Doug Lea.
michael@0:  */
michael@0: @Documented
michael@0: @Target({ElementType.FIELD, ElementType.METHOD})
michael@0: @Retention(RetentionPolicy.CLASS) // The original version used RUNTIME
michael@0: public @interface GuardedBy {
michael@0:     String value();
michael@0: }