diff options
Diffstat (limited to 'doc/org/unitConverter/unit/BaseUnit.html')
| -rw-r--r-- | doc/org/unitConverter/unit/BaseUnit.html | 452 |
1 files changed, 452 insertions, 0 deletions
diff --git a/doc/org/unitConverter/unit/BaseUnit.html b/doc/org/unitConverter/unit/BaseUnit.html new file mode 100644 index 0000000..56fb19c --- /dev/null +++ b/doc/org/unitConverter/unit/BaseUnit.html @@ -0,0 +1,452 @@ +<!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 (1.8.0_232) on Tue Dec 24 16:10:16 EST 2019 --> +<title>BaseUnit</title> +<meta name="date" content="2019-12-24"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BaseUnit"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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="class-use/BaseUnit.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/unitConverter/unit/BaseDimension.html" title="class in org.unitConverter.unit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/unitConverter/unit/BritishImperial.html" title="class in org.unitConverter.unit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/unitConverter/unit/BaseUnit.html" target="_top">Frames</a></li> +<li><a href="BaseUnit.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">org.unitConverter.unit</div> +<h2 title="Class BaseUnit" class="title">Class BaseUnit</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">org.unitConverter.unit.Unit</a></li> +<li> +<ul class="inheritance"> +<li>org.unitConverter.unit.BaseUnit</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">BaseUnit</span> +extends <a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></pre> +<div class="block">A unit that other units are defined by. + <p> + Note that BaseUnits <b>must</b> have names and symbols. This is because they are used for toString code. Therefore, + the Optionals provided by <a href="../../../org/unitConverter/unit/Unit.html#getPrimaryName--"><code>Unit.getPrimaryName()</code></a> and <a href="../../../org/unitConverter/unit/Unit.html#getSymbol--"><code>Unit.getSymbol()</code></a> will always contain a value.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Adrien Hopkins</dd> +</dl> +</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/BaseUnit.html#asLinearUnit--">asLinearUnit</a></span>()</code> +<div class="block">Returns a <code>LinearUnit</code> with this unit as a base and a conversion factor of 1.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/BaseUnit.html#convertFromBase-double-">convertFromBase</a></span>(double value)</code> +<div class="block">Converts from a value expressed in this unit's base unit to a value expressed in this unit.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/BaseUnit.html#convertToBase-double-">convertToBase</a></span>(double value)</code> +<div class="block">Converts from a value expressed in this unit to a value expressed in this unit's base unit.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/unitConverter/unit/BaseDimension.html" title="class in org.unitConverter.unit">BaseDimension</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/BaseUnit.html#getBaseDimension--">getBaseDimension</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/BaseUnit.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/BaseUnit.html#valueOf-org.unitConverter.unit.BaseDimension-java.lang.String-java.lang.String-">valueOf</a></span>(<a href="../../../org/unitConverter/unit/BaseDimension.html" title="class in org.unitConverter.unit">BaseDimension</a> dimension, + java.lang.String name, + java.lang.String symbol)</code> +<div class="block">Gets a base unit from the dimension it measures, its name and its symbol.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/BaseUnit.html#valueOf-org.unitConverter.unit.BaseDimension-java.lang.String-java.lang.String-java.util.Set-">valueOf</a></span>(<a href="../../../org/unitConverter/unit/BaseDimension.html" title="class in org.unitConverter.unit">BaseDimension</a> dimension, + java.lang.String name, + java.lang.String symbol, + java.util.Set<java.lang.String> otherNames)</code> +<div class="block">Gets a base unit from the dimension it measures, its name and its symbol.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/BaseUnit.html#withName-org.unitConverter.unit.NameSymbol-">withName</a></span>(<a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.unitConverter.unit.Unit"> +<!-- --> +</a> +<h3>Methods inherited from class org.unitConverter.unit.<a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></h3> +<code><a href="../../../org/unitConverter/unit/Unit.html#canConvertTo-org.unitConverter.unit.Unit-">canConvertTo</a>, <a href="../../../org/unitConverter/unit/Unit.html#convertTo-org.unitConverter.unit.Unit-double-">convertTo</a>, <a href="../../../org/unitConverter/unit/Unit.html#fromConversionFunctions-org.unitConverter.math.ObjectProduct-java.util.function.DoubleUnaryOperator-java.util.function.DoubleUnaryOperator-">fromConversionFunctions</a>, <a href="../../../org/unitConverter/unit/Unit.html#fromConversionFunctions-org.unitConverter.math.ObjectProduct-java.util.function.DoubleUnaryOperator-java.util.function.DoubleUnaryOperator-org.unitConverter.unit.NameSymbol-">fromConversionFunctions</a>, <a href="../../../org/unitConverter/unit/Unit.html#getBase--">getBase</a>, <a href="../../../org/unitConverter/unit/Unit.html#getDimension--">getDimension</a>, <a href="../../../org/unitConverter/unit/Unit.html#getOtherNames--">getOtherNames</a>, <a href="../../../org/unitConverter/unit/Unit.html#getPrimaryName--">getPrimaryName</a>, <a href="../../../org/unitConverter/unit/Unit.html#getSymbol--">getSymbol</a></code></li> +</ul> +<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, equals, finalize, getClass, hashCode, 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="valueOf-org.unitConverter.unit.BaseDimension-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a> valueOf(<a href="../../../org/unitConverter/unit/BaseDimension.html" title="class in org.unitConverter.unit">BaseDimension</a> dimension, + java.lang.String name, + java.lang.String symbol)</pre> +<div class="block">Gets a base unit from the dimension it measures, its name and its symbol.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dimension</code> - dimension measured by this unit</dd> +<dd><code>name</code> - name of unit</dd> +<dd><code>symbol</code> - symbol of unit</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>base unit</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</dd> +</dl> +</li> +</ul> +<a name="valueOf-org.unitConverter.unit.BaseDimension-java.lang.String-java.lang.String-java.util.Set-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a> valueOf(<a href="../../../org/unitConverter/unit/BaseDimension.html" title="class in org.unitConverter.unit">BaseDimension</a> dimension, + java.lang.String name, + java.lang.String symbol, + java.util.Set<java.lang.String> otherNames)</pre> +<div class="block">Gets a base unit from the dimension it measures, its name and its symbol.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dimension</code> - dimension measured by this unit</dd> +<dd><code>name</code> - name of unit</dd> +<dd><code>symbol</code> - symbol of unit</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>base unit</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-21</dd> +</dl> +</li> +</ul> +<a name="asLinearUnit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asLinearUnit</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> asLinearUnit()</pre> +<div class="block">Returns a <code>LinearUnit</code> with this unit as a base and a conversion factor of 1. This operation must be done + in order to allow units to be created with operations.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this unit as a <code>LinearUnit</code></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</dd> +</dl> +</li> +</ul> +<a name="convertFromBase-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertFromBase</h4> +<pre>public double convertFromBase(double value)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../org/unitConverter/unit/Unit.html#convertFromBase-double-">Unit</a></code></span></div> +<div class="block">Converts from a value expressed in this unit's base unit to a value expressed in this unit. + <p> + This must be the inverse of <code>convertToBase</code>, so <code>convertFromBase(convertToBase(value))</code> must be equal + to <code>value</code> for any value, ignoring precision loss by roundoff error. + </p> + <p> + If this unit <i>is</i> a base unit, this method should return <code>value</code>. + </p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/unitConverter/unit/Unit.html#convertFromBase-double-">convertFromBase</a></code> in class <code><a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - value expressed in <b>base</b> unit</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value expressed in <b>this</b> unit</dd> +</dl> +</li> +</ul> +<a name="convertToBase-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertToBase</h4> +<pre>public double convertToBase(double value)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../org/unitConverter/unit/Unit.html#convertToBase-double-">Unit</a></code></span></div> +<div class="block">Converts from a value expressed in this unit to a value expressed in this unit's base unit. + <p> + This must be the inverse of <code>convertFromBase</code>, so <code>convertToBase(convertFromBase(value))</code> must be + equal to <code>value</code> for any value, ignoring precision loss by roundoff error. + </p> + <p> + If this unit <i>is</i> a base unit, this method should return <code>value</code>. + </p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/unitConverter/unit/Unit.html#convertToBase-double-">convertToBase</a></code> in class <code><a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - value expressed in <b>this</b> unit</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value expressed in <b>base</b> unit</dd> +</dl> +</li> +</ul> +<a name="getBaseDimension--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBaseDimension</h4> +<pre>public final <a href="../../../org/unitConverter/unit/BaseDimension.html" title="class in org.unitConverter.unit">BaseDimension</a> getBaseDimension()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>dimension</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</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><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../org/unitConverter/unit/Unit.html#toString--">toString</a></code> in class <code><a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></code></dd> +</dl> +</li> +</ul> +<a name="withName-org.unitConverter.unit.NameSymbol-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>withName</h4> +<pre>public <a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a> withName(<a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../org/unitConverter/unit/Unit.html#withName-org.unitConverter.unit.NameSymbol-">withName</a></code> in class <code><a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>ns</code> - name(s) and symbol to use</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a copy of this unit with provided name(s) and symbol</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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="class-use/BaseUnit.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/unitConverter/unit/BaseDimension.html" title="class in org.unitConverter.unit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/unitConverter/unit/BritishImperial.html" title="class in org.unitConverter.unit"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/unitConverter/unit/BaseUnit.html" target="_top">Frames</a></li> +<li><a href="BaseUnit.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> |