View Javadoc

1   /*
2    * ====================================================================
3    *
4    *  Licensed to the Apache Software Foundation (ASF) under one or more
5    *  contributor license agreements.  See the NOTICE file distributed with
6    *  this work for additional information regarding copyright ownership.
7    *  The ASF licenses this file to You under the Apache License, Version 2.0
8    *  (the "License"); you may not use this file except in compliance with
9    *  the License.  You may obtain a copy of the License at
10   *
11   *      http://www.apache.org/licenses/LICENSE-2.0
12   *
13   *  Unless required by applicable law or agreed to in writing, software
14   *  distributed under the License is distributed on an "AS IS" BASIS,
15   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   *  See the License for the specific language governing permissions and
17   *  limitations under the License.
18   * ====================================================================
19   *
20   * This software consists of voluntary contributions made by many
21   * individuals on behalf of the Apache Software Foundation.  For more
22   * information on the Apache Software Foundation, please see
23   * <http://www.apache.org/>.
24   *
25   */
26  package org.apache.http.annotation;
27  
28  import java.lang.annotation.Documented;
29  import java.lang.annotation.ElementType;
30  import java.lang.annotation.Retention;
31  import java.lang.annotation.RetentionPolicy;
32  import java.lang.annotation.Target;
33  
34  /**
35   * The class to which this annotation is applied is thread-safe.  This means that
36   * no sequences of accesses (reads and writes to public fields, calls to public methods)
37   * may put the object into an invalid state, regardless of the interleaving of those actions
38   * by the runtime, and without requiring any additional synchronization or coordination on the
39   * part of the caller.
40   * @see NotThreadSafe
41   * <p>
42   * Based on code developed by Brian Goetz and Tim Peierls and concepts
43   * published in 'Java Concurrency in Practice' by Brian Goetz, Tim Peierls,
44   * Joshua Bloch, Joseph Bowbeer, David Holmes and Doug Lea.
45   */
46  @Documented
47  @Target(ElementType.TYPE)
48  @Retention(RetentionPolicy.CLASS) // The original version used RUNTIME
49  public @interface ThreadSafe {
50  }