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