blob: cc4411d179ee260a25bb766abf8742e332e31252 [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_22) on Fri Jan 21 21:46:59 GMT 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
VersionRange (Apache Aries Application API 0.3-SNAPSHOT API)
</TITLE>
<META NAME="date" CONTENT="2011-01-21">
<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="VersionRange (Apache Aries Application API 0.3-SNAPSHOT API)";
}
}
</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/VersionRange.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-all.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/apache/aries/application/ServiceDeclaration.html" title="interface in org.apache.aries.application"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/aries/application/VersionRange.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="VersionRange.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.apache.aries.application</FONT>
<BR>
Interface VersionRange</H2>
<HR>
<DL>
<DT><PRE>public interface <B>VersionRange</B></DL>
</PRE>
<P>
A representation of a Version Range. See <a href="http://www.osgi.org/Release4/HomePage">
section 3.2.6</a> of the OSGi Service Platform Core Specification.
<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;<A HREF="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html?is-external=true" title="class or interface in org.osgi.framework">Version</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/aries/application/VersionRange.html#getExactVersion()">getExactVersion</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this method returns the exact version from the versionInfo obj.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html?is-external=true" title="class or interface in org.osgi.framework">Version</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/aries/application/VersionRange.html#getMaximumVersion()">getMaximumVersion</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the maximum version</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html?is-external=true" title="class or interface in org.osgi.framework">Version</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/aries/application/VersionRange.html#getMinimumVersion()">getMinimumVersion</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the minimum version</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/aries/application/VersionRange.html" title="interface in org.apache.aries.application">VersionRange</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/aries/application/VersionRange.html#intersect(org.apache.aries.application.VersionRange)">intersect</A></B>(<A HREF="../../../../org/apache/aries/application/VersionRange.html" title="interface in org.apache.aries.application">VersionRange</A>&nbsp;range)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new version range that is the intersection of <code>this</code> and the argument.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/aries/application/VersionRange.html#isExactVersion()">isExactVersion</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;check if the versioninfo is the exact version</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/aries/application/VersionRange.html#isMaximumExclusive()">isMaximumExclusive</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;is the maximum version exclusive</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/aries/application/VersionRange.html#isMaximumUnbounded()">isMaximumUnbounded</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;is the maximum version unbounded</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/aries/application/VersionRange.html#isMinimumExclusive()">isMinimumExclusive</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;is the minimum version exclusive</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/aries/application/VersionRange.html#matches(org.osgi.framework.Version)">matches</A></B>(<A HREF="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html?is-external=true" title="class or interface in org.osgi.framework">Version</A>&nbsp;version)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method tests to see if the provided version is inside this range.</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="getExactVersion()"><!-- --></A><H3>
getExactVersion</H3>
<PRE>
<A HREF="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html?is-external=true" title="class or interface in org.osgi.framework">Version</A> <B>getExactVersion</B>()</PRE>
<DL>
<DD>this method returns the exact version from the versionInfo obj.
this is used for DeploymentContent only to return a valid exact version
otherwise, null is returned.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the exact version</DL>
</DD>
</DL>
<HR>
<A NAME="getMaximumVersion()"><!-- --></A><H3>
getMaximumVersion</H3>
<PRE>
<A HREF="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html?is-external=true" title="class or interface in org.osgi.framework">Version</A> <B>getMaximumVersion</B>()</PRE>
<DL>
<DD>get the maximum version
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the maximum version</DL>
</DD>
</DL>
<HR>
<A NAME="getMinimumVersion()"><!-- --></A><H3>
getMinimumVersion</H3>
<PRE>
<A HREF="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html?is-external=true" title="class or interface in org.osgi.framework">Version</A> <B>getMinimumVersion</B>()</PRE>
<DL>
<DD>get the minimum version
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the minimum version</DL>
</DD>
</DL>
<HR>
<A NAME="isMaximumExclusive()"><!-- --></A><H3>
isMaximumExclusive</H3>
<PRE>
boolean <B>isMaximumExclusive</B>()</PRE>
<DL>
<DD>is the maximum version exclusive
<P>
<DD><DL>
<DT><B>Returns:</B><DD>is the max version in the range.</DL>
</DD>
</DL>
<HR>
<A NAME="isMaximumUnbounded()"><!-- --></A><H3>
isMaximumUnbounded</H3>
<PRE>
boolean <B>isMaximumUnbounded</B>()</PRE>
<DL>
<DD>is the maximum version unbounded
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if no upper bound was specified.</DL>
</DD>
</DL>
<HR>
<A NAME="isMinimumExclusive()"><!-- --></A><H3>
isMinimumExclusive</H3>
<PRE>
boolean <B>isMinimumExclusive</B>()</PRE>
<DL>
<DD>is the minimum version exclusive
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the min version is in range.</DL>
</DD>
</DL>
<HR>
<A NAME="isExactVersion()"><!-- --></A><H3>
isExactVersion</H3>
<PRE>
boolean <B>isExactVersion</B>()</PRE>
<DL>
<DD>check if the versioninfo is the exact version
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the range will match 1 exact version.</DL>
</DD>
</DL>
<HR>
<A NAME="matches(org.osgi.framework.Version)"><!-- --></A><H3>
matches</H3>
<PRE>
boolean <B>matches</B>(<A HREF="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html?is-external=true" title="class or interface in org.osgi.framework">Version</A>&nbsp;version)</PRE>
<DL>
<DD>This method tests to see if the provided version is inside this range.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>version</CODE> - the version to test.
<DT><B>Returns:</B><DD>true if the version matches, false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="intersect(org.apache.aries.application.VersionRange)"><!-- --></A><H3>
intersect</H3>
<PRE>
<A HREF="../../../../org/apache/aries/application/VersionRange.html" title="interface in org.apache.aries.application">VersionRange</A> <B>intersect</B>(<A HREF="../../../../org/apache/aries/application/VersionRange.html" title="interface in org.apache.aries.application">VersionRange</A>&nbsp;range)</PRE>
<DL>
<DD>Create a new version range that is the intersection of <code>this</code> and the argument.
In other words, the largest version range that lies within both <code>this</code> and
the parameter.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>range</CODE> - a version range to be intersected with <code>this</code>.
<DT><B>Returns:</B><DD>a new version range, or <code>null</code> if no intersection is possible.</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/VersionRange.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-all.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/apache/aries/application/ServiceDeclaration.html" title="interface in org.apache.aries.application"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/aries/application/VersionRange.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="VersionRange.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>
Copyright &#169; 2009-2011 <a href="http://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>