diff options
| author | Adrien Hopkins <masterofnumbers17@gmail.com> | 2019-12-24 16:16:13 -0500 |
|---|---|---|
| committer | Adrien Hopkins <masterofnumbers17@gmail.com> | 2019-12-24 16:16:13 -0500 |
| commit | 2c146c894972e2c6ab701b3c66dcf242d7be656f (patch) | |
| tree | 8629866fa1cf017c02d61bd288fd336e7d8b7b49 /doc/org/unitConverter/unit/LinearUnit.html | |
| parent | e1e7e38482de8cf8f6d4fd8735b6e43ad2a13cb8 (diff) | |
Added Javadoc to the project.
Diffstat (limited to 'doc/org/unitConverter/unit/LinearUnit.html')
| -rw-r--r-- | doc/org/unitConverter/unit/LinearUnit.html | 800 |
1 files changed, 800 insertions, 0 deletions
diff --git a/doc/org/unitConverter/unit/LinearUnit.html b/doc/org/unitConverter/unit/LinearUnit.html new file mode 100644 index 0000000..1e1fce2 --- /dev/null +++ b/doc/org/unitConverter/unit/LinearUnit.html @@ -0,0 +1,800 @@ +<!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>LinearUnit</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="LinearUnit"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":9,"i18":9,"i19":10,"i20":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/LinearUnit.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/BritishImperial.Volume.html" title="class in org.unitConverter.unit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/unitConverter/unit/NameSymbol.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/LinearUnit.html" target="_top">Frames</a></li> +<li><a href="LinearUnit.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 LinearUnit" class="title">Class LinearUnit</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.LinearUnit</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">LinearUnit</span> +extends <a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a></pre> +<div class="block">A unit that can be expressed as a product of its base and a number. For example, kilometres, inches and pounds.</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>protected double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/LinearUnit.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="i1" class="rowColor"> +<td class="colFirst"><code>protected double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/LinearUnit.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="i2" 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/LinearUnit.html#dividedBy-double-">dividedBy</a></span>(double divisor)</code> +<div class="block">Divides this unit by a scalar.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<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/LinearUnit.html#dividedBy-org.unitConverter.unit.LinearUnit-">dividedBy</a></span>(<a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> divisor)</code> +<div class="block">Returns the quotient of this unit and another.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/LinearUnit.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> +<div class="block"> + + Uses the base and conversion factor of units to test for equality.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <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/LinearUnit.html#fromUnitValue-org.unitConverter.unit.Unit-double-">fromUnitValue</a></span>(<a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> unit, + double value)</code> +<div class="block">Gets a <code>LinearUnit</code> from a unit and a value.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <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/LinearUnit.html#fromUnitValue-org.unitConverter.unit.Unit-double-org.unitConverter.unit.NameSymbol-">fromUnitValue</a></span>(<a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> unit, + double value, + <a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</code> +<div class="block">Gets a <code>LinearUnit</code> from a unit and a value.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/LinearUnit.html#getConversionFactor--">getConversionFactor</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/LinearUnit.html#hashCode--">hashCode</a></span>()</code> +<div class="block"> + + Uses the base and conversion factor to compute a hash code.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/LinearUnit.html#isBase--">isBase</a></span>()</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/LinearUnit.html#isCoherent--">isCoherent</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<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/LinearUnit.html#minus-org.unitConverter.unit.LinearUnit-">minus</a></span>(<a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> subtrahendend)</code> +<div class="block">Returns the difference of this unit and another.</div> +</td> +</tr> +<tr id="i12" 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/LinearUnit.html#plus-org.unitConverter.unit.LinearUnit-">plus</a></span>(<a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> addend)</code> +<div class="block">Returns the sum of this unit and another.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<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/LinearUnit.html#times-double-">times</a></span>(double multiplier)</code> +<div class="block">Multiplies this unit by a scalar.</div> +</td> +</tr> +<tr id="i14" 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/LinearUnit.html#times-org.unitConverter.unit.LinearUnit-">times</a></span>(<a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> multiplier)</code> +<div class="block">Returns the product of this unit and another.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<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/LinearUnit.html#toExponent-int-">toExponent</a></span>(int exponent)</code> +<div class="block">Returns this unit but to an exponent.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/unit/LinearUnit.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>static <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/LinearUnit.html#valueOf-org.unitConverter.math.ObjectProduct-double-">valueOf</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, + double conversionFactor)</code> +<div class="block">Gets a <code>LinearUnit</code> from a unit base and a conversion factor.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>static <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/LinearUnit.html#valueOf-org.unitConverter.math.ObjectProduct-double-org.unitConverter.unit.NameSymbol-">valueOf</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, + double conversionFactor, + <a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</code> +<div class="block">Gets a <code>LinearUnit</code> from a unit base and a conversion factor.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<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/LinearUnit.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> +<tr id="i20" 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/LinearUnit.html#withPrefix-org.unitConverter.unit.UnitPrefix-">withPrefix</a></span>(<a href="../../../org/unitConverter/unit/UnitPrefix.html" title="class in org.unitConverter.unit">UnitPrefix</a> prefix)</code> +<div class="block">Returns the result of applying <code>prefix</code> to this unit.</div> +</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, 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="fromUnitValue-org.unitConverter.unit.Unit-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromUnitValue</h4> +<pre>public static <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> fromUnitValue(<a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> unit, + double value)</pre> +<div class="block">Gets a <code>LinearUnit</code> from a unit and a value. For example, converts '59 °F' to a linear unit with the value + of '288.15 K'</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unit</code> - unit to convert</dd> +<dd><code>value</code> - value to convert</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value expressed as a <code>LinearUnit</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if unit is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</dd> +</dl> +</li> +</ul> +<a name="fromUnitValue-org.unitConverter.unit.Unit-double-org.unitConverter.unit.NameSymbol-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromUnitValue</h4> +<pre>public static <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> fromUnitValue(<a href="../../../org/unitConverter/unit/Unit.html" title="class in org.unitConverter.unit">Unit</a> unit, + double value, + <a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</pre> +<div class="block">Gets a <code>LinearUnit</code> from a unit and a value. For example, converts '59 °F' to a linear unit with the value + of '288.15 K'</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unit</code> - unit to convert</dd> +<dd><code>value</code> - value to convert</dd> +<dd><code>ns</code> - name(s) and symbol of unit</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value expressed as a <code>LinearUnit</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if unit or ns is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-21</dd> +</dl> +</li> +</ul> +<a name="valueOf-org.unitConverter.math.ObjectProduct-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> valueOf(<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, + double conversionFactor)</pre> +<div class="block">Gets a <code>LinearUnit</code> from a unit base and a conversion factor. In other words, gets the product of + <code>unitBase</code> and <code>conversionFactor</code>, expressed as a <code>LinearUnit</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unitBase</code> - unit base to multiply by</dd> +<dd><code>conversionFactor</code> - number to multiply base by</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>product of base and conversion factor</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if unitBase is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</dd> +</dl> +</li> +</ul> +<a name="valueOf-org.unitConverter.math.ObjectProduct-double-org.unitConverter.unit.NameSymbol-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> valueOf(<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, + double conversionFactor, + <a href="../../../org/unitConverter/unit/NameSymbol.html" title="class in org.unitConverter.unit">NameSymbol</a> ns)</pre> +<div class="block">Gets a <code>LinearUnit</code> from a unit base and a conversion factor. In other words, gets the product of + <code>unitBase</code> and <code>conversionFactor</code>, expressed as a <code>LinearUnit</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>unitBase</code> - unit base to multiply by</dd> +<dd><code>conversionFactor</code> - number to multiply base by</dd> +<dd><code>ns</code> - name(s) and symbol of unit</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>product of base and conversion factor</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if unitBase is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-21</dd> +</dl> +</li> +</ul> +<a name="convertFromBase-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertFromBase</h4> +<pre>protected 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> + + Converts by dividing by <code>conversionFactor</code></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>protected 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> + + Converts by multiplying by <code>conversionFactor</code></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="dividedBy-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dividedBy</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> dividedBy(double divisor)</pre> +<div class="block">Divides this unit by a scalar.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>divisor</code> - scalar to divide by</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>quotient</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2018-12-23, v0.1.0</dd> +</dl> +</li> +</ul> +<a name="dividedBy-org.unitConverter.unit.LinearUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dividedBy</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> dividedBy(<a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> divisor)</pre> +<div class="block">Returns the quotient of this unit and another.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>divisor</code> - unit to divide by</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>quotient of two units</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if <code>divisor</code> is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2018-12-22, v0.1.0</dd> +</dl> +</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> +<div class="block"> + + Uses the base and conversion factor of units to test for equality.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="getConversionFactor--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConversionFactor</h4> +<pre>public double getConversionFactor()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>conversion factor</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<div class="block"> + + Uses the base and conversion factor to compute a hash code.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="isBase--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBase</h4> +<pre>public boolean isBase()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether this unit is equivalent to a <code>BaseUnit</code> (i.e. there is a <code>BaseUnit b</code> where + <code>b.asLinearUnit().equals(this)</code> returns <code>true</code>.)</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</dd> +</dl> +</li> +</ul> +<a name="isCoherent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCoherent</h4> +<pre>public boolean isCoherent()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether this unit is coherent (i.e. has conversion factor 1)</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</dd> +</dl> +</li> +</ul> +<a name="minus-org.unitConverter.unit.LinearUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>minus</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> minus(<a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> subtrahendend)</pre> +<div class="block">Returns the difference of this unit and another. + <p> + Two units can be subtracted if they have the same base. Note that <a href="../../../org/unitConverter/unit/Unit.html#canConvertTo-org.unitConverter.unit.Unit-"><code>Unit.canConvertTo(org.unitConverter.unit.Unit)</code></a> can be used to determine + this. If <code>subtrahend</code> does not meet this condition, an <code>IllegalArgumentException</code> will be thrown. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>subtrahend</code> - unit to subtract</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>difference of units</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if <code>subtrahend</code> is not compatible for subtraction as described above</dd> +<dd><code>java.lang.NullPointerException</code> - if <code>subtrahend</code> is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-17, v0.2.0</dd> +</dl> +</li> +</ul> +<a name="plus-org.unitConverter.unit.LinearUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>plus</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> plus(<a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> addend)</pre> +<div class="block">Returns the sum of this unit and another. + <p> + Two units can be added if they have the same base. Note that <a href="../../../org/unitConverter/unit/Unit.html#canConvertTo-org.unitConverter.unit.Unit-"><code>Unit.canConvertTo(org.unitConverter.unit.Unit)</code></a> can be used to determine this. + If <code>addend</code> does not meet this condition, an <code>IllegalArgumentException</code> will be thrown. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addend</code> - unit to add</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>sum of units</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if <code>addend</code> is not compatible for addition as described above</dd> +<dd><code>java.lang.NullPointerException</code> - if <code>addend</code> is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-17, v0.2.0</dd> +</dl> +</li> +</ul> +<a name="times-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>times</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> times(double multiplier)</pre> +<div class="block">Multiplies this unit by a scalar.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>multiplier</code> - scalar to multiply by</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>product</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2018-12-23, v0.1.0</dd> +</dl> +</li> +</ul> +<a name="times-org.unitConverter.unit.LinearUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>times</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> times(<a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> multiplier)</pre> +<div class="block">Returns the product of this unit and another.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>multiplier</code> - unit to multiply by</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>product of two units</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if <code>multiplier</code> is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2018-12-22, v0.1.0</dd> +</dl> +</li> +</ul> +<a name="toExponent-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toExponent</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> toExponent(int exponent)</pre> +<div class="block">Returns this unit but to an exponent.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>exponent</code> - exponent to exponentiate unit to</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>exponentiated unit</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-01-15, v0.1.0</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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a string providing a definition of this unit</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-21</dd> +</dl> +</li> +</ul> +<a name="withName-org.unitConverter.unit.NameSymbol-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withName</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</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> +<a name="withPrefix-org.unitConverter.unit.UnitPrefix-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>withPrefix</h4> +<pre>public <a href="../../../org/unitConverter/unit/LinearUnit.html" title="class in org.unitConverter.unit">LinearUnit</a> withPrefix(<a href="../../../org/unitConverter/unit/UnitPrefix.html" title="class in org.unitConverter.unit">UnitPrefix</a> prefix)</pre> +<div class="block">Returns the result of applying <code>prefix</code> to this unit. + <p> + If this unit and the provided prefix have a primary name, the returned unit will have a primary name (prefix's + name + unit's name). <br> + If this unit and the provided prefix have a symbol, the returned unit will have a symbol. <br> + This method ignores alternate names of both this unit and the provided prefix.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>prefix</code> - prefix to apply</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>unit with prefix</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NullPointerException</code> - if prefix is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-18, v0.2.0</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/LinearUnit.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/BritishImperial.Volume.html" title="class in org.unitConverter.unit"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/unitConverter/unit/NameSymbol.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/LinearUnit.html" target="_top">Frames</a></li> +<li><a href="LinearUnit.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> |