001/*
002 * Copyright 2017 The Error Prone Authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package com.google.errorprone.annotations.concurrent;
017
018import static java.lang.annotation.ElementType.FIELD;
019import static java.lang.annotation.ElementType.METHOD;
020import static java.lang.annotation.RetentionPolicy.SOURCE;
021
022import java.lang.annotation.Retention;
023import java.lang.annotation.Target;
024
025/** Indicates that the annotated element should be used only while holding the specified lock. */
026@Target({FIELD, METHOD})
027@Retention(SOURCE)
028public @interface GuardedBy {
029  /**
030   * The lock that should be held, specified in the format <a
031   * href="http://jcip.net/annotations/doc/net/jcip/annotations/GuardedBy.html">given in Java
032   * Concurrency in Practice</a>.
033   */
034  String value();
035}