lombok.AwaitBeforeAndSignalAfter Maven / Gradle / Ivy
Show all versions of lombok-pg Show documentation
/*
* Copyright © 2010-2011 Philipp Eichhorn
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package lombok;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.SOURCE;
import java.lang.annotation.*;
/**
* Lock Conditions
*
*
* void methodAnnotatedWithAwait() throws java.lang.InterruptedException {
* this.<LOCK_NAME>.lock();
* try {
* while (this.<AWAIT_CONDITION_METHOD>()) {
* this.<AWAIT_CONDITION_NAME>.await();
* }
*
* // method body
*
* this.<SIGNAL_CONDITION_NAME>.signal();
* } finally {
* this.<LOCK_NAME>.unlock();
* }
* }
*
*
*/
@Target(METHOD)
@Retention(SOURCE)
public @interface AwaitBeforeAndSignalAfter {
/**
* Name of the lock, default is {@code $Lock}.
*
* If no lock with the specified name exists a new {@link java.util.concurrent.locks.Lock Lock} will be created,
* using this name.
*/
String lockName() default "";
/**
* Name of the signal-condition.
*
* If no condition with the specified name exists a new {@link java.util.concurrent.locks.Condition Condition} will
* be created, using this name.
*/
String signalConditionName();
/**
* Name of the await-condition.
*
* If no condition with the specified name exists a new {@link java.util.concurrent.locks.Condition Condition} will
* be created, using this name.
*/
String awaitConditionName();
/**
* Method to verify if the await-condition is met.
*
* The method must return a {@code boolean} and may not require any parameters.
*/
String awaitConditionMethod();
}