svn commit: r930732 - /ofbiz/trunk/framework/base/src/org/ofbiz/base/lang/LockedBy.java

[doogie-3]

Author: doogie
Date: Sun Apr  4 18:52:19 2010
New Revision: 930732

URL: http://svn.apache.org/viewvc?rev=930732&view=rev
Log:
Annotation used to document how some other variable or method is
protected under some other locking mechanism.

Added:
    ofbiz/trunk/framework/base/src/org/ofbiz/base/lang/LockedBy.java

Added: ofbiz/trunk/framework/base/src/org/ofbiz/base/lang/LockedBy.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/lang/LockedBy.java?rev=930732&view=auto
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/lang/LockedBy.java (added)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/lang/LockedBy.java Sun Apr  4 18:52:19 2010
@@ -0,0 +1,20 @@
+package org.ofbiz.base.lang;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+
+/** This annotation is meanted to be used to describe how some variable
+ * or method is protected by some other locking mechanism.  It's value
+ * is free-form, and can contain anything.  It will generally contain
+ * the name of an instance variable, including <code>this</code>.
+ */
+@Documented
+@Retention(RetentionPolicy.SOURCE)
+@Target({ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.METHOD})
+public @interface LockedBy {
+    String value();
+}