patterntesting.annotation.concurrent.GuardedBy Maven / Gradle / Ivy

Go to download
/**
 * $Id: GuardedBy.java,v 1.3 2016/01/06 21:11:35 oboehm Exp $
 *
 * Copyright (c) 2008 by Oliver Boehm
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 16.01.2009 by oliver ([email protected])
 */
package patterntesting.annotation.concurrent;

import java.lang.annotation.*;

/**
 * With this annotation you can document the lock which guards the field or
 * method. This annotation is only for documentation - there is no aspect
 * available which uses it.
 * 
 * See also 
 * GuardedBy from jcip.net.
 * 
 *
 * @author oliver
 * @version $Revision: 1.3 $
 * @since 16.01.2009
 */
@Documented
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface GuardedBy {

    /**
     *  use the object (e.g. "myLock") which guardes the lock
     *
     * @return the string
     */
    String value() default "this";
}

/*
 * $Log: GuardedBy.java,v $
 * Revision 1.3  2016/01/06 21:11:35  oboehm
 * more javadoc errors corrected
 *
 * Revision 1.2  2016/01/06 20:46:31  oboehm
 * javadoc tags corrected
 *
 * Revision 1.1  2010/01/05 13:26:17  oboehm
 * begin with 1.0
 *
 * Revision 1.4  2009/12/19 22:34:08  oboehm
 * trailing spaces removed
 *
 * Revision 1.3  2009/09/18 13:54:52  oboehm
 * javadoc warnings fixed
 *
 * Revision 1.2  2009/09/11 17:27:24  oboehm
 * checkstyle errors removed
 *
 * Revision 1.1  2009/03/24 08:38:26  oboehm
 * concurrent package moved to patterntesting-concurrent
 */