1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.5.0_16) on Tue Feb 03 09:28:21 PST 2009 --> 6<TITLE> 7GuardedBy 8</TITLE> 9 10<META NAME="keywords" CONTENT="javax.annotation.concurrent.GuardedBy class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="/stylesheet.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="GuardedBy"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 44 </TR> 45</TABLE> 46</TD> 47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 48</EM> 49</TD> 50</TR> 51 52<TR> 53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 54 PREV CLASS 55 <A HREF="/javax/annotation/concurrent/Immutable.html" title="annotation in javax.annotation.concurrent"><B>NEXT CLASS</B></A></FONT></TD> 56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 57 <A HREF="/index.html?javax/annotation/concurrent/GuardedBy.html" target="_top"><B>FRAMES</B></A> 58 <A HREF="GuardedBy.html" target="_top"><B>NO FRAMES</B></A> 59 <SCRIPT type="text/javascript"> 60 <!-- 61 if(window==top) { 62 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 63 } 64 //--> 65</SCRIPT> 66<NOSCRIPT> 67 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 68</NOSCRIPT> 69 70 71</FONT></TD> 72</TR> 73<TR> 74<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 75 SUMMARY: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> | OPTIONAL</FONT></TD> 76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 77DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 78</TR> 79</TABLE> 80<A NAME="skip-navbar_top"></A> 81<!-- ========= END OF TOP NAVBAR ========= --> 82 83<HR> 84<!-- ======== START OF CLASS DATA ======== --> 85<H2> 86<FONT SIZE="-1"> 87javax.annotation.concurrent</FONT> 88<BR> 89Annotation Type GuardedBy</H2> 90<HR> 91<DL> 92<DT><PRE><FONT SIZE="-1">@Target(value={FIELD,METHOD}) 93@Retention(value=CLASS) 94</FONT>public @interface <B>GuardedBy</B></DL> 95</PRE> 96 97<P> 98GuardedBy 99 100 The field or method to which this annotation is applied can only be accessed 101 when holding a particular lock, which may be a built-in (synchronization) 102 lock, or may be an explicit java.util.concurrent.Lock. 103 104 The argument determines which lock guards the annotated field or method: this : 105 The string literal "this" means that this field is guarded by the class in 106 which it is defined. class-name.this : For inner classes, it may be necessary 107 to disambiguate 'this'; the class-name.this designation allows you to specify 108 which 'this' reference is intended itself : For reference fields only; the 109 object to which the field refers. field-name : The lock object is referenced 110 by the (instance or static) field specified by field-name. 111 class-name.field-name : The lock object is reference by the static field 112 specified by class-name.field-name. method-name() : The lock object is 113 returned by calling the named nil-ary method. class-name.class : The Class 114 object for the specified class should be used as the lock object. 115<P> 116 117<P> 118<HR> 119 120<P> 121<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> 122 123<A NAME="annotation_type_required_element_summary"><!-- --></A> 124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 126<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 127<B>Required Element Summary</B></FONT></TH> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 131<CODE> java.lang.String</CODE></FONT></TD> 132<TD><CODE><B><A HREF="/javax/annotation/concurrent/GuardedBy.html#value()">value</A></B></CODE> 133 134<BR> 135 </TD> 136</TR> 137</TABLE> 138 139<P> 140 141<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 142 143<A NAME="annotation_type_element_detail"><!-- --></A> 144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 146<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 147<B>Element Detail</B></FONT></TH> 148</TR> 149</TABLE> 150 151<A NAME="value()"><!-- --></A><H3> 152value</H3> 153<PRE> 154public abstract java.lang.String <B>value</B></PRE> 155<DL> 156<DD><DL> 157</DL> 158</DD> 159<DD><DL> 160</DL> 161</DL> 162<!-- ========= END OF CLASS DATA ========= --> 163<HR> 164 165 166<!-- ======= START OF BOTTOM NAVBAR ====== --> 167<A NAME="navbar_bottom"><!-- --></A> 168<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 169<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 170<TR> 171<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 172<A NAME="navbar_bottom_firstrow"><!-- --></A> 173<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 174 <TR ALIGN="center" VALIGN="top"> 175 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 176 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 177 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 178 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 179 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 180 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 181 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 182 </TR> 183</TABLE> 184</TD> 185<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 186</EM> 187</TD> 188</TR> 189 190<TR> 191<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 192 PREV CLASS 193 <A HREF="/javax/annotation/concurrent/Immutable.html" title="annotation in javax.annotation.concurrent"><B>NEXT CLASS</B></A></FONT></TD> 194<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 195 <A HREF="/index.html?javax/annotation/concurrent/GuardedBy.html" target="_top"><B>FRAMES</B></A> 196 <A HREF="GuardedBy.html" target="_top"><B>NO FRAMES</B></A> 197 <SCRIPT type="text/javascript"> 198 <!-- 199 if(window==top) { 200 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 201 } 202 //--> 203</SCRIPT> 204<NOSCRIPT> 205 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 206</NOSCRIPT> 207 208 209</FONT></TD> 210</TR> 211<TR> 212<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 213 SUMMARY: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> | OPTIONAL</FONT></TD> 214<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 215DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 216</TR> 217</TABLE> 218<A NAME="skip-navbar_bottom"></A> 219<!-- ======== END OF BOTTOM NAVBAR ======= --> 220 221<HR> 222 223</BODY> 224</HTML> 225