mobile/android/thirdparty/ch/boye/httpclientandroidlib/annotation/GuardedBy.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/annotation/GuardedBy.java
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
| michael@0 | 1 | /* |
| michael@0 | 2 | * ==================================================================== |
| michael@0 | 3 | * |
| michael@0 | 4 | * Licensed to the Apache Software Foundation (ASF) under one or more |
| michael@0 | 5 | * contributor license agreements. See the NOTICE file distributed with |
| michael@0 | 6 | * this work for additional information regarding copyright ownership. |
| michael@0 | 7 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
| michael@0 | 8 | * (the "License"); you may not use this file except in compliance with |
| michael@0 | 9 | * the License. You may obtain a copy of the License at |
| michael@0 | 10 | * |
| michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 12 | * |
| michael@0 | 13 | * Unless required by applicable law or agreed to in writing, software |
| michael@0 | 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
| michael@0 | 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| michael@0 | 16 | * See the License for the specific language governing permissions and |
| michael@0 | 17 | * limitations under the License. |
| michael@0 | 18 | * ==================================================================== |
| michael@0 | 19 | * |
| michael@0 | 20 | * This software consists of voluntary contributions made by many |
| michael@0 | 21 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 22 | * information on the Apache Software Foundation, please see |
| michael@0 | 23 | * <http://www.apache.org/>. |
| michael@0 | 24 | * |
| michael@0 | 25 | */ |
| michael@0 | 26 | package ch.boye.httpclientandroidlib.annotation; |
| michael@0 | 27 | |
| michael@0 | 28 | import java.lang.annotation.Documented; |
| michael@0 | 29 | import java.lang.annotation.ElementType; |
| michael@0 | 30 | import java.lang.annotation.Retention; |
| michael@0 | 31 | import java.lang.annotation.RetentionPolicy; |
| michael@0 | 32 | import java.lang.annotation.Target; |
| michael@0 | 33 | |
| michael@0 | 34 | /** |
| michael@0 | 35 | * The field or method to which this annotation is applied can only be accessed |
| michael@0 | 36 | * when holding a particular lock, which may be a built-in (synchronization) lock, |
| michael@0 | 37 | * or may be an explicit java.util.concurrent.Lock. |
| michael@0 | 38 | * |
| michael@0 | 39 | * The argument determines which lock guards the annotated field or method: |
| michael@0 | 40 | * <ul> |
| michael@0 | 41 | * <li> |
| michael@0 | 42 | * <code>this</code> : The intrinsic lock of the object in whose class the field is defined. |
| michael@0 | 43 | * </li> |
| michael@0 | 44 | * <li> |
| michael@0 | 45 | * <code>class-name.this</code> : For inner classes, it may be necessary to disambiguate 'this'; |
| michael@0 | 46 | * the <em>class-name.this</em> designation allows you to specify which 'this' reference is intended |
| michael@0 | 47 | * </li> |
| michael@0 | 48 | * <li> |
| michael@0 | 49 | * <code>itself</code> : For reference fields only; the object to which the field refers. |
| michael@0 | 50 | * </li> |
| michael@0 | 51 | * <li> |
| michael@0 | 52 | * <code>field-name</code> : The lock object is referenced by the (instance or static) field |
| michael@0 | 53 | * specified by <em>field-name</em>. |
| michael@0 | 54 | * </li> |
| michael@0 | 55 | * <li> |
| michael@0 | 56 | * <code>class-name.field-name</code> : The lock object is reference by the static field specified |
| michael@0 | 57 | * by <em>class-name.field-name</em>. |
| michael@0 | 58 | * </li> |
| michael@0 | 59 | * <li> |
| michael@0 | 60 | * <code>method-name()</code> : The lock object is returned by calling the named nil-ary method. |
| michael@0 | 61 | * </li> |
| michael@0 | 62 | * <li> |
| michael@0 | 63 | * <code>class-name.class</code> : The Class object for the specified class should be used as the lock object. |
| michael@0 | 64 | * </li> |
| michael@0 | 65 | * <p> |
| michael@0 | 66 | * Based on code developed by Brian Goetz and Tim Peierls and concepts |
| michael@0 | 67 | * published in 'Java Concurrency in Practice' by Brian Goetz, Tim Peierls, |
| michael@0 | 68 | * Joshua Bloch, Joseph Bowbeer, David Holmes and Doug Lea. |
| michael@0 | 69 | */ |
| michael@0 | 70 | @Documented |
| michael@0 | 71 | @Target({ElementType.FIELD, ElementType.METHOD}) |
| michael@0 | 72 | @Retention(RetentionPolicy.CLASS) // The original version used RUNTIME |
| michael@0 | 73 | public @interface GuardedBy { |
| michael@0 | 74 | String value(); |
| michael@0 | 75 | } |
