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 GilbrideSyntax 8*b04680f1SMatt Gilbride</TITLE> 9*b04680f1SMatt Gilbride 10*b04680f1SMatt Gilbride<META NAME="keywords" CONTENT="javax.annotation.Syntax 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="Syntax"; 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 <A HREF="../../javax/annotation/Signed.html" title="annotation in javax.annotation"><B>PREV CLASS</B></A> 55*b04680f1SMatt Gilbride <A HREF="../../javax/annotation/Tainted.html" title="annotation in javax.annotation"><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/Syntax.html" target="_top"><B>FRAMES</B></A> 58*b04680f1SMatt Gilbride <A HREF="Syntax.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> | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></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</FONT> 88*b04680f1SMatt Gilbride<BR> 89*b04680f1SMatt GilbrideAnnotation Type Syntax</H2> 90*b04680f1SMatt Gilbride<HR> 91*b04680f1SMatt Gilbride<DL> 92*b04680f1SMatt Gilbride<DT><PRE><FONT SIZE="-1">@Documented 93*b04680f1SMatt Gilbride<A HREF="../../javax/annotation/meta/TypeQualifier.html" title="annotation in javax.annotation.meta">@TypeQualifier</A>(<A HREF="../../javax/annotation/meta/TypeQualifier.html#applicableTo()">applicableTo</A>=java.lang.String.class) 94*b04680f1SMatt Gilbride@Retention(value=RUNTIME) 95*b04680f1SMatt Gilbride</FONT>public @interface <B>Syntax</B></DL> 96*b04680f1SMatt Gilbride</PRE> 97*b04680f1SMatt Gilbride 98*b04680f1SMatt Gilbride<P> 99*b04680f1SMatt GilbrideThis annotation a value that is of a particular syntax, such as Java syntax 100*b04680f1SMatt Gilbride or regular expression syntax. This can be used to provide syntax checking of 101*b04680f1SMatt Gilbride constant values at compile time, run time checking at runtime, and can assist 102*b04680f1SMatt Gilbride IDEs in deciding how to interpret String constants (e.g., should a 103*b04680f1SMatt Gilbride refactoring that renames method x() to y() update the String constant "x()"). 104*b04680f1SMatt Gilbride<P> 105*b04680f1SMatt Gilbride 106*b04680f1SMatt Gilbride<P> 107*b04680f1SMatt Gilbride<HR> 108*b04680f1SMatt Gilbride 109*b04680f1SMatt Gilbride<P> 110*b04680f1SMatt Gilbride<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> 111*b04680f1SMatt Gilbride 112*b04680f1SMatt Gilbride<A NAME="annotation_type_required_element_summary"><!-- --></A> 113*b04680f1SMatt Gilbride<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 114*b04680f1SMatt Gilbride<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 115*b04680f1SMatt Gilbride<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 116*b04680f1SMatt Gilbride<B>Required Element Summary</B></FONT></TH> 117*b04680f1SMatt Gilbride</TR> 118*b04680f1SMatt Gilbride<TR BGCOLOR="white" CLASS="TableRowColor"> 119*b04680f1SMatt Gilbride<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 120*b04680f1SMatt Gilbride<CODE> java.lang.String</CODE></FONT></TD> 121*b04680f1SMatt Gilbride<TD><CODE><B><A HREF="../../javax/annotation/Syntax.html#value()">value</A></B></CODE> 122*b04680f1SMatt Gilbride 123*b04680f1SMatt Gilbride<BR> 124*b04680f1SMatt Gilbride Value indicating the particular syntax denoted by this annotation.</TD> 125*b04680f1SMatt Gilbride</TR> 126*b04680f1SMatt Gilbride</TABLE> 127*b04680f1SMatt Gilbride <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 128*b04680f1SMatt Gilbride 129*b04680f1SMatt Gilbride<A NAME="annotation_type_optional_element_summary"><!-- --></A> 130*b04680f1SMatt Gilbride<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 131*b04680f1SMatt Gilbride<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 132*b04680f1SMatt Gilbride<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 133*b04680f1SMatt Gilbride<B>Optional Element Summary</B></FONT></TH> 134*b04680f1SMatt Gilbride</TR> 135*b04680f1SMatt Gilbride<TR BGCOLOR="white" CLASS="TableRowColor"> 136*b04680f1SMatt Gilbride<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 137*b04680f1SMatt Gilbride<CODE> <A HREF="../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A></CODE></FONT></TD> 138*b04680f1SMatt Gilbride<TD><CODE><B><A HREF="../../javax/annotation/Syntax.html#when()">when</A></B></CODE> 139*b04680f1SMatt Gilbride 140*b04680f1SMatt Gilbride<BR> 141*b04680f1SMatt Gilbride </TD> 142*b04680f1SMatt Gilbride</TR> 143*b04680f1SMatt Gilbride</TABLE> 144*b04680f1SMatt Gilbride 145*b04680f1SMatt Gilbride<P> 146*b04680f1SMatt Gilbride 147*b04680f1SMatt Gilbride<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 148*b04680f1SMatt Gilbride 149*b04680f1SMatt Gilbride<A NAME="annotation_type_element_detail"><!-- --></A> 150*b04680f1SMatt Gilbride<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 151*b04680f1SMatt Gilbride<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 152*b04680f1SMatt Gilbride<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 153*b04680f1SMatt Gilbride<B>Element Detail</B></FONT></TH> 154*b04680f1SMatt Gilbride</TR> 155*b04680f1SMatt Gilbride</TABLE> 156*b04680f1SMatt Gilbride 157*b04680f1SMatt Gilbride<A NAME="value()"><!-- --></A><H3> 158*b04680f1SMatt Gilbridevalue</H3> 159*b04680f1SMatt Gilbride<PRE> 160*b04680f1SMatt Gilbridepublic abstract java.lang.String <B>value</B></PRE> 161*b04680f1SMatt Gilbride<DL> 162*b04680f1SMatt Gilbride<DD>Value indicating the particular syntax denoted by this annotation. 163*b04680f1SMatt Gilbride Different tools will recognize different syntaxes, but some proposed 164*b04680f1SMatt Gilbride canonical values are: 165*b04680f1SMatt Gilbride <ul> 166*b04680f1SMatt Gilbride <li> "Java" 167*b04680f1SMatt Gilbride <li> "RegEx" 168*b04680f1SMatt Gilbride <li> "JavaScript" 169*b04680f1SMatt Gilbride <li> "Ruby" 170*b04680f1SMatt Gilbride <li> "Groovy" 171*b04680f1SMatt Gilbride <li> "SQL" 172*b04680f1SMatt Gilbride <li> "FormatString" 173*b04680f1SMatt Gilbride </ul> 174*b04680f1SMatt Gilbride 175*b04680f1SMatt Gilbride Syntax names can be followed by a colon and a list of key value pairs, 176*b04680f1SMatt Gilbride separated by commas. For example, "SQL:dialect=Oracle,version=2.3". Tools 177*b04680f1SMatt Gilbride should ignore any keys they don't recognize. 178*b04680f1SMatt Gilbride<P> 179*b04680f1SMatt Gilbride<DD><DL> 180*b04680f1SMatt Gilbride</DL> 181*b04680f1SMatt Gilbride</DD> 182*b04680f1SMatt Gilbride<DD><DL> 183*b04680f1SMatt Gilbride</DL> 184*b04680f1SMatt Gilbride</DL> 185*b04680f1SMatt Gilbride<A NAME="when()"><!-- --></A><H3> 186*b04680f1SMatt Gilbridewhen</H3> 187*b04680f1SMatt Gilbride<PRE> 188*b04680f1SMatt Gilbridepublic abstract <A HREF="../../javax/annotation/meta/When.html" title="enum in javax.annotation.meta">When</A> <B>when</B></PRE> 189*b04680f1SMatt Gilbride<DL> 190*b04680f1SMatt Gilbride<DD><DL> 191*b04680f1SMatt Gilbride</DL> 192*b04680f1SMatt Gilbride</DD> 193*b04680f1SMatt Gilbride<DD><DL> 194*b04680f1SMatt Gilbride</DL> 195*b04680f1SMatt Gilbride<DL> 196*b04680f1SMatt Gilbride<DT><B>Default:</B><DD>ALWAYS</DD> 197*b04680f1SMatt Gilbride</DL> 198*b04680f1SMatt Gilbride</DL> 199*b04680f1SMatt Gilbride<!-- ========= END OF CLASS DATA ========= --> 200*b04680f1SMatt Gilbride<HR> 201*b04680f1SMatt Gilbride 202*b04680f1SMatt Gilbride 203*b04680f1SMatt Gilbride<!-- ======= START OF BOTTOM NAVBAR ====== --> 204*b04680f1SMatt Gilbride<A NAME="navbar_bottom"><!-- --></A> 205*b04680f1SMatt Gilbride<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 206*b04680f1SMatt Gilbride<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 207*b04680f1SMatt Gilbride<TR> 208*b04680f1SMatt Gilbride<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 209*b04680f1SMatt Gilbride<A NAME="navbar_bottom_firstrow"><!-- --></A> 210*b04680f1SMatt Gilbride<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 211*b04680f1SMatt Gilbride <TR ALIGN="center" VALIGN="top"> 212*b04680f1SMatt Gilbride <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 213*b04680f1SMatt Gilbride <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 214*b04680f1SMatt Gilbride <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 215*b04680f1SMatt Gilbride <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 216*b04680f1SMatt Gilbride <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 217*b04680f1SMatt Gilbride <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 218*b04680f1SMatt Gilbride <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 219*b04680f1SMatt Gilbride </TR> 220*b04680f1SMatt Gilbride</TABLE> 221*b04680f1SMatt Gilbride</TD> 222*b04680f1SMatt Gilbride<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 223*b04680f1SMatt Gilbride</EM> 224*b04680f1SMatt Gilbride</TD> 225*b04680f1SMatt Gilbride</TR> 226*b04680f1SMatt Gilbride 227*b04680f1SMatt Gilbride<TR> 228*b04680f1SMatt Gilbride<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 229*b04680f1SMatt Gilbride <A HREF="../../javax/annotation/Signed.html" title="annotation in javax.annotation"><B>PREV CLASS</B></A> 230*b04680f1SMatt Gilbride <A HREF="../../javax/annotation/Tainted.html" title="annotation in javax.annotation"><B>NEXT CLASS</B></A></FONT></TD> 231*b04680f1SMatt Gilbride<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 232*b04680f1SMatt Gilbride <A HREF="../../index.html?javax/annotation/Syntax.html" target="_top"><B>FRAMES</B></A> 233*b04680f1SMatt Gilbride <A HREF="Syntax.html" target="_top"><B>NO FRAMES</B></A> 234*b04680f1SMatt Gilbride <SCRIPT type="text/javascript"> 235*b04680f1SMatt Gilbride <!-- 236*b04680f1SMatt Gilbride if(window==top) { 237*b04680f1SMatt Gilbride document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>'); 238*b04680f1SMatt Gilbride } 239*b04680f1SMatt Gilbride //--> 240*b04680f1SMatt Gilbride</SCRIPT> 241*b04680f1SMatt Gilbride<NOSCRIPT> 242*b04680f1SMatt Gilbride <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A> 243*b04680f1SMatt Gilbride</NOSCRIPT> 244*b04680f1SMatt Gilbride 245*b04680f1SMatt Gilbride 246*b04680f1SMatt Gilbride</FONT></TD> 247*b04680f1SMatt Gilbride</TR> 248*b04680f1SMatt Gilbride<TR> 249*b04680f1SMatt Gilbride<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 250*b04680f1SMatt Gilbride SUMMARY: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 251*b04680f1SMatt Gilbride<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 252*b04680f1SMatt GilbrideDETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 253*b04680f1SMatt Gilbride</TR> 254*b04680f1SMatt Gilbride</TABLE> 255*b04680f1SMatt Gilbride<A NAME="skip-navbar_bottom"></A> 256*b04680f1SMatt Gilbride<!-- ======== END OF BOTTOM NAVBAR ======= --> 257*b04680f1SMatt Gilbride 258*b04680f1SMatt Gilbride<HR> 259*b04680f1SMatt Gilbride 260*b04680f1SMatt Gilbride</BODY> 261*b04680f1SMatt Gilbride</HTML> 262