blob: e7f092bc2a2e6034c4727bfade5c2f7b116428f5 [file] [log] [blame]
<!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_24) on Sun Apr 03 10:57:50 IST 2011 -->
<TITLE>
IAnnotationAttributeInitializer
</TITLE>
<META NAME="date" CONTENT="2011-04-03">
<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="IAnnotationAttributeInitializer";
}
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IAnnotationAttributeInitializer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/DefaultsAnnotationAttributeInitializer.html" title="class in org.eclipse.jst.ws.annotations.core.initialization"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/eclipse/jst/ws/annotations/core/initialization/IAnnotationAttributeInitializer.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IAnnotationAttributeInitializer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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.annotations.core.initialization</FONT>
<BR>
Interface IAnnotationAttributeInitializer</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/AnnotationAttributeInitializer.html" title="class in org.eclipse.jst.ws.annotations.core.initialization">AnnotationAttributeInitializer</A>, <A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/DefaultsAnnotationAttributeInitializer.html" title="class in org.eclipse.jst.ws.annotations.core.initialization">DefaultsAnnotationAttributeInitializer</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IAnnotationAttributeInitializer</B></DL>
</PRE>
<P>
Base interface for annotation attribute initializers.
<p>
<strong>Provisional API:</strong> This class/interface is part of an interim API that is still under
development and expected to change significantly before reaching stability. It is being made available at
this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses
this API will almost certainly be broken (repeatedly) as the API evolves.
</p>
<P>
<P>
<HR>
<P>
<!-- ========== 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>&nbsp;java.util.List&lt;org.eclipse.jface.text.contentassist.ICompletionProposal&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/IAnnotationAttributeInitializer.html#getCompletionProposalsForMemberValuePair(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.MemberValuePair)">getCompletionProposalsForMemberValuePair</A></B>(org.eclipse.jdt.core.IJavaElement&nbsp;javaElement,
org.eclipse.jdt.core.dom.MemberValuePair&nbsp;memberValuePair)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to provide a list of <CODE>ICompletionProposal</CODE> for a <CODE>MemberValuePair</CODE> value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List&lt;org.eclipse.jface.text.contentassist.ICompletionProposal&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/IAnnotationAttributeInitializer.html#getCompletionProposalsForSingleMemberAnnotation(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.SingleMemberAnnotation)">getCompletionProposalsForSingleMemberAnnotation</A></B>(org.eclipse.jdt.core.IJavaElement&nbsp;javaElement,
org.eclipse.jdt.core.dom.SingleMemberAnnotation&nbsp;singleMemberAnnotation)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to provide a list of <CODE>ICompletionProposal</CODE> for a <CODE>SingleMemberAnnotation</CODE> value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List&lt;org.eclipse.jdt.core.dom.MemberValuePair&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/IAnnotationAttributeInitializer.html#getMemberValuePairs(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.AST, java.lang.Class)">getMemberValuePairs</A></B>(org.eclipse.jdt.core.IJavaElement&nbsp;javaElement,
org.eclipse.jdt.core.dom.AST&nbsp;ast,
java.lang.Class&lt;? extends java.lang.annotation.Annotation&gt;&nbsp;annotationClass)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>as of 1.1 replaced by <A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/IAnnotationAttributeInitializer.html#getMemberValuePairs(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.AST, org.eclipse.jdt.core.IType)"><CODE>getMemberValuePairs(IJavaElement, AST, IType)</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List&lt;org.eclipse.jdt.core.dom.MemberValuePair&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/IAnnotationAttributeInitializer.html#getMemberValuePairs(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.AST, org.eclipse.jdt.core.IType)">getMemberValuePairs</A></B>(org.eclipse.jdt.core.IJavaElement&nbsp;javaElement,
org.eclipse.jdt.core.dom.AST&nbsp;ast,
org.eclipse.jdt.core.IType&nbsp;type)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of <CODE>MemberValuePair</CODE> that may be added to a <CODE>NormalAnnotation</CODE>.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ 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="getMemberValuePairs(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.AST, java.lang.Class)"><!-- --></A><H3>
getMemberValuePairs</H3>
<PRE>
<FONT SIZE="-1">@Deprecated
</FONT>java.util.List&lt;org.eclipse.jdt.core.dom.MemberValuePair&gt; <B>getMemberValuePairs</B>(org.eclipse.jdt.core.IJavaElement&nbsp;javaElement,
org.eclipse.jdt.core.dom.AST&nbsp;ast,
java.lang.Class&lt;? extends java.lang.annotation.Annotation&gt;&nbsp;annotationClass)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>as of 1.1 replaced by <A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/IAnnotationAttributeInitializer.html#getMemberValuePairs(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.AST, org.eclipse.jdt.core.IType)"><CODE>getMemberValuePairs(IJavaElement, AST, IType)</CODE></A></I>
<P>
<DD>Returns a list of <CODE>MemberValuePair</CODE> that may be added to a <CODE>NormalAnnotation</CODE>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>javaElement</CODE> - the java element on which the annotation is declared.<DD><CODE>ast</CODE> - the <code>AST</code> with which to create the member value pairs.<DD><CODE>annotationClass</CODE> - the <CODE>Annotation</CODE> class which may be
used to query the declared members of the annotation type and the members default values.
<DT><B>Returns:</B><DD>a list of member value pairs.</DL>
</DD>
</DL>
<HR>
<A NAME="getMemberValuePairs(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.AST, org.eclipse.jdt.core.IType)"><!-- --></A><H3>
getMemberValuePairs</H3>
<PRE>
java.util.List&lt;org.eclipse.jdt.core.dom.MemberValuePair&gt; <B>getMemberValuePairs</B>(org.eclipse.jdt.core.IJavaElement&nbsp;javaElement,
org.eclipse.jdt.core.dom.AST&nbsp;ast,
org.eclipse.jdt.core.IType&nbsp;type)</PRE>
<DL>
<DD>Returns a list of <CODE>MemberValuePair</CODE> that may be added to a <CODE>NormalAnnotation</CODE>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>javaElement</CODE> - the java element on which the annotation is declared.<DD><CODE>ast</CODE> - the <code>AST</code> with which to create the member value pairs.<DD><CODE>type</CODE> - the <CODE>IType</CODE> which represents an annotation type,.
<DT><B>Returns:</B><DD>a list of member value pairs.<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getCompletionProposalsForMemberValuePair(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.MemberValuePair)"><!-- --></A><H3>
getCompletionProposalsForMemberValuePair</H3>
<PRE>
java.util.List&lt;org.eclipse.jface.text.contentassist.ICompletionProposal&gt; <B>getCompletionProposalsForMemberValuePair</B>(org.eclipse.jdt.core.IJavaElement&nbsp;javaElement,
org.eclipse.jdt.core.dom.MemberValuePair&nbsp;memberValuePair)</PRE>
<DL>
<DD>Used to provide a list of <CODE>ICompletionProposal</CODE> for a <CODE>MemberValuePair</CODE> value.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>javaElement</CODE> - the java element on which the annotation is declared.<DD><CODE>memberValuePair</CODE> - the member value pair in which content assist was invoked.
<DT><B>Returns:</B><DD>a list of completion proposals.</DL>
</DD>
</DL>
<HR>
<A NAME="getCompletionProposalsForSingleMemberAnnotation(org.eclipse.jdt.core.IJavaElement, org.eclipse.jdt.core.dom.SingleMemberAnnotation)"><!-- --></A><H3>
getCompletionProposalsForSingleMemberAnnotation</H3>
<PRE>
java.util.List&lt;org.eclipse.jface.text.contentassist.ICompletionProposal&gt; <B>getCompletionProposalsForSingleMemberAnnotation</B>(org.eclipse.jdt.core.IJavaElement&nbsp;javaElement,
org.eclipse.jdt.core.dom.SingleMemberAnnotation&nbsp;singleMemberAnnotation)</PRE>
<DL>
<DD>Used to provide a list of <CODE>ICompletionProposal</CODE> for a <CODE>SingleMemberAnnotation</CODE> value.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>javaElement</CODE> - the java element on which the annotation is declared.<DD><CODE>singleMemberAnnotation</CODE> - the single member annotation in which content assist was invoked.
<DT><B>Returns:</B><DD>a list of completion proposals.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IAnnotationAttributeInitializer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../../org/eclipse/jst/ws/annotations/core/initialization/DefaultsAnnotationAttributeInitializer.html" title="class in org.eclipse.jst.ws.annotations.core.initialization"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/eclipse/jst/ws/annotations/core/initialization/IAnnotationAttributeInitializer.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IAnnotationAttributeInitializer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>