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> 7 CheckReturnValue 8 </TITLE> 9 10 <META NAME="keywords" CONTENT="javax.annotation.CheckReturnValue class"> 11 12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style"> 13 14 <SCRIPT type="text/javascript"> 15 function windowTitle() 16 { 17 parent.document.title="CheckReturnValue"; 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 <A HREF="../../javax/annotation/CheckForSigned.html" title="annotation in javax.annotation"><B>PREV CLASS</B></A> 55 <A HREF="../../javax/annotation/Detainted.html" title="annotation in javax.annotation"><B>NEXT CLASS</B></A></FONT></TD> 56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 57 <A HREF="../../index.html?javax/annotation/CheckReturnValue.html" target="_top"><B>FRAMES</B></A> 58 <A HREF="CheckReturnValue.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: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 77 DETAIL: <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"> 87 javax.annotation</FONT> 88 <BR> 89 Annotation Type CheckReturnValue</H2> 90 <HR> 91 <DL> 92 <DT><PRE><FONT SIZE="-1">@Documented 93 @Target(value={METHOD,CONSTRUCTOR,TYPE,PACKAGE}) 94 @Retention(value=RUNTIME) 95 </FONT>public @interface <B>CheckReturnValue</B></DL> 96 </PRE> 97 98 <P> 99 <HR> 100 101 <P> 102 <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 103 104 <A NAME="annotation_type_optional_element_summary"><!-- --></A> 105 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 106 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 107 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 108 <B>Optional Element Summary</B></FONT></TH> 109 </TR> 110 <TR BGCOLOR="white" CLASS="TableRowColor"> 111 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 112 <CODE> <A HREF="../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A></CODE></FONT></TD> 113 <TD><CODE><B><A HREF="../../javax/annotation/CheckReturnValue.html#when()">when</A></B></CODE> 114 115 <BR> 116 </TD> 117 </TR> 118 </TABLE> 119 120 <P> 121 <A NAME="when()"><!-- --></A><H3> 122 when</H3> 123 <PRE> 124 public abstract <A HREF="../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>when</B></PRE> 125 <DL> 126 <DD><DL> 127 </DL> 128 </DD> 129 <DD><DL> 130 </DL> 131 <DL> 132 <DT><B>Default:</B><DD>ALWAYS</DD> 133 </DL> 134 </DL> 135 <!-- ========= END OF CLASS DATA ========= --> 136 <HR> 137 138 139 <!-- ======= START OF BOTTOM NAVBAR ====== --> 140 <A NAME="navbar_bottom"><!-- --></A> 141 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 142 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 143 <TR> 144 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 145 <A NAME="navbar_bottom_firstrow"><!-- --></A> 146 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 147 <TR ALIGN="center" VALIGN="top"> 148 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 149 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 150 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 151 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 152 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 153 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 154 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 155 </TR> 156 </TABLE> 157 </TD> 158 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 159 </EM> 160 </TD> 161 </TR> 162 163 <TR> 164 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 165 <A HREF="../../javax/annotation/CheckForSigned.html" title="annotation in javax.annotation"><B>PREV CLASS</B></A> 166 <A HREF="../../javax/annotation/Detainted.html" title="annotation in javax.annotation"><B>NEXT CLASS</B></A></FONT></TD> 167 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 168 <A HREF="../../index.html?javax/annotation/CheckReturnValue.html" target="_top"><B>FRAMES</B></A> 169 <A HREF="CheckReturnValue.html" target="_top"><B>NO FRAMES</B></A> 170 <SCRIPT type="text/javascript"> 171 <!-- 172 if(window==top) { 173 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); 174 } 175 //--> 176 </SCRIPT> 177 <NOSCRIPT> 178 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> 179 </NOSCRIPT> 180 181 182 </FONT></TD> 183 </TR> 184 <TR> 185 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 186 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 187 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 188 DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 189 </TR> 190 </TABLE> 191 <A NAME="skip-navbar_bottom"></A> 192 <!-- ======== END OF BOTTOM NAVBAR ======= --> 193 194 <HR> 195 196 </BODY> 197 </HTML> 198