1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/annotation/GuardedBy.java Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,75 @@
1.4 +/*
1.5 + * ====================================================================
1.6 + *
1.7 + * Licensed to the Apache Software Foundation (ASF) under one or more
1.8 + * contributor license agreements. See the NOTICE file distributed with
1.9 + * this work for additional information regarding copyright ownership.
1.10 + * The ASF licenses this file to You under the Apache License, Version 2.0
1.11 + * (the "License"); you may not use this file except in compliance with
1.12 + * the License. You may obtain a copy of the License at
1.13 + *
1.14 + * http://www.apache.org/licenses/LICENSE-2.0
1.15 + *
1.16 + * Unless required by applicable law or agreed to in writing, software
1.17 + * distributed under the License is distributed on an "AS IS" BASIS,
1.18 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1.19 + * See the License for the specific language governing permissions and
1.20 + * limitations under the License.
1.21 + * ====================================================================
1.22 + *
1.23 + * This software consists of voluntary contributions made by many
1.24 + * individuals on behalf of the Apache Software Foundation. For more
1.25 + * information on the Apache Software Foundation, please see
1.26 + * <http://www.apache.org/>.
1.27 + *
1.28 + */
1.29 +package ch.boye.httpclientandroidlib.annotation;
1.30 +
1.31 +import java.lang.annotation.Documented;
1.32 +import java.lang.annotation.ElementType;
1.33 +import java.lang.annotation.Retention;
1.34 +import java.lang.annotation.RetentionPolicy;
1.35 +import java.lang.annotation.Target;
1.36 +
1.37 +/**
1.38 + * The field or method to which this annotation is applied can only be accessed
1.39 + * when holding a particular lock, which may be a built-in (synchronization) lock,
1.40 + * or may be an explicit java.util.concurrent.Lock.
1.41 + *
1.42 + * The argument determines which lock guards the annotated field or method:
1.43 + * <ul>
1.44 + * <li>
1.45 + * <code>this</code> : The intrinsic lock of the object in whose class the field is defined.
1.46 + * </li>
1.47 + * <li>
1.48 + * <code>class-name.this</code> : For inner classes, it may be necessary to disambiguate 'this';
1.49 + * the <em>class-name.this</em> designation allows you to specify which 'this' reference is intended
1.50 + * </li>
1.51 + * <li>
1.52 + * <code>itself</code> : For reference fields only; the object to which the field refers.
1.53 + * </li>
1.54 + * <li>
1.55 + * <code>field-name</code> : The lock object is referenced by the (instance or static) field
1.56 + * specified by <em>field-name</em>.
1.57 + * </li>
1.58 + * <li>
1.59 + * <code>class-name.field-name</code> : The lock object is reference by the static field specified
1.60 + * by <em>class-name.field-name</em>.
1.61 + * </li>
1.62 + * <li>
1.63 + * <code>method-name()</code> : The lock object is returned by calling the named nil-ary method.
1.64 + * </li>
1.65 + * <li>
1.66 + * <code>class-name.class</code> : The Class object for the specified class should be used as the lock object.
1.67 + * </li>
1.68 + * <p>
1.69 + * Based on code developed by Brian Goetz and Tim Peierls and concepts
1.70 + * published in 'Java Concurrency in Practice' by Brian Goetz, Tim Peierls,
1.71 + * Joshua Bloch, Joseph Bowbeer, David Holmes and Doug Lea.
1.72 + */
1.73 +@Documented
1.74 +@Target({ElementType.FIELD, ElementType.METHOD})
1.75 +@Retention(RetentionPolicy.CLASS) // The original version used RUNTIME
1.76 +public @interface GuardedBy {
1.77 + String value();
1.78 +}
