diff options
Diffstat (limited to 'javadoc/cpw/mods/fml/common/versioning/VersionRange.html')
| -rw-r--r-- | javadoc/cpw/mods/fml/common/versioning/VersionRange.html | 479 |
1 files changed, 479 insertions, 0 deletions
diff --git a/javadoc/cpw/mods/fml/common/versioning/VersionRange.html b/javadoc/cpw/mods/fml/common/versioning/VersionRange.html new file mode 100644 index 0000000..c6600c1 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/versioning/VersionRange.html @@ -0,0 +1,479 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Feb 05 20:10:18 EST 2015 --> +<title>VersionRange (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="VersionRange (Forge API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../cpw/mods/fml/common/versioning/VersionParser.html" title="class in cpw.mods.fml.common.versioning"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?cpw/mods/fml/common/versioning/VersionRange.html" target="_top">Frames</a></li> +<li><a href="VersionRange.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">cpw.mods.fml.common.versioning</div> +<h2 title="Class VersionRange" class="title">Class VersionRange</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>cpw.mods.fml.common.versioning.VersionRange</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">VersionRange</span> +extends java.lang.Object</pre> +<div class="block">Construct a version range from a specification.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#cloneOf()">cloneOf</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#containsVersion(cpw.mods.fml.common.versioning.ArtifactVersion)">containsVersion</a></strong>(<a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a> version)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#createFromVersion(java.lang.String,%20cpw.mods.fml.common.versioning.ArtifactVersion)">createFromVersion</a></strong>(java.lang.String version, + <a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a> existing)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#createFromVersionSpec(java.lang.String)">createFromVersionSpec</a></strong>(java.lang.String spec)</code> +<div class="block">Create a version range from a string representation + <p/> + Some spec examples are + + <code>1.0</code> Version 1.0 + <code>[1.0,2.0)</code> Versions 1.0 (included) to 2.0 (not included) + <code>[1.0,2.0]</code> Versions 1.0 to 2.0 (both included) + <code>[1.5,)</code> Versions 1.5 and higher + <code>(,1.0],[1.2,)</code> Versions up to 1.0 (included) and 1.2 or higher + </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#getLowerBoundString()">getLowerBoundString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#getRecommendedVersion()">getRecommendedVersion</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../cpw/mods/fml/common/versioning/Restriction.html" title="class in cpw.mods.fml.common.versioning">Restriction</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#getRestrictions()">getRestrictions</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#hasRestrictions()">hasRestrictions</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#isUnboundedAbove()">isUnboundedAbove</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#matchVersion(java.util.List)">matchVersion</a></strong>(java.util.List<<a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a>> versions)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#newRange(cpw.mods.fml.common.versioning.ArtifactVersion,%20java.util.List)">newRange</a></strong>(<a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a> version, + java.util.List<<a href="../../../../../cpw/mods/fml/common/versioning/Restriction.html" title="class in cpw.mods.fml.common.versioning">Restriction</a>> restrictions)</code> +<div class="block">Factory method, for custom versioning schemes</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#restrict(cpw.mods.fml.common.versioning.VersionRange)">restrict</a></strong>(<a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a> restriction)</code> +<div class="block">Creates and returns a new <code>VersionRange</code> that is a restriction of this + version range and the specified version range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getRecommendedVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRecommendedVersion</h4> +<pre>public <a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a> getRecommendedVersion()</pre> +</li> +</ul> +<a name="getRestrictions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRestrictions</h4> +<pre>public java.util.List<<a href="../../../../../cpw/mods/fml/common/versioning/Restriction.html" title="class in cpw.mods.fml.common.versioning">Restriction</a>> getRestrictions()</pre> +</li> +</ul> +<a name="cloneOf()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cloneOf</h4> +<pre>public <a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a> cloneOf()</pre> +</li> +</ul> +<a name="newRange(cpw.mods.fml.common.versioning.ArtifactVersion, java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newRange</h4> +<pre>public static <a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a> newRange(<a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a> version, + java.util.List<<a href="../../../../../cpw/mods/fml/common/versioning/Restriction.html" title="class in cpw.mods.fml.common.versioning">Restriction</a>> restrictions)</pre> +<div class="block">Factory method, for custom versioning schemes</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>version</code> - version</dd><dd><code>restrictions</code> - restriction list</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new version range</dd></dl> +</li> +</ul> +<a name="createFromVersionSpec(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFromVersionSpec</h4> +<pre>public static <a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a> createFromVersionSpec(java.lang.String spec) + throws <a href="../../../../../cpw/mods/fml/common/versioning/InvalidVersionSpecificationException.html" title="class in cpw.mods.fml.common.versioning">InvalidVersionSpecificationException</a></pre> +<div class="block">Create a version range from a string representation + <p/> + Some spec examples are + <ul> + <li><code>1.0</code> Version 1.0</li> + <li><code>[1.0,2.0)</code> Versions 1.0 (included) to 2.0 (not included)</li> + <li><code>[1.0,2.0]</code> Versions 1.0 to 2.0 (both included)</li> + <li><code>[1.5,)</code> Versions 1.5 and higher</li> + <li><code>(,1.0],[1.2,)</code> Versions up to 1.0 (included) and 1.2 or higher</li> + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>spec</code> - string representation of a version or version range</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new <a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning"><code>VersionRange</code></a> object that represents the spec</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../cpw/mods/fml/common/versioning/InvalidVersionSpecificationException.html" title="class in cpw.mods.fml.common.versioning">InvalidVersionSpecificationException</a></code></dd></dl> +</li> +</ul> +<a name="createFromVersion(java.lang.String, cpw.mods.fml.common.versioning.ArtifactVersion)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFromVersion</h4> +<pre>public static <a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a> createFromVersion(java.lang.String version, + <a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a> existing)</pre> +</li> +</ul> +<a name="restrict(cpw.mods.fml.common.versioning.VersionRange)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>restrict</h4> +<pre>public <a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a> restrict(<a href="../../../../../cpw/mods/fml/common/versioning/VersionRange.html" title="class in cpw.mods.fml.common.versioning">VersionRange</a> restriction)</pre> +<div class="block">Creates and returns a new <code>VersionRange</code> that is a restriction of this + version range and the specified version range. + <p> + Note: Precedence is given to the recommended version from this version range over the + recommended version from the specified version range. + </p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>restriction</code> - the <code>VersionRange</code> that will be used to restrict this version + range.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the <code>VersionRange</code> that is a restriction of this version range and the + specified version range. + <p> + The restrictions of the returned version range will be an intersection of the restrictions + of this version range and the specified version range if both version ranges have + restrictions. Otherwise, the restrictions on the returned range will be empty. + </p> + <p> + The recommended version of the returned version range will be the recommended version of + this version range, provided that ranges falls within the intersected restrictions. If + the restrictions are empty, this version range's recommended version is used if it is not + <code>null</code>. If it is <code>null</code>, the specified version range's recommended + version is used (provided it is non-<code>null</code>). If no recommended version can be + obtained, the returned version range's recommended version is set to <code>null</code>. + </p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if the specified <code>VersionRange</code> is + <code>null</code>.</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="matchVersion(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>matchVersion</h4> +<pre>public <a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a> matchVersion(java.util.List<<a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a>> versions)</pre> +</li> +</ul> +<a name="containsVersion(cpw.mods.fml.common.versioning.ArtifactVersion)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsVersion</h4> +<pre>public boolean containsVersion(<a href="../../../../../cpw/mods/fml/common/versioning/ArtifactVersion.html" title="interface in cpw.mods.fml.common.versioning">ArtifactVersion</a> version)</pre> +</li> +</ul> +<a name="hasRestrictions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasRestrictions</h4> +<pre>public boolean hasRestrictions()</pre> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="isUnboundedAbove()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUnboundedAbove</h4> +<pre>public boolean isUnboundedAbove()</pre> +</li> +</ul> +<a name="getLowerBoundString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLowerBoundString</h4> +<pre>public java.lang.String getLowerBoundString()</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../cpw/mods/fml/common/versioning/VersionParser.html" title="class in cpw.mods.fml.common.versioning"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?cpw/mods/fml/common/versioning/VersionRange.html" target="_top">Frames</a></li> +<li><a href="VersionRange.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |