Google Git
Sign in
eclipse / gerrit / jsdt / webtools.jsdt.core / 927db86fe692fa2a12cecc04846b9f13e691ecfe / . / docs / org.eclipse.wst.jsdt.doc / html / api_reference / org / eclipse / wst / jsdt / core / refactoring / descriptors / JavaScriptRefactoringDescriptor.html
blob: 0565d831be4f3d429c63ee5766d5f241399e99b5 [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.5.0_12) on Fri May 30 11:16:02 CDT 2008 -->
<TITLE>
JavaScriptRefactoringDescriptor
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.refactoring.descriptors.JavaScriptRefactoringDescriptor class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="JavaScriptRefactoringDescriptor";
}
</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>&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/JavaScriptRefactoringDescriptor.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/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringContribution.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/MoveDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="JavaScriptRefactoringDescriptor.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&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.wst.jsdt.core.refactoring.descriptors</FONT>
<BR>
Class JavaScriptRefactoringDescriptor</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by ">RefactoringDescriptor
<IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.core.refactoring.descriptors.JavaScriptRefactoringDescriptor</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/ChangeMethodSignatureDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">ChangeMethodSignatureDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/ConvertAnonymousDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">ConvertAnonymousDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/ConvertLocalVariableDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">ConvertLocalVariableDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/ConvertMemberTypeDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">ConvertMemberTypeDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/CopyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">CopyDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/DeleteDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">DeleteDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/EncapsulateFieldDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">EncapsulateFieldDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/ExtractConstantDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">ExtractConstantDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/ExtractInterfaceDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">ExtractInterfaceDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/ExtractLocalDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">ExtractLocalDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/ExtractMethodDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">ExtractMethodDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/ExtractSuperclassDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">ExtractSuperclassDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/GeneralizeTypeDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">GeneralizeTypeDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/InferTypeArgumentsDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">InferTypeArgumentsDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/InlineConstantDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">InlineConstantDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/InlineLocalVariableDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">InlineLocalVariableDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/InlineMethodDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">InlineMethodDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/IntroduceFactoryDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">IntroduceFactoryDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/IntroduceIndirectionDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">IntroduceIndirectionDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/IntroduceParameterDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">IntroduceParameterDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/MoveDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">MoveDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/MoveMethodDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">MoveMethodDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/MoveStaticMembersDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">MoveStaticMembersDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/PullUpDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">PullUpDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/PushDownDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">PushDownDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/RenameJavaScriptElementDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">RenameJavaScriptElementDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/RenameLocalVariableDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">RenameLocalVariableDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/RenameResourceDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">RenameResourceDescriptor</A>, <A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/UseSupertypeDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors">UseSupertypeDescriptor</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>JavaScriptRefactoringDescriptor</B><DT>extends RefactoringDescriptor</DL>
</PRE>
<P>
Partial implementation of a java refactoring descriptor.
<p>
This class provides features common to all Java refactorings.
</p>
<p>
Note: this class is not intended to be extended outside the refactoring
framework.
</p>
Provisional API: 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>
<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&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#JAR_MIGRATION">JAR_MIGRATION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant describing the jar migration flag (value: <code>65536</code>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#JAR_REFACTORING">JAR_REFACTORING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant describing the jar refactoring flag (value: <code>524288</code>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#JAR_SOURCE_ATTACHMENT">JAR_SOURCE_ATTACHMENT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant describing the jar source attachment flag (value:
<code>262144</code>).</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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;Refactoring</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#createRefactoring(RefactoringStatus)">createRefactoring</A></B>(RefactoringStatus&nbsp;status)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#setComment(java.lang.String)">setComment</A></B>(java.lang.String&nbsp;comment)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the details comment of this refactoring.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String&nbsp;description)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the description of this refactoring.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#setFlags(int)">setFlags</A></B>(int&nbsp;flags)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the flags of this refactoring.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#setProject(java.lang.String)">setProject</A></B>(java.lang.String&nbsp;project)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the project name of this refactoring.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;RefactoringStatus</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#validateDescriptor()">validateDescriptor</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Validates the refactoring descriptor with respect to the constraints
imposed by the represented refactoring.</TD>
</TR>
</TABLE>
&nbsp;<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>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="JAR_MIGRATION"><!-- --></A><H3>
JAR_MIGRATION</H3>
<PRE>
public static final int <B>JAR_MIGRATION</B></PRE>
<DL>
<DD>Constant describing the jar migration flag (value: <code>65536</code>).
<p>
Clients should set this flag to indicate that the refactoring can be
stored to a JAR file in order to be accessible to the Migrate JAR File
refactoring, regardless whether there is a source attachment to the JAR
file or not. If this flag is set, <code>JAR_REFACTORING</code> should
be set as well.
</p>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#JAR_REFACTORING"><CODE>JAR_REFACTORING</CODE></A>,
<A HREF="../../../../../../../constant-values.html#org.eclipse.wst.jsdt.core.refactoring.descriptors.JavaScriptRefactoringDescriptor.JAR_MIGRATION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="JAR_REFACTORING"><!-- --></A><H3>
JAR_REFACTORING</H3>
<PRE>
public static final int <B>JAR_REFACTORING</B></PRE>
<DL>
<DD>Constant describing the jar refactoring flag (value: <code>524288</code>).
<p>
Clients should set this flag to indicate that the refactoring in
principle can be performed on binary elements originating from a JAR
file. Refactorings which are able to run on binary elements, but require
a correctly configured source attachment to work must set the
<code>JAR_SOURCE_ATTACHMENT</code> flag as well.
</p>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#JAR_SOURCE_ATTACHMENT"><CODE>JAR_SOURCE_ATTACHMENT</CODE></A>,
<A HREF="../../../../../../../constant-values.html#org.eclipse.wst.jsdt.core.refactoring.descriptors.JavaScriptRefactoringDescriptor.JAR_REFACTORING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="JAR_SOURCE_ATTACHMENT"><!-- --></A><H3>
JAR_SOURCE_ATTACHMENT</H3>
<PRE>
public static final int <B>JAR_SOURCE_ATTACHMENT</B></PRE>
<DL>
<DD>Constant describing the jar source attachment flag (value:
<code>262144</code>).
<p>
Clients should set this flag to indicate that the refactoring can be
performed on binary elements originating from a JAR file if and only if
it has a correctly configured source attachment.
</p>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#JAR_REFACTORING"><CODE>JAR_REFACTORING</CODE></A>,
<A HREF="../../../../../../../constant-values.html#org.eclipse.wst.jsdt.core.refactoring.descriptors.JavaScriptRefactoringDescriptor.JAR_SOURCE_ATTACHMENT">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="createRefactoring(RefactoringStatus)"><!-- --></A><H3>
createRefactoring</H3>
<PRE>
public Refactoring <B>createRefactoring</B>(RefactoringStatus&nbsp;status)
throws CoreException</PRE>
<DL>
<DD>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>CoreException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setComment(java.lang.String)"><!-- --></A><H3>
setComment</H3>
<PRE>
public void <B>setComment</B>(java.lang.String&nbsp;comment)</PRE>
<DL>
<DD>Sets the details comment of this refactoring.
<p>
This information is used in the user interface to show additional details
about the performed refactoring. The default is to use no details
comment.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comment</CODE> - the details comment to set, or <code>null</code> to set no
details comment<DT><B>See Also:</B><DD><CODE>#getComment()</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
setDescription</H3>
<PRE>
public void <B>setDescription</B>(java.lang.String&nbsp;description)</PRE>
<DL>
<DD>Sets the description of this refactoring.
<p>
This information is used to label a refactoring in the user interface.
The default is an unspecified, but legal description.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>description</CODE> - the non-empty description of the refactoring to set<DT><B>See Also:</B><DD><CODE>#getDescription()</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setFlags(int)"><!-- --></A><H3>
setFlags</H3>
<PRE>
public void <B>setFlags</B>(int&nbsp;flags)</PRE>
<DL>
<DD>Sets the flags of this refactoring.
<p>
The default is
<code>RefactoringDescriptor.STRUCTURAL_CHANGE | RefactoringDescriptor.MULTI_CHANGE</code>,
unless overridden by a concrete subclass. Clients may use refactoring
flags to indicate special capabilities of Java refactorings.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>flags</CODE> - the flags to set, or <code>RefactoringDescriptor.NONE</code>
to clear the flags<DT><B>See Also:</B><DD><CODE>#getFlags()</CODE>,
<CODE>RefactoringDescriptor#NONE</CODE>,
<CODE>RefactoringDescriptor#STRUCTURAL_CHANGE</CODE>,
<CODE>RefactoringDescriptor#BREAKING_CHANGE</CODE>,
<CODE>RefactoringDescriptor#MULTI_CHANGE</CODE>,
<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#JAR_MIGRATION"><CODE>JAR_MIGRATION</CODE></A>,
<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#JAR_REFACTORING"><CODE>JAR_REFACTORING</CODE></A>,
<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html#JAR_SOURCE_ATTACHMENT"><CODE>JAR_SOURCE_ATTACHMENT</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setProject(java.lang.String)"><!-- --></A><H3>
setProject</H3>
<PRE>
public void <B>setProject</B>(java.lang.String&nbsp;project)</PRE>
<DL>
<DD>Sets the project name of this refactoring.
<p>
The default is to associate the refactoring with the workspace.
Subclasses should call this method with the project name associated with
the refactoring's input elements, if available.
</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>project</CODE> - the non-empty project name to set, or <code>null</code> for
the workspace<DT><B>See Also:</B><DD><CODE>#getProject()</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="validateDescriptor()"><!-- --></A><H3>
validateDescriptor</H3>
<PRE>
public RefactoringStatus <B>validateDescriptor</B>()</PRE>
<DL>
<DD>Validates the refactoring descriptor with respect to the constraints
imposed by the represented refactoring.
<p>
Clients must call this method to verify that all arguments have been
correctly set and that they satisfy the constraints imposed by specific
refactorings. Returning a refactoring status of severity
<CODE>RefactoringStatus#FATAL</CODE> indicates that the refactoring descriptor
cannot be used to create a refactoring instance.
</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a refactoring status describing the outcome of the validation</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/JavaScriptRefactoringDescriptor.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/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringContribution.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../org/eclipse/wst/jsdt/core/refactoring/descriptors/MoveDescriptor.html" title="class in org.eclipse.wst.jsdt.core.refactoring.descriptors"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?org/eclipse/wst/jsdt/core/refactoring/descriptors/JavaScriptRefactoringDescriptor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="JavaScriptRefactoringDescriptor.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&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>