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> 7javax.annotation 8</TITLE> 9 10<META NAME="keywords" CONTENT="javax.annotation package"> 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="javax.annotation"; 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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> 39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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 PACKAGE 55 <A HREF="/javax/annotation/concurrent/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> 56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 57 <A HREF="/index.html?javax/annotation/package-summary.html" target="_top"><B>FRAMES</B></A> 58 <A HREF="package-summary.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</TABLE> 74<A NAME="skip-navbar_top"></A> 75<!-- ========= END OF TOP NAVBAR ========= --> 76 77<HR> 78<H2> 79Package javax.annotation 80</H2> 81 82<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 83<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 84<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 85<B>Class Summary</B></FONT></TH> 86</TR> 87<TR BGCOLOR="white" CLASS="TableRowColor"> 88<TD WIDTH="15%"><B><A HREF="/javax/annotation/MatchesPattern.Checker.html" title="class in javax.annotation">MatchesPattern.Checker</A></B></TD> 89<TD> </TD> 90</TR> 91<TR BGCOLOR="white" CLASS="TableRowColor"> 92<TD WIDTH="15%"><B><A HREF="/javax/annotation/Nonnegative.Checker.html" title="class in javax.annotation">Nonnegative.Checker</A></B></TD> 93<TD> </TD> 94</TR> 95<TR BGCOLOR="white" CLASS="TableRowColor"> 96<TD WIDTH="15%"><B><A HREF="/javax/annotation/Nonnull.Checker.html" title="class in javax.annotation">Nonnull.Checker</A></B></TD> 97<TD> </TD> 98</TR> 99<TR BGCOLOR="white" CLASS="TableRowColor"> 100<TD WIDTH="15%"><B><A HREF="/javax/annotation/RegEx.Checker.html" title="class in javax.annotation">RegEx.Checker</A></B></TD> 101<TD> </TD> 102</TR> 103</TABLE> 104 105 106<P> 107 108<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 109<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 110<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 111<B>Annotation Types Summary</B></FONT></TH> 112</TR> 113<TR BGCOLOR="white" CLASS="TableRowColor"> 114<TD WIDTH="15%"><B><A HREF="/javax/annotation/CheckForNull.html" title="annotation in javax.annotation">CheckForNull</A></B></TD> 115<TD> </TD> 116</TR> 117<TR BGCOLOR="white" CLASS="TableRowColor"> 118<TD WIDTH="15%"><B><A HREF="/javax/annotation/CheckForSigned.html" title="annotation in javax.annotation">CheckForSigned</A></B></TD> 119<TD>Used to annotate a value that may be either negative or nonnegative, and 120 indicates that uses of it should check for 121 negative values before using it in a way that requires the value to be 122 nonnegative, and check for it being nonnegative before using it in a way that 123 requires it to be negative.</TD> 124</TR> 125<TR BGCOLOR="white" CLASS="TableRowColor"> 126<TD WIDTH="15%"><B><A HREF="/javax/annotation/CheckReturnValue.html" title="annotation in javax.annotation">CheckReturnValue</A></B></TD> 127<TD> </TD> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD WIDTH="15%"><B><A HREF="/javax/annotation/Detainted.html" title="annotation in javax.annotation">Detainted</A></B></TD> 131<TD> </TD> 132</TR> 133<TR BGCOLOR="white" CLASS="TableRowColor"> 134<TD WIDTH="15%"><B><A HREF="/javax/annotation/MatchesPattern.html" title="annotation in javax.annotation">MatchesPattern</A></B></TD> 135<TD> </TD> 136</TR> 137<TR BGCOLOR="white" CLASS="TableRowColor"> 138<TD WIDTH="15%"><B><A HREF="/javax/annotation/Nonnegative.html" title="annotation in javax.annotation">Nonnegative</A></B></TD> 139<TD>Used to annotate a value that should only contain nonnegative values</TD> 140</TR> 141<TR BGCOLOR="white" CLASS="TableRowColor"> 142<TD WIDTH="15%"><B><A HREF="/javax/annotation/Nonnull.html" title="annotation in javax.annotation">Nonnull</A></B></TD> 143<TD> </TD> 144</TR> 145<TR BGCOLOR="white" CLASS="TableRowColor"> 146<TD WIDTH="15%"><B><A HREF="/javax/annotation/Nullable.html" title="annotation in javax.annotation">Nullable</A></B></TD> 147<TD> </TD> 148</TR> 149<TR BGCOLOR="white" CLASS="TableRowColor"> 150<TD WIDTH="15%"><B><A HREF="/javax/annotation/OverridingMethodsMustInvokeSuper.html" title="annotation in javax.annotation">OverridingMethodsMustInvokeSuper</A></B></TD> 151<TD>When this annotation is applied to a method, it indicates that if this method 152 is overridden in a subclass, the overriding method should invoke this method 153 (through method invocation on super).</TD> 154</TR> 155<TR BGCOLOR="white" CLASS="TableRowColor"> 156<TD WIDTH="15%"><B><A HREF="/javax/annotation/ParametersAreNonnullByDefault.html" title="annotation in javax.annotation">ParametersAreNonnullByDefault</A></B></TD> 157<TD>This annotation can be applied to a package, class or method to indicate that 158 the method parameters in that element are nonnull by default unless there is: 159 160 An explicit nullness annotation 161 The method overrides a method in a superclass (in which case the 162 annotation of the corresponding parameter in the superclass applies) 163 there is a default parameter annotation applied to a more tightly nested 164 element.</TD> 165</TR> 166<TR BGCOLOR="white" CLASS="TableRowColor"> 167<TD WIDTH="15%"><B><A HREF="/javax/annotation/ParametersAreNullableByDefault.html" title="annotation in javax.annotation">ParametersAreNullableByDefault</A></B></TD> 168<TD>This annotation can be applied to a package, class or method to indicate that 169 the method parameters in that element are nullable by default unless there is: 170 171 An explicit nullness annotation 172 The method overrides a method in a superclass (in which case the 173 annotation of the corresponding parameter in the superclass applies) 174 there is a default parameter annotation applied to a more tightly nested 175 element.</TD> 176</TR> 177<TR BGCOLOR="white" CLASS="TableRowColor"> 178<TD WIDTH="15%"><B><A HREF="/javax/annotation/PropertyKey.html" title="annotation in javax.annotation">PropertyKey</A></B></TD> 179<TD> </TD> 180</TR> 181<TR BGCOLOR="white" CLASS="TableRowColor"> 182<TD WIDTH="15%"><B><A HREF="/javax/annotation/RegEx.html" title="annotation in javax.annotation">RegEx</A></B></TD> 183<TD>This qualifier is used to denote String values that should be a Regular 184 expression.</TD> 185</TR> 186<TR BGCOLOR="white" CLASS="TableRowColor"> 187<TD WIDTH="15%"><B><A HREF="/javax/annotation/Signed.html" title="annotation in javax.annotation">Signed</A></B></TD> 188<TD>Used to annotate a value of unknown sign</TD> 189</TR> 190<TR BGCOLOR="white" CLASS="TableRowColor"> 191<TD WIDTH="15%"><B><A HREF="/javax/annotation/Syntax.html" title="annotation in javax.annotation">Syntax</A></B></TD> 192<TD>This annotation a value that is of a particular syntax, such as Java syntax 193 or regular expression syntax.</TD> 194</TR> 195<TR BGCOLOR="white" CLASS="TableRowColor"> 196<TD WIDTH="15%"><B><A HREF="/javax/annotation/Tainted.html" title="annotation in javax.annotation">Tainted</A></B></TD> 197<TD> </TD> 198</TR> 199<TR BGCOLOR="white" CLASS="TableRowColor"> 200<TD WIDTH="15%"><B><A HREF="/javax/annotation/Untainted.html" title="annotation in javax.annotation">Untainted</A></B></TD> 201<TD> </TD> 202</TR> 203<TR BGCOLOR="white" CLASS="TableRowColor"> 204<TD WIDTH="15%"><B><A HREF="/javax/annotation/WillClose.html" title="annotation in javax.annotation">WillClose</A></B></TD> 205<TD> </TD> 206</TR> 207<TR BGCOLOR="white" CLASS="TableRowColor"> 208<TD WIDTH="15%"><B><A HREF="/javax/annotation/WillCloseWhenClosed.html" title="annotation in javax.annotation">WillCloseWhenClosed</A></B></TD> 209<TD> </TD> 210</TR> 211<TR BGCOLOR="white" CLASS="TableRowColor"> 212<TD WIDTH="15%"><B><A HREF="/javax/annotation/WillNotClose.html" title="annotation in javax.annotation">WillNotClose</A></B></TD> 213<TD> </TD> 214</TR> 215</TABLE> 216 217 218<P> 219<DL> 220</DL> 221<HR> 222 223 224<!-- ======= START OF BOTTOM NAVBAR ====== --> 225<A NAME="navbar_bottom"><!-- --></A> 226<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 227<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 228<TR> 229<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 230<A NAME="navbar_bottom_firstrow"><!-- --></A> 231<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 232 <TR ALIGN="center" VALIGN="top"> 233 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 234 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> 235 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 236 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 237 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 238 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 239 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 240 </TR> 241</TABLE> 242</TD> 243<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 244</EM> 245</TD> 246</TR> 247 248<TR> 249<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 250 PREV PACKAGE 251 <A HREF="/javax/annotation/concurrent/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> 252<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 253 <A HREF="/index.html?javax/annotation/package-summary.html" target="_top"><B>FRAMES</B></A> 254 <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> 255 <SCRIPT type="text/javascript"> 256 <!-- 257 if(window==top) { 258 document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>'); 259 } 260 //--> 261</SCRIPT> 262<NOSCRIPT> 263 <A HREF="/allclasses-noframe.html"><B>All Classes</B></A> 264</NOSCRIPT> 265 266 267</FONT></TD> 268</TR> 269</TABLE> 270<A NAME="skip-navbar_bottom"></A> 271<!-- ======== END OF BOTTOM NAVBAR ======= --> 272 273<HR> 274 275</BODY> 276</HTML> 277