diff options
Diffstat (limited to 'doc/org/unitConverter/unit/Unit.html')
| -rw-r--r-- | doc/org/unitConverter/unit/Unit.html | 632 |
1 files changed, 632 insertions, 0 deletions
diff --git a/doc/org/unitConverter/unit/Unit.html b/doc/org/unitConverter/unit/Unit.html new file mode 100644 index 0000000..2a84bfa --- /dev/null +++ b/doc/org/unitConverter/unit/Unit.html @@ -0,0 +1,632 @@ +<!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>Unit</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="Unit"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":6,"i2":10,"i3":6,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Unit.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/SI.Dimensions.html" title="class in org.unitConverter.unit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/unitConverter/unit/UnitDatabase.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/Unit.html" target="_top">Frames</a></li> +<li><a href="Unit.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 Unit" class="title">Class Unit</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.unitConverter.unit.Unit</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>, <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">Unit</span> +extends java.lang.Object</pre> +<div class="block">A unit that is composed of base units.</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"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.html#Unit-org.unitConverter.math.ObjectProduct-org.unitConverter.unit.NameSymbol-">Unit</a></span>(<a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> unitBase, + <a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</code> +<div class="block">Creates the <code>AbstractUnit</code>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.html#canConvertTo-org.unitConverter.unit.Unit-">canConvertTo</a></span>(<a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> other)</code> +<div class="block">Checks if a value expressed in this unit can be converted to a value expressed in <code>other</code></div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected abstract double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.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/Unit.html#convertTo-org.unitConverter.unit.Unit-double-">convertTo</a></span>(<a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> other, + double value)</code> +<div class="block">Converts a value expressed in this unit to a value expressed in <code>other</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>protected abstract double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.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="i4" class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.html#fromConversionFunctions-org.unitConverter.math.ObjectProduct-java.util.function.DoubleUnaryOperator-java.util.function.DoubleUnaryOperator-">fromConversionFunctions</a></span>(<a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> base, + java.util.function.DoubleUnaryOperator converterFrom, + java.util.function.DoubleUnaryOperator converterTo)</code> +<div class="block">Returns a unit from its base and the functions it uses to convert to and from its base.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><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></span>(<a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> base, + java.util.function.DoubleUnaryOperator converterFrom, + java.util.function.DoubleUnaryOperator converterTo, + <a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</code> +<div class="block">Returns a unit from its base and the functions it uses to convert to and from its base.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<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/Unit.html#getBase--">getBase</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<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/Unit.html#getDimension--">getDimension</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.html#getOtherNames--">getOtherNames</a></span>()</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>java.util.Optional<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.html#getPrimaryName--">getPrimaryName</a></span>()</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>java.util.Optional<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.html#getSymbol--">getSymbol</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/Unit.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.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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Unit-org.unitConverter.math.ObjectProduct-org.unitConverter.unit.NameSymbol-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Unit</h4> +<pre>protected Unit(<a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> unitBase, + <a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</pre> +<div class="block">Creates the <code>AbstractUnit</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unitBase</code> - base of unit</dd> +<dd><code>ns</code> - names and symbol of unit</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if unitBase or ns is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="fromConversionFunctions-org.unitConverter.math.ObjectProduct-java.util.function.DoubleUnaryOperator-java.util.function.DoubleUnaryOperator-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromConversionFunctions</h4> +<pre>public static final <a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> fromConversionFunctions(<a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> base, + java.util.function.DoubleUnaryOperator converterFrom, + java.util.function.DoubleUnaryOperator converterTo)</pre> +<div class="block">Returns a unit from its base and the functions it uses to convert to and from its base. + + <p> + For example, to get a unit representing the degree Celsius, the following code can be used: + + <code>Unit.fromConversionFunctions(SI.KELVIN, tempK -> tempK - 273.15, tempC -> tempC + 273.15);</code> + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>base</code> - unit's base</dd> +<dd><code>converterFrom</code> - function that accepts a value expressed in the unit's base and returns that value expressed in this + unit.</dd> +<dd><code>converterTo</code> - function that accepts a value expressed in the unit and returns that value expressed in the unit's + base.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a unit that uses the provided functions to convert.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if any argument is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-05-22</dd> +</dl> +</li> +</ul> +<a name="fromConversionFunctions-org.unitConverter.math.ObjectProduct-java.util.function.DoubleUnaryOperator-java.util.function.DoubleUnaryOperator-org.unitConverter.unit.NameSymbol-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromConversionFunctions</h4> +<pre>public static final <a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> fromConversionFunctions(<a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> base, + java.util.function.DoubleUnaryOperator converterFrom, + java.util.function.DoubleUnaryOperator converterTo, + <a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</pre> +<div class="block">Returns a unit from its base and the functions it uses to convert to and from its base. + + <p> + For example, to get a unit representing the degree Celsius, the following code can be used: + + <code>Unit.fromConversionFunctions(SI.KELVIN, tempK -> tempK - 273.15, tempC -> tempC + 273.15);</code> + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>base</code> - unit's base</dd> +<dd><code>converterFrom</code> - function that accepts a value expressed in the unit's base and returns that value expressed in this + unit.</dd> +<dd><code>converterTo</code> - function that accepts a value expressed in the unit and returns that value expressed in the unit's + base.</dd> +<dd><code>ns</code> - names and symbol of unit</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a unit that uses the provided functions to convert.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if any argument is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-05-22</dd> +</dl> +</li> +</ul> +<a name="canConvertTo-org.unitConverter.unit.Unit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canConvertTo</h4> +<pre>public final boolean canConvertTo(<a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> other)</pre> +<div class="block">Checks if a value expressed in this unit can be converted to a value expressed in <code>other</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>other</code> - unit to test with</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the units are compatible</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if other is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-01-13, v0.1.0</dd> +</dl> +</li> +</ul> +<a name="convertFromBase-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertFromBase</h4> +<pre>protected abstract double convertFromBase(double value)</pre> +<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="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> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2018-12-22, v0.1.0</dd> +<dt><span class="simpleTagLabel">Implementation Requirements:</span></dt> +<dd>This method is used by <a href="../../../org/unitConverter/unit/Unit.html#convertTo-org.unitConverter.unit.Unit-double-"><code>convertTo(org.unitConverter.unit.Unit, double)</code></a>, and its behaviour affects the behaviour of + <code>convertTo</code>.</dd> +</dl> +</li> +</ul> +<a name="convertTo-org.unitConverter.unit.Unit-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertTo</h4> +<pre>public final double convertTo(<a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> other, + double value)</pre> +<div class="block">Converts a value expressed in this unit to a value expressed in <code>other</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>other</code> - unit to convert to</dd> +<dd><code>value</code> - value to convert</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>converted value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if <code>other</code> is incompatible for conversion with this unit (as tested by + <a href="../../../org/unitConverter/unit/Unit.html#canConvertTo-org.unitConverter.unit.Unit-"><code>canConvertTo(org.unitConverter.unit.Unit)</code></a>).</dd> +<dd><code>java.lang.NullPointerException</code> - if other is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-05-22</dd> +<dt><span class="simpleTagLabel">Implementation Requirements:</span></dt> +<dd>If unit conversion is possible, this implementation returns + <code>other.convertFromBase(this.convertToBase(value))</code>. Therefore, overriding either of those methods + will change the output of this method.</dd> +</dl> +</li> +</ul> +<a name="convertToBase-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertToBase</h4> +<pre>protected abstract double convertToBase(double value)</pre> +<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="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> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2018-12-22, v0.1.0</dd> +<dt><span class="simpleTagLabel">Implementation Requirements:</span></dt> +<dd>This method is used by <a href="../../../org/unitConverter/unit/Unit.html#convertTo-org.unitConverter.unit.Unit-double-"><code>convertTo(org.unitConverter.unit.Unit, double)</code></a>, and its behaviour affects the behaviour of + <code>convertTo</code>.</dd> +</dl> +</li> +</ul> +<a name="getBase--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBase</h4> +<pre>public final <a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="../../../org/unitConverter/unit/BaseUnit.html" title="class in org.unitConverter.unit">BaseUnit</a>> getBase()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>combination of units that this unit is based on</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2018-12-22, v0.1.0</dd> +</dl> +</li> +</ul> +<a name="getDimension--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDimension</h4> +<pre>public final <a href="../../../org/unitConverter/math/ObjectProduct.html" title="class in org.unitConverter.math">ObjectProduct</a><<a href="../../../org/unitConverter/unit/BaseDimension.html" title="class in org.unitConverter.unit">BaseDimension</a>> getDimension()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>dimension measured by this unit</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2018-12-22, v0.1.0</dd> +</dl> +</li> +</ul> +<a name="getOtherNames--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOtherNames</h4> +<pre>public final java.util.Set<java.lang.String> getOtherNames()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>additionalNames</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-21</dd> +</dl> +</li> +</ul> +<a name="getPrimaryName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryName</h4> +<pre>public final java.util.Optional<java.lang.String> getPrimaryName()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>primaryName</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-21</dd> +</dl> +</li> +</ul> +<a name="getSymbol--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSymbol</h4> +<pre>public final java.util.Optional<java.lang.String> getSymbol()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>symbol</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-21</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>toString</code> in class <code>java.lang.Object</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/Unit.html" title="class in org.unitConverter.unit">Unit</a> withName(<a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</pre> +<dl> +<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> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if ns is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-21</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/Unit.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/SI.Dimensions.html" title="class in org.unitConverter.unit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/unitConverter/unit/UnitDatabase.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/Unit.html" target="_top">Frames</a></li> +<li><a href="Unit.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |