lombok
Annotation Type Await

@Target(value=METHOD)
@Retention(value=SOURCE)
public @interface Await

Lock Conditions

 void methodAnnotatedWithAwait() throws java.lang.InterruptedException {
   this.<LOCK_NAME>.lock();
   try {
     while (this.<CONDITION_METHOD>()) {
       this.<CONDITION_NAME>.await();
     }
 
     // method body
 
   } finally {
     this.<LOCK_NAME>.unlock();
   }
 }
 
 












Required Element Summary



 String
conditionMethod



          Method to verify if the condition is met.



 String
conditionName



          Name of the condition.


 





Optional Element Summary



 String
lockName



          Name of the lock, default is $<CONDITION_NAME>Lock.



 Position
pos



          Specifies the place to put the await-block, default is BEFORE.


 








Element Detail




conditionName
public abstract String conditionName

Name of the condition.
 

 If no condition with the specified name exists a new Condition will
 be created, using this name.










conditionMethod
public abstract String conditionMethod

Method to verify if the condition is met.
 

 The method must return a boolean and may not require any parameters.








pos
public abstract Position pos

Specifies the place to put the await-block, default is BEFORE.
 

 Supported positions:
 

 
BEFORE - before the method body
 
AFTER - after the method body
 







Default:
lombok.Position.BEFORE





lockName
public abstract String lockName

Name of the lock, default is $<CONDITION_NAME>Lock.
 

 If no lock with the specified name exists a new Lock will be created,
 using this name.







Default:
""














  

  
    Package 
  
  Class 
  
    Tree 
  
    Deprecated 
  
    Index 
  
    Help 
  



lombok-pg - 





 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 







  SUMMARY: REQUIRED | OPTIONAL

DETAIL: ELEMENT






Copyright © 2010-2011 Philipp Eichhorn, licensed under the MIT licence.