blob: 0d0149dd7a9c8265a66fcd07894f7911a9ae5610 [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.4.2_11) on Tue Jun 13 17:33:13 EDT 2006 -->
<TITLE>
DependencyChecker
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.callisto.tools.versionchecker.DependencyChecker class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="DependencyChecker";
}
</SCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.eclipse.callisto.tools.versionchecker</FONT>
<BR>
Class DependencyChecker</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.eclipse.callisto.tools.versionchecker.DependencyChecker</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>org.eclipse.core.runtime.IPlatformRunnable</DD>
</DL>
<HR>
<DL>
<DT>public class <B>DependencyChecker</B><DT>extends java.lang.Object<DT>implements org.eclipse.core.runtime.IPlatformRunnable</DL>
<P>
A simple, unsupported, little-tested utility to help convert from using
unconstrained pre-req'd bundles, to ones constrained to be within a
certain range.
For example, if a plugin's manifest.mf file specifies
<p>
<code>Require-Bundle: org.eclipse.core.runtime</code>
</p>
<p>
this utility will write
</p>
<p>
<code>Require-Bundle: org.eclipse.core.runtime;bundle-version=&quot;[3.2.0,4.0.0)&quot;</code>
</p>
<p>
or
</p>
<p>
<code>Require-Bundle: org.eclipse.core.runtime;bundle-version=&quot;[3.2.0,3.3.0)&quot;</code>
</p>
<p>
if <i>-conservative</i> is specified. In all case the lower bound is
determined by the version found as this utility actually runs.
</pre>
<p>
Directives:
</p>
<p>
-filter "some regx expression"
</p>
<p>
Will write/check manifest only for those plugins matching regx expression.
</p>
<p>
-conservative
</p>
<p>
Will increment 'minor' code, instead of 'major' code in upper bound of the
range. This is required for those using another plugin's internal (non-API)
methods, and recommended if you do not know for sure you are using
API-only. The default is not-conservative, which increments the major
field.
</p>
<p>
-workspaceRoot "absolute file system path name to workspace"
</p>
<p>
If specified, the manifest.mf files found in the workspace will be
re-written with the results of this tool. Note. The workspace must "match"
the runtime the tool is running in, for this to make any sense. The default
is to simply write the recommended "Require-Bundle:" section the console
log.
</p>
<p>
Note: re-export visibility and optional resolution are maintained "as is"
in output (but other pre-req settings (e.g. vendor?) may be lost. The
intent is to provide "ready for pasting" content, if its happens to work
well for your cases.
</p>
<p>
Example invocation:
</p>
<p>
<pre>
java -jar startup.jar -clean -application org.eclipse.callisto.tools.versionchecker.dependencyChecker
</pre>
</p>
<p>
Example output:
</p>
<pre>
bundle org.eclipse.wst.xml.core
Require-Bundle:
org.eclipse.core.runtime;bundle-version=&quot;[3.2.0,3.3.0)&quot;,
org.eclipse.core.resources;bundle-version=&quot;[3.2.0,3.3.0)&quot;,
org.eclipse.wst.common.uriresolver;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
org.eclipse.wst.sse.core;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
org.eclipse.text;bundle-version=&quot;[3.2.0,3.3.0)&quot;,
org.eclipse.jem.util;resolution:=optional;bundle-version=&quot;[1.2.0,1.3.0)&quot;,
org.eclipse.wst.validation;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
org.eclipse.emf.ecore.edit;resolution:=optional;bundle-version=&quot;[2.2.0,2.3.0)&quot;,
org.eclipse.wst.common.emf;resolution:=optional;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
org.eclipse.emf.ecore.xmi;resolution:=optional;bundle-version=&quot;[2.2.0,2.3.0)&quot;,
org.eclipse.wst.common.emfworkbench.integration;resolution:=optional;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
org.eclipse.wst.common.core;bundle-version=&quot;[1.1.0,1.2.0)&quot;,
com.ibm.icu;bundle-version=&quot;[3.4.4,3.5.0)&quot;,
org.apache.xerces;visibility:=reexport;bundle-version=&quot;[2.8.0,2.9.0)&quot;
</pre>
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.eclipse.core.runtime.IPlatformRunnable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Fields inherited from interface org.eclipse.core.runtime.IPlatformRunnable</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>EXIT_OK, EXIT_RELAUNCH, EXIT_RESTART</CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/eclipse/callisto/tools/versionchecker/DependencyChecker.html#DependencyChecker()">DependencyChecker</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/eclipse/callisto/tools/versionchecker/DependencyChecker.html#run(java.lang.Object)">run</A></B>(java.lang.Object&nbsp;o)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</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 =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="DependencyChecker()"><!-- --></A><H3>
DependencyChecker</H3>
<PRE>
public <B>DependencyChecker</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="run(java.lang.Object)"><!-- --></A><H3>
run</H3>
<PRE>
public java.lang.Object <B>run</B>(java.lang.Object&nbsp;o)
throws java.lang.Exception</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>run</CODE> in interface <CODE>org.eclipse.core.runtime.IPlatformRunnable</CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<HR>
</BODY>
</HTML>