Gitiles
Code Review Sign In
git.eclipse.org / webtools / webtools.releng / 3bda23c1ea962ff7c7ce8d6c084f1dcabc93f869 / . / org.eclipse.wtp.releng.versionchecker / doc / org / eclipse / wtp / releng / tools / versionchecker / DependencyChecker.html
blob: f0c77367911657be624055d150ecd3874f64ba3f [file] [log] [blame]
david_williamsb23435a2008-07-23 05:02:46 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_11) on Wed Jul 23 00:59:09 EDT 2008 -->
6<TITLE>
7DependencyChecker
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.eclipse.wtp.releng.tools.versionchecker.DependencyChecker class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="DependencyChecker";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DependencyChecker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../org/eclipse/wtp/releng/tools/versionchecker/ClassPathResolver.html" title="class in org.eclipse.wtp.releng.tools.versionchecker"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../org/eclipse/wtp/releng/tools/versionchecker/VersionLister.html" title="class in org.eclipse.wtp.releng.tools.versionchecker"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="DependencyChecker.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.eclipse.wtp.releng.tools.versionchecker</FONT>
85<BR>
86Class DependencyChecker</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.eclipse.wtp.releng.tools.versionchecker.DependencyChecker</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD>org.eclipse.core.runtime.IPlatformRunnable</DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>DependencyChecker</B><DT>extends java.lang.Object<DT>implements org.eclipse.core.runtime.IPlatformRunnable</DL>
97
98<P>
99A simple, unsupported, little-tested utility to help convert from using
100 unconstrained pre-req'd bundles, to ones constrained to be within a certain
101 range.
102
103 For example, if a plugin's manifest.mf file specifies
104
105 <p>
106 <code>Require-Bundle: org.eclipse.core.runtime</code>
107 </p>
108 <p>
109 this utility will write
110 </p>
111 <p>
112 <code>Require-Bundle: org.eclipse.core.runtime;bundle-version=&quot;[3.2.0,4.0.0)&quot;</code>
113 </p>
114 <p>
115 or
116 </p>
117 <p>
118 <code>Require-Bundle: org.eclipse.core.runtime;bundle-version=&quot;[3.2.0,3.3.0)&quot;</code>
119 </p>
120 <p>
121 if <i>-conservative</i> is specified. In all case the lower bound is
122 determined by the version found as this utility actually runs.
123
124 </pre>
125
126 <p>
127 Directives:
128 </p>
129 <p>
130 -filter "some regx expression"
131 </p>
132 <p>
133 Will write/check manifest only for those plugins matching regx expression.
134 </p>
135 <p>
136 -conservative
137 </p>
138 <p>
139 Will increment 'minor' code, instead of 'major' code in upper bound of the
140 range. This is required for those using another plugin's internal (non-API)
141 methods, and recommended if you do not know for sure you are using
142 API-only. The default is not-conservative, which increments the major
143 field.
144 </p>
145 <p>
146 -workspaceRoot "absolute file system path name to workspace"
147 </p>
148 <p>
149 If specified, the manifest.mf files found in the workspace will be
150 re-written with the results of this tool. Note. The workspace must "match"
151 the runtime the tool is running in, for this to make any sense. The default
152 is to simply write the recommended "Require-Bundle:" section the console
153 log.
154 </p>
155 <p>
156 Note: re-export visibility and optional resolution are maintained "as is"
157 in output (but other pre-req settings (e.g. vendor?) may be lost. The
158 intent is to provide "ready for pasting" content, if its happens to work
159 well for your cases.
160 </p>
161 <p>
162 Example invocation:
163 </p>
164 <p>
165
166 <pre>
167
168 java -jar startup.jar -clean -application
169 org.eclipse.wtp.releng.versionchecker.dependencyChecker
170
171 </pre>
172
173 </p>
174
175 <p>
176 Example output:
177 </p>
178
179 <pre>
180
181 bundle org.eclipse.wst.xml.core Require-Bundle:
182 org.eclipse.core.runtime;bundle-version=&quot;[3.2.0,3.3.0)&quot;,
183 org.eclipse.core.resources;bundle-version=&quot;[3.2.0,3.3.0)&quot;,
184 org.eclipse.wst.common.uriresolver;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
185 org.eclipse.wst.sse.core;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
186 org.eclipse.text;bundle-version=&quot;[3.2.0,3.3.0)&quot;,
187 org.eclipse.jem.util;resolution:=optional;bundle-version=&quot;[1.2.0,1.3.0)&quot;,
188 org.eclipse.wst.validation;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
189 org.eclipse.emf.ecore.edit;resolution:=optional;bundle-version=&quot;[2.2.0,2.3.0)&quot;,
190 org.eclipse.wst.common.emf;resolution:=optional;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
191 org.eclipse.emf.ecore.xmi;resolution:=optional;bundle-version=&quot;[2.2.0,2.3.0)&quot;,
192 org.eclipse.wst.common.emfworkbench.integration;resolution:=optional;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
193 org.eclipse.wst.common.core;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
194 com.ibm.icu;bundle-version=&quot;[3.4.4,3.5.0)&quot;,
195 org.apache.xerces;visibility:=reexport;bundle-version=&quot;[2.8.0,2.9.0)&quot;
196
197 </pre>
198<P>
199
200<P>
201<HR>
202
203<P>
204<!-- ======== NESTED CLASS SUMMARY ======== -->
205
206
207<!-- =========== FIELD SUMMARY =========== -->
208
209<A NAME="field_summary"><!-- --></A>
210<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
211<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
212<TD COLSPAN=2><FONT SIZE="+2">
213<B>Field Summary</B></FONT></TD>
214</TR>
215</TABLE>
216&nbsp;<A NAME="fields_inherited_from_class_org.eclipse.core.runtime.IPlatformRunnable"><!-- --></A>
217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
218<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
219<TD><B>Fields inherited from interface org.eclipse.core.runtime.IPlatformRunnable</B></TD>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD><CODE>EXIT_OK, EXIT_RELAUNCH, EXIT_RESTART</CODE></TD>
223</TR>
224</TABLE>
225&nbsp;
226<!-- ======== CONSTRUCTOR SUMMARY ======== -->
227
228<A NAME="constructor_summary"><!-- --></A>
229<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
230<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
231<TD COLSPAN=2><FONT SIZE="+2">
232<B>Constructor Summary</B></FONT></TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD><CODE><B><A HREF="../../../../../../org/eclipse/wtp/releng/tools/versionchecker/DependencyChecker.html#DependencyChecker()">DependencyChecker</A></B>()</CODE>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
239</TR>
240</TABLE>
241&nbsp;
242<!-- ========== METHOD SUMMARY =========== -->
243
244<A NAME="method_summary"><!-- --></A>
245<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
246<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
247<TD COLSPAN=2><FONT SIZE="+2">
248<B>Method Summary</B></FONT></TD>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
253<TD><CODE><B><A HREF="../../../../../../org/eclipse/wtp/releng/tools/versionchecker/DependencyChecker.html#run(java.lang.Object)">run</A></B>(java.lang.Object&nbsp;o)</CODE>
254
255<BR>
256&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
257</TR>
258</TABLE>
259&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
260<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
261<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
262<TD><B>Methods inherited from class java.lang.Object</B></TD>
263</TR>
264<TR BGCOLOR="white" CLASS="TableRowColor">
265<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
266</TR>
267</TABLE>
268&nbsp;
269<P>
270
271<!-- ============ FIELD DETAIL =========== -->
272
273
274<!-- ========= CONSTRUCTOR DETAIL ======== -->
275
276<A NAME="constructor_detail"><!-- --></A>
277<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
278<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
279<TD COLSPAN=1><FONT SIZE="+2">
280<B>Constructor Detail</B></FONT></TD>
281</TR>
282</TABLE>
283
284<A NAME="DependencyChecker()"><!-- --></A><H3>
285DependencyChecker</H3>
286<PRE>
287public <B>DependencyChecker</B>()</PRE>
288<DL>
289</DL>
290
291<!-- ============ METHOD DETAIL ========== -->
292
293<A NAME="method_detail"><!-- --></A>
294<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
295<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
296<TD COLSPAN=1><FONT SIZE="+2">
297<B>Method Detail</B></FONT></TD>
298</TR>
299</TABLE>
300
301<A NAME="run(java.lang.Object)"><!-- --></A><H3>
302run</H3>
303<PRE>
304public java.lang.Object <B>run</B>(java.lang.Object&nbsp;o)
305 throws java.lang.Exception</PRE>
306<DL>
307<DD><DL>
308<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>org.eclipse.core.runtime.IPlatformRunnable</CODE></DL>
309</DD>
310<DD><DL>
311
312<DT><B>Throws:</B>
313<DD><CODE>java.lang.Exception</CODE></DL>
314</DD>
315</DL>
316<!-- ========= END OF CLASS DATA ========= -->
317<HR>
318
319
320<!-- ======= START OF BOTTOM NAVBAR ====== -->
321<A NAME="navbar_bottom"><!-- --></A>
322<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
323<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
324<TR>
325<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
326<A NAME="navbar_bottom_firstrow"><!-- --></A>
327<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
328 <TR ALIGN="center" VALIGN="top">
329 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
330 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
331 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DependencyChecker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
332 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
333 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
334 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
335 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
336 </TR>
337</TABLE>
338</TD>
339<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
340</EM>
341</TD>
342</TR>
343
344<TR>
345<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
346&nbsp;<A HREF="../../../../../../org/eclipse/wtp/releng/tools/versionchecker/ClassPathResolver.html" title="class in org.eclipse.wtp.releng.tools.versionchecker"><B>PREV CLASS</B></A>&nbsp;
347&nbsp;<A HREF="../../../../../../org/eclipse/wtp/releng/tools/versionchecker/VersionLister.html" title="class in org.eclipse.wtp.releng.tools.versionchecker"><B>NEXT CLASS</B></A></FONT></TD>
348<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
349 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
350&nbsp;<A HREF="DependencyChecker.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
351&nbsp;<SCRIPT type="text/javascript">
352 <!--
353 if(window==top) {
354 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
355 }
356 //-->
357</SCRIPT>
358<NOSCRIPT>
359 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
360</NOSCRIPT>
361
362</FONT></TD>
363</TR>
364<TR>
365<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
366 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
367<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
368DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
369</TR>
370</TABLE>
371<A NAME="skip-navbar_bottom"></A>
372<!-- ======== END OF BOTTOM NAVBAR ======= -->
373
374<HR>
375
376</BODY>
377</HTML>