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> 7When 8</TITLE> 9 10<META NAME="keywords" CONTENT="javax.annotation.meta.When 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="When"; 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/meta/TypeQualifierValidator.html" title="interface in javax.annotation.meta"><B>PREV CLASS</B></A> 55 NEXT CLASS</FONT></TD> 56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 57 <A HREF="../../../index.html?javax/annotation/meta/When.html" target="_top"><B>FRAMES</B></A> 58 <A HREF="When.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: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> 76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 77DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</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.meta</FONT> 88<BR> 89Enum When</H2> 90<PRE> 91java.lang.Object 92 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.Enum<<A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A>> 93 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>javax.annotation.meta.When</B> 94</PRE> 95<DL> 96<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Comparable<<A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A>></DD> 97</DL> 98<HR> 99<DL> 100<DT><PRE>public enum <B>When</B><DT>extends java.lang.Enum<<A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A>></DL> 101</PRE> 102 103<P> 104Used to describe the relationship between a qualifier T and the set of values 105 S possible on an annotated element. 106 107 In particular, an issues should be reported if an ALWAYS or MAYBE value is 108 used where a NEVER value is required, or if a NEVER or MAYBE value is used 109 where an ALWAYS value is required. 110<P> 111 112<P> 113<HR> 114 115<P> 116<!-- =========== ENUM CONSTANT SUMMARY =========== --> 117 118<A NAME="enum_constant_summary"><!-- --></A> 119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 121<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 122<B>Enum Constant Summary</B></FONT></TH> 123</TR> 124<TR BGCOLOR="white" CLASS="TableRowColor"> 125<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#ALWAYS">ALWAYS</A></B></CODE> 126 127<BR> 128 S is a subset of T</TD> 129</TR> 130<TR BGCOLOR="white" CLASS="TableRowColor"> 131<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#MAYBE">MAYBE</A></B></CODE> 132 133<BR> 134 S intersection T is non empty and S - T is nonempty</TD> 135</TR> 136<TR BGCOLOR="white" CLASS="TableRowColor"> 137<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#NEVER">NEVER</A></B></CODE> 138 139<BR> 140 S intersection T is empty</TD> 141</TR> 142<TR BGCOLOR="white" CLASS="TableRowColor"> 143<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#UNKNOWN">UNKNOWN</A></B></CODE> 144 145<BR> 146 nothing definitive is known about the relation between S and T</TD> 147</TR> 148</TABLE> 149 150<!-- ========== METHOD SUMMARY =========== --> 151 152<A NAME="method_summary"><!-- --></A> 153<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 154<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 155<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 156<B>Method Summary</B></FONT></TH> 157</TR> 158<TR BGCOLOR="white" CLASS="TableRowColor"> 159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 160<CODE>static <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A></CODE></FONT></TD> 161<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#valueOf(java.lang.String)">valueOf</A></B>(java.lang.String name)</CODE> 162 163<BR> 164 Returns the enum constant of this type with the specified name.</TD> 165</TR> 166<TR BGCOLOR="white" CLASS="TableRowColor"> 167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 168<CODE>static <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A>[]</CODE></FONT></TD> 169<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#values()">values</A></B>()</CODE> 170 171<BR> 172 Returns an array containing the constants of this enum type, in 173the order they're declared.</TD> 174</TR> 175</TABLE> 176 <A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A> 177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 178<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 179<TH ALIGN="left"><B>Methods inherited from class java.lang.Enum</B></TH> 180</TR> 181<TR BGCOLOR="white" CLASS="TableRowColor"> 182<TD><CODE>compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</CODE></TD> 183</TR> 184</TABLE> 185 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 186<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 187<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 188<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> 189</TR> 190<TR BGCOLOR="white" CLASS="TableRowColor"> 191<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD> 192</TR> 193</TABLE> 194 195<P> 196 197<!-- ============ ENUM CONSTANT DETAIL =========== --> 198 199<A NAME="enum_constant_detail"><!-- --></A> 200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 202<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 203<B>Enum Constant Detail</B></FONT></TH> 204</TR> 205</TABLE> 206 207<A NAME="ALWAYS"><!-- --></A><H3> 208ALWAYS</H3> 209<PRE> 210public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>ALWAYS</B></PRE> 211<DL> 212<DD>S is a subset of T 213<P> 214<DL> 215</DL> 216</DL> 217<HR> 218 219<A NAME="UNKNOWN"><!-- --></A><H3> 220UNKNOWN</H3> 221<PRE> 222public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>UNKNOWN</B></PRE> 223<DL> 224<DD>nothing definitive is known about the relation between S and T 225<P> 226<DL> 227</DL> 228</DL> 229<HR> 230 231<A NAME="MAYBE"><!-- --></A><H3> 232MAYBE</H3> 233<PRE> 234public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>MAYBE</B></PRE> 235<DL> 236<DD>S intersection T is non empty and S - T is nonempty 237<P> 238<DL> 239</DL> 240</DL> 241<HR> 242 243<A NAME="NEVER"><!-- --></A><H3> 244NEVER</H3> 245<PRE> 246public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>NEVER</B></PRE> 247<DL> 248<DD>S intersection T is empty 249<P> 250<DL> 251</DL> 252</DL> 253 254<!-- ============ METHOD DETAIL ========== --> 255 256<A NAME="method_detail"><!-- --></A> 257<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 258<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 259<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 260<B>Method Detail</B></FONT></TH> 261</TR> 262</TABLE> 263 264<A NAME="values()"><!-- --></A><H3> 265values</H3> 266<PRE> 267public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A>[] <B>values</B>()</PRE> 268<DL> 269<DD>Returns an array containing the constants of this enum type, in 270the order they're declared. This method may be used to iterate 271over the constants as follows: 272<pre> 273for(When c : When.values()) 274 System.out.println(c); 275</pre> 276<P> 277<DD><DL> 278 279<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in 280the order they're declared</DL> 281</DD> 282</DL> 283<HR> 284 285<A NAME="valueOf(java.lang.String)"><!-- --></A><H3> 286valueOf</H3> 287<PRE> 288public static <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>valueOf</B>(java.lang.String name)</PRE> 289<DL> 290<DD>Returns the enum constant of this type with the specified name. 291The string must match <I>exactly</I> an identifier used to declare an 292enum constant in this type. (Extraneous whitespace characters are 293not permitted.) 294<P> 295<DD><DL> 296<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned. 297<DT><B>Returns:</B><DD>the enum constant with the specified name 298<DT><B>Throws:</B> 299<DD><CODE>java.lang.IllegalArgumentException</CODE> - if this enum type has no constant 300with the specified name</DL> 301</DD> 302</DL> 303<!-- ========= END OF CLASS DATA ========= --> 304<HR> 305 306 307<!-- ======= START OF BOTTOM NAVBAR ====== --> 308<A NAME="navbar_bottom"><!-- --></A> 309<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 310<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 311<TR> 312<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 313<A NAME="navbar_bottom_firstrow"><!-- --></A> 314<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 315 <TR ALIGN="center" VALIGN="top"> 316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 318 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 321 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 322 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 323 </TR> 324</TABLE> 325</TD> 326<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 327</EM> 328</TD> 329</TR> 330 331<TR> 332<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 333 <A HREF="../../../javax/annotation/meta/TypeQualifierValidator.html" title="interface in javax.annotation.meta"><B>PREV CLASS</B></A> 334 NEXT CLASS</FONT></TD> 335<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 336 <A HREF="../../../index.html?javax/annotation/meta/When.html" target="_top"><B>FRAMES</B></A> 337 <A HREF="When.html" target="_top"><B>NO FRAMES</B></A> 338 <SCRIPT type="text/javascript"> 339 <!-- 340 if(window==top) { 341 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 342 } 343 //--> 344</SCRIPT> 345<NOSCRIPT> 346 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 347</NOSCRIPT> 348 349 350</FONT></TD> 351</TR> 352<TR> 353<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 354 SUMMARY: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> 355<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 356DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD> 357</TR> 358</TABLE> 359<A NAME="skip-navbar_bottom"></A> 360<!-- ======== END OF BOTTOM NAVBAR ======= --> 361 362<HR> 363 364</BODY> 365</HTML> 366
