View Javadoc

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