diff options
Diffstat (limited to 'javadoc/javax/annotation/meta/When.html')
| -rw-r--r-- | javadoc/javax/annotation/meta/When.html | 365 |
1 files changed, 365 insertions, 0 deletions
diff --git a/javadoc/javax/annotation/meta/When.html b/javadoc/javax/annotation/meta/When.html new file mode 100644 index 0000000..f5ef57a --- /dev/null +++ b/javadoc/javax/annotation/meta/When.html @@ -0,0 +1,365 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_16) on Tue Feb 03 09:28:21 PST 2009 --> +<TITLE> +When +</TITLE> + +<META NAME="keywords" CONTENT="javax.annotation.meta.When class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="When"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../javax/annotation/meta/TypeQualifierValidator.html" title="interface in javax.annotation.meta"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?javax/annotation/meta/When.html" target="_top"><B>FRAMES</B></A> + <A HREF="When.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +javax.annotation.meta</FONT> +<BR> +Enum When</H2> +<PRE> +java.lang.Object + <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>> + <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>javax.annotation.meta.When</B> +</PRE> +<DL> +<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> +</DL> +<HR> +<DL> +<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> +</PRE> + +<P> +Used to describe the relationship between a qualifier T and the set of values + S possible on an annotated element. + + In particular, an issues should be reported if an ALWAYS or MAYBE value is + used where a NEVER value is required, or if a NEVER or MAYBE value is used + where an ALWAYS value is required. +<P> + +<P> +<HR> + +<P> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> + +<A NAME="enum_constant_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Enum Constant Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#ALWAYS">ALWAYS</A></B></CODE> + +<BR> + S is a subset of T</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#MAYBE">MAYBE</A></B></CODE> + +<BR> + S intersection T is non empty and S - T is nonempty</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#NEVER">NEVER</A></B></CODE> + +<BR> + S intersection T is empty</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#UNKNOWN">UNKNOWN</A></B></CODE> + +<BR> + nothing definitive is known about the relation between S and T</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#valueOf(java.lang.String)">valueOf</A></B>(java.lang.String name)</CODE> + +<BR> + Returns the enum constant of this type with the specified name.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A>[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../javax/annotation/meta/When.html#values()">values</A></B>()</CODE> + +<BR> + Returns an array containing the constants of this enum type, in +the order they're declared.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Enum</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ ENUM CONSTANT DETAIL =========== --> + +<A NAME="enum_constant_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Enum Constant Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="ALWAYS"><!-- --></A><H3> +ALWAYS</H3> +<PRE> +public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>ALWAYS</B></PRE> +<DL> +<DD>S is a subset of T +<P> +<DL> +</DL> +</DL> +<HR> + +<A NAME="UNKNOWN"><!-- --></A><H3> +UNKNOWN</H3> +<PRE> +public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>UNKNOWN</B></PRE> +<DL> +<DD>nothing definitive is known about the relation between S and T +<P> +<DL> +</DL> +</DL> +<HR> + +<A NAME="MAYBE"><!-- --></A><H3> +MAYBE</H3> +<PRE> +public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>MAYBE</B></PRE> +<DL> +<DD>S intersection T is non empty and S - T is nonempty +<P> +<DL> +</DL> +</DL> +<HR> + +<A NAME="NEVER"><!-- --></A><H3> +NEVER</H3> +<PRE> +public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>NEVER</B></PRE> +<DL> +<DD>S intersection T is empty +<P> +<DL> +</DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="values()"><!-- --></A><H3> +values</H3> +<PRE> +public static final <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A>[] <B>values</B>()</PRE> +<DL> +<DD>Returns an array containing the constants of this enum type, in +the order they're declared. This method may be used to iterate +over the constants as follows: +<pre> +for(When c : When.values()) + System.out.println(c); +</pre> +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in +the order they're declared</DL> +</DD> +</DL> +<HR> + +<A NAME="valueOf(java.lang.String)"><!-- --></A><H3> +valueOf</H3> +<PRE> +public static <A HREF="../../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>valueOf</B>(java.lang.String name)</PRE> +<DL> +<DD>Returns the enum constant of this type with the specified name. +The string must match <I>exactly</I> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned. +<DT><B>Returns:</B><DD>the enum constant with the specified name +<DT><B>Throws:</B> +<DD><CODE>java.lang.IllegalArgumentException</CODE> - if this enum type has no constant +with the specified name</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../javax/annotation/meta/TypeQualifierValidator.html" title="interface in javax.annotation.meta"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?javax/annotation/meta/When.html" target="_top"><B>FRAMES</B></A> + <A HREF="When.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |