| <!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.6.0_14) on Wed Apr 07 07:58:13 BST 2010 --> |
| <TITLE> |
| IAnnotationBase |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2010-04-07"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IAnnotationBase"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= 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="class-use/IAnnotationBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotation.html" title="interface in org.eclipse.jst.ws.jaxws.utils.annotations"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationInspector.html" title="interface in org.eclipse.jst.ws.jaxws.utils.annotations"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IAnnotationBase.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="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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"> |
| org.eclipse.jst.ws.jaxws.utils.annotations</FONT> |
| <BR> |
| Interface IAnnotationBase<T extends org.eclipse.jdt.core.IJavaElement></H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IAnnotationBase<T extends org.eclipse.jdt.core.IJavaElement></B></DL> |
| </PRE> |
| |
| <P> |
| Base interface representing Annotation and the functionality, required by it. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Plamen Pavlov</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html#COMPLEX_ANNOTATION">COMPLEX_ANNOTATION</A></B></CODE> |
| |
| <BR> |
| complex annotation type ID</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html#SIMPLE_ANNOTATION">SIMPLE_ANNOTATION</A></B></CODE> |
| |
| <BR> |
| simple annotation type ID</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html#SINGLE_ELEMENT_ANNOTATION">SINGLE_ELEMENT_ANNOTATION</A></B></CODE> |
| |
| <BR> |
| single element annotation type ID</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> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html#getAnnotationName()">getAnnotationName</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/ILocator.html" title="interface in org.eclipse.jst.ws.jaxws.utils.annotations">ILocator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html#getLocator()">getLocator</A></B>()</CODE> |
| |
| <BR> |
| Gets the information about location in the source code.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html#getType()">getType</A></B>()</CODE> |
| |
| <BR> |
| Getting the TypeID of current Annotation</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html#remove()">remove</A></B>()</CODE> |
| |
| <BR> |
| Remove the current Annotation from the associated JavaElement.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html#setAppliedElement(T)">setAppliedElement</A></B>(<A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html" title="type parameter in IAnnotationBase">T</A> javaElement)</CODE> |
| |
| <BR> |
| Adds current Annotation to specific IJavaElement.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="SIMPLE_ANNOTATION"><!-- --></A><H3> |
| SIMPLE_ANNOTATION</H3> |
| <PRE> |
| static final int <B>SIMPLE_ANNOTATION</B></PRE> |
| <DL> |
| <DD>simple annotation type ID |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.eclipse.jst.ws.jaxws.utils.annotations.IAnnotationBase.SIMPLE_ANNOTATION">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SINGLE_ELEMENT_ANNOTATION"><!-- --></A><H3> |
| SINGLE_ELEMENT_ANNOTATION</H3> |
| <PRE> |
| static final int <B>SINGLE_ELEMENT_ANNOTATION</B></PRE> |
| <DL> |
| <DD>single element annotation type ID |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.eclipse.jst.ws.jaxws.utils.annotations.IAnnotationBase.SINGLE_ELEMENT_ANNOTATION">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="COMPLEX_ANNOTATION"><!-- --></A><H3> |
| COMPLEX_ANNOTATION</H3> |
| <PRE> |
| static final int <B>COMPLEX_ANNOTATION</B></PRE> |
| <DL> |
| <DD>complex annotation type ID |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.eclipse.jst.ws.jaxws.utils.annotations.IAnnotationBase.COMPLEX_ANNOTATION">Constant Field Values</A></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="getAnnotationName()"><!-- --></A><H3> |
| getAnnotationName</H3> |
| <PRE> |
| java.lang.String <B>getAnnotationName</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>- annotation name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getType()"><!-- --></A><H3> |
| getType</H3> |
| <PRE> |
| int <B>getType</B>()</PRE> |
| <DL> |
| <DD>Getting the TypeID of current Annotation |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Integer value, which represents the Annotation TypeID</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAppliedElement(org.eclipse.jdt.core.IJavaElement)"><!-- --></A><A NAME="setAppliedElement(T)"><!-- --></A><H3> |
| setAppliedElement</H3> |
| <PRE> |
| void <B>setAppliedElement</B>(<A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html" title="type parameter in IAnnotationBase">T</A> javaElement) |
| throws <A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/AnnotationGeneratorException.html" title="class in org.eclipse.jst.ws.jaxws.utils.annotations">AnnotationGeneratorException</A></PRE> |
| <DL> |
| <DD>Adds current Annotation to specific IJavaElement. It is not possible to have IMember as parameter because there is ITypeParameter as parameter when add to TypParameter is executed. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>javaElement</CODE> - |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.NullPointerException</CODE> - if <tt>javaElement</tt> is null. |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - in case <code>javaElement</code> is not of the correct type. Supported types are: IType, IMethod, IField, ITypeParameter. |
| <DD><CODE>AnnotationGeneratorException.</CODE> |
| <DD><CODE><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/AnnotationGeneratorException.html" title="class in org.eclipse.jst.ws.jaxws.utils.annotations">AnnotationGeneratorException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="remove()"><!-- --></A><H3> |
| remove</H3> |
| <PRE> |
| void <B>remove</B>() |
| throws org.eclipse.text.edits.MalformedTreeException, |
| java.io.FileNotFoundException, |
| <A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/AnnotationGeneratorException.html" title="class in org.eclipse.jst.ws.jaxws.utils.annotations">AnnotationGeneratorException</A>, |
| org.eclipse.core.runtime.CoreException, |
| org.eclipse.jface.text.BadLocationException</PRE> |
| <DL> |
| <DD>Remove the current Annotation from the associated JavaElement. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>org.eclipse.jface.text.BadLocationException</CODE> |
| <DD><CODE>org.eclipse.core.runtime.CoreException</CODE> |
| <DD><CODE><A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/AnnotationGeneratorException.html" title="class in org.eclipse.jst.ws.jaxws.utils.annotations">AnnotationGeneratorException</A></CODE> |
| <DD><CODE>java.io.FileNotFoundException</CODE> |
| <DD><CODE>org.eclipse.text.edits.MalformedTreeException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLocator()"><!-- --></A><H3> |
| getLocator</H3> |
| <PRE> |
| <A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/ILocator.html" title="interface in org.eclipse.jst.ws.jaxws.utils.annotations">ILocator</A> <B>getLocator</B>()</PRE> |
| <DL> |
| <DD>Gets the information about location in the source code. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>ILocator</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="class-use/IAnnotationBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotation.html" title="interface in org.eclipse.jst.ws.jaxws.utils.annotations"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../../org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationInspector.html" title="interface in org.eclipse.jst.ws.jaxws.utils.annotations"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../index.html?org/eclipse/jst/ws/jaxws/utils/annotations/IAnnotationBase.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IAnnotationBase.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="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
