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/UnitDatabase.PrefixedUnitMap.html | |
parent | e1e7e38482de8cf8f6d4fd8735b6e43ad2a13cb8 (diff) |
Added Javadoc to the project.
Diffstat (limited to 'doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.html')
-rw-r--r-- | doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.html | 930 |
1 files changed, 930 insertions, 0 deletions
diff --git a/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.html b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.html new file mode 100644 index 0000000..5ed1f84 --- /dev/null +++ b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.html @@ -0,0 +1,930 @@ +<!DOCTYPE HTML> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (11.0.4) on Thu Oct 24 10:48:04 EDT 2019 --> +<title>UnitDatabase.PrefixedUnitMap</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<meta name="dc.created" content="2019-10-24"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script> +<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> +<!--[if IE]> +<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> +<![endif]--> +<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script> +<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script> +<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="UnitDatabase.PrefixedUnitMap"; + } + } + catch(err) { + } +//--> +var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +var pathtoroot = "../../../"; +var useModuleDirectories = true; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<header role="banner"> +<nav role="navigation"> +<div class="fixedNav"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a id="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/UnitDatabase.PrefixedUnitMap.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" id="allclasses_navbar_top"> +<li><a href="../../../allclasses.html">All Classes</a></li> +</ul> +<ul class="navListSearch"> +<li><label for="search">SEARCH:</label> +<input type="text" id="search" value="search" disabled="disabled"> +<input type="reset" id="reset" value="reset" disabled="disabled"> +</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> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +</nav> +</header> +<!-- ======== START OF CLASS DATA ======== --> +<main role="main"> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.unitConverter.unit</a></div> +<h2 title="Class UnitDatabase.PrefixedUnitMap" class="title">Class UnitDatabase.PrefixedUnitMap</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.unitConverter.unit.UnitDatabase.PrefixedUnitMap</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="UnitDatabase.html" title="class in org.unitConverter.unit">UnitDatabase</a></dd> +</dl> +<hr> +<pre>private static final class <span class="typeNameLabel">UnitDatabase.PrefixedUnitMap</span> +extends java.lang.Object +implements java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></pre> +<div class="block">A map for units that allows the use of prefixes. + <p> + As this map implementation is intended to be used as a sort of "augmented view" of a unit and prefix map, it is + unmodifiable but instead reflects the changes to the maps passed into it. Do not edit this map, instead edit the + maps that were passed in during construction. + </p> + <p> + The rules for applying prefixes onto units are the following: + <ul> + <li>Prefixes can only be applied to linear units.</li> + <li>Before attempting to search for prefixes in a unit name, this map will first search for a unit name. So, if + there are two units, "B" and "AB", and a prefix "A", this map will favour the unit "AB" over the unit "B" with + the prefix "A", even though they have the same string.</li> + <li>Longer prefixes are preferred to shorter prefixes. So, if you have units "BC" and "C", and prefixes "AB" and + "A", inputting "ABC" will return the unit "C" with the prefix "AB", not "BC" with the prefix "A".</li> + </ul> + </p> + <p> + This map is infinite in size if there is at least one unit and at least one prefix. If it is infinite, some + operations that only work with finite collections, like converting name/entry sets to arrays, will throw an + <code>IllegalStateException</code>. + </p> + <p> + Because of ambiguities between prefixes (i.e. kilokilo = mega), <a href="#containsValue(java.lang.Object)"><code>containsValue(java.lang.Object)</code></a> and <a href="#values()"><code>values()</code></a> + currently ignore prefixes. + </p></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-04-13, v0.2.0</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"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private static class </code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.html" title="class in org.unitConverter.unit">UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet</a></span></code></th> +<td class="colLast"> +<div class="block">The class used for entry sets.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private static class </code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.html" title="class in org.unitConverter.unit">UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet</a></span></code></th> +<td class="colLast"> +<div class="block">The class used for unit name sets.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a id="nested.classes.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface java.util.Map</h3> +<code>java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object></code></li> +</ul> +</li> +</ul> +</section> +<!-- =========== FIELD SUMMARY =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Field</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private java.util.Set<java.util.Map.Entry<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>>></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#entrySet">entrySet</a></span></code></th> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private java.util.Set<java.lang.String></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keySet">keySet</a></span></code></th> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private java.util.Map<java.lang.String,​<a href="UnitPrefix.html" title="class in org.unitConverter.unit">UnitPrefix</a>></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prefixes">prefixes</a></span></code></th> +<td class="colLast"> +<div class="block">The available prefixes for use.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#units">units</a></span></code></th> +<td class="colLast"> +<div class="block">The units stored in this collection, without prefixes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private java.util.Collection<<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values">values</a></span></code></th> +<td class="colLast"> </td> +</tr> +</table> +</li> +</ul> +</section> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map,java.util.Map)">PrefixedUnitMap</a></span>​(java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> units, + java.util.Map<java.lang.String,​<a href="UnitPrefix.html" title="class in org.unitConverter.unit">UnitPrefix</a>> prefixes)</code></th> +<td class="colLast"> +<div class="block">Creates the <code>PrefixedUnitMap</code>.</div> +</td> +</tr> +</table> +</li> +</ul> +</section> +<!-- ========== METHOD SUMMARY =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</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="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compute(java.lang.String,java.util.function.BiFunction)">compute</a></span>​(java.lang.String key, + java.util.function.BiFunction<? super java.lang.String,​? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> remappingFunction)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeIfAbsent(java.lang.String,java.util.function.Function)">computeIfAbsent</a></span>​(java.lang.String key, + java.util.function.Function<? super java.lang.String,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> mappingFunction)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeIfPresent(java.lang.String,java.util.function.BiFunction)">computeIfPresent</a></span>​(java.lang.String key, + java.util.function.BiFunction<? super java.lang.String,​? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> remappingFunction)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsKey(java.lang.Object)">containsKey</a></span>​(java.lang.Object key)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsValue(java.lang.Object)">containsValue</a></span>​(java.lang.Object value)</code></th> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>java.util.Set<java.util.Map.Entry<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>>></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#entrySet()">entrySet</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.lang.Object)">get</a></span>​(java.lang.Object key)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keySet()">keySet</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#merge(java.lang.String,org.unitConverter.unit.Unit,java.util.function.BiFunction)">merge</a></span>​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> value, + java.util.function.BiFunction<? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> remappingFunction)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#put(java.lang.String,org.unitConverter.unit.Unit)">put</a></span>​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> value)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putAll(java.util.Map)">putAll</a></span>​(java.util.Map<? extends java.lang.String,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> m)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putIfAbsent(java.lang.String,org.unitConverter.unit.Unit)">putIfAbsent</a></span>​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> value)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(java.lang.Object)">remove</a></span>​(java.lang.Object key)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(java.lang.Object,java.lang.Object)">remove</a></span>​(java.lang.Object key, + java.lang.Object value)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="Unit.html" title="class in org.unitConverter.unit">Unit</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replace(java.lang.String,org.unitConverter.unit.Unit)">replace</a></span>​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> value)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replace(java.lang.String,org.unitConverter.unit.Unit,org.unitConverter.unit.Unit)">replace</a></span>​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> oldValue, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> newValue)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replaceAll(java.util.function.BiFunction)">replaceAll</a></span>​(java.util.function.BiFunction<? super java.lang.String,​? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> function)</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>java.util.Collection<<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a id="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> +<ul class="blockList"> +<li class="blockList"><a id="methods.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Map</h3> +<code>equals, forEach, getOrDefault, hashCode</code></li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a id="units"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>units</h4> +<pre>private final java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> units</pre> +<div class="block">The units stored in this collection, without prefixes.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-04-13, v0.2.0</dd> +</dl> +</li> +</ul> +<a id="prefixes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prefixes</h4> +<pre>private final java.util.Map<java.lang.String,​<a href="UnitPrefix.html" title="class in org.unitConverter.unit">UnitPrefix</a>> prefixes</pre> +<div class="block">The available prefixes for use.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-04-13, v0.2.0</dd> +</dl> +</li> +</ul> +<a id="values"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>private transient java.util.Collection<<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> values</pre> +</li> +</ul> +<a id="keySet"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keySet</h4> +<pre>private transient java.util.Set<java.lang.String> keySet</pre> +</li> +</ul> +<a id="entrySet"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>entrySet</h4> +<pre>private transient java.util.Set<java.util.Map.Entry<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>>> entrySet</pre> +</li> +</ul> +</li> +</ul> +</section> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a id="<init>(java.util.Map,java.util.Map)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PrefixedUnitMap</h4> +<pre>public PrefixedUnitMap​(java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> units, + java.util.Map<java.lang.String,​<a href="UnitPrefix.html" title="class in org.unitConverter.unit">UnitPrefix</a>> prefixes)</pre> +<div class="block">Creates the <code>PrefixedUnitMap</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>units</code> - map mapping unit names to units</dd> +<dd><code>prefixes</code> - map mapping prefix names to prefixes</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-04-13, v0.2.0</dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +<!-- ============ METHOD DETAIL ========== --> +<section role="region"> +<ul class="blockList"> +<li class="blockList"><a id="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a id="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre class="methodSignature">public void clear()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>clear</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="compute(java.lang.String,java.util.function.BiFunction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compute</h4> +<pre class="methodSignature">public <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> compute​(java.lang.String key, + java.util.function.BiFunction<? super java.lang.String,​? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> remappingFunction)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>compute</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="computeIfAbsent(java.lang.String,java.util.function.Function)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>computeIfAbsent</h4> +<pre class="methodSignature">public <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> computeIfAbsent​(java.lang.String key, + java.util.function.Function<? super java.lang.String,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> mappingFunction)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>computeIfAbsent</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="computeIfPresent(java.lang.String,java.util.function.BiFunction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>computeIfPresent</h4> +<pre class="methodSignature">public <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> computeIfPresent​(java.lang.String key, + java.util.function.BiFunction<? super java.lang.String,​? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> remappingFunction)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>computeIfPresent</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="containsKey(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsKey</h4> +<pre class="methodSignature">public boolean containsKey​(java.lang.Object key)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>containsKey</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="containsValue(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsValue</h4> +<pre class="methodSignature">public boolean containsValue​(java.lang.Object value)</pre> +<div class="block"> + + <p> + Because of ambiguities between prefixes (i.e. kilokilo = mega), this method only tests for prefixless units. + </p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>containsValue</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="entrySet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entrySet</h4> +<pre class="methodSignature">public java.util.Set<java.util.Map.Entry<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>>> entrySet()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>entrySet</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="get(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre class="methodSignature">public <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> get​(java.lang.Object key)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>get</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre class="methodSignature">public boolean isEmpty()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>isEmpty</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="keySet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keySet</h4> +<pre class="methodSignature">public java.util.Set<java.lang.String> keySet()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>keySet</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="merge(java.lang.String,org.unitConverter.unit.Unit,java.util.function.BiFunction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>merge</h4> +<pre class="methodSignature">public <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> merge​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> value, + java.util.function.BiFunction<? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> remappingFunction)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>merge</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="put(java.lang.String,org.unitConverter.unit.Unit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre class="methodSignature">public <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> put​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> value)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>put</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="putAll(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putAll</h4> +<pre class="methodSignature">public void putAll​(java.util.Map<? extends java.lang.String,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> m)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>putAll</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="putIfAbsent(java.lang.String,org.unitConverter.unit.Unit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putIfAbsent</h4> +<pre class="methodSignature">public <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> putIfAbsent​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> value)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>putIfAbsent</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="remove(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre class="methodSignature">public <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> remove​(java.lang.Object key)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>remove</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="remove(java.lang.Object,java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre class="methodSignature">public boolean remove​(java.lang.Object key, + java.lang.Object value)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>remove</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="replace(java.lang.String,org.unitConverter.unit.Unit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replace</h4> +<pre class="methodSignature">public <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> replace​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> value)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>replace</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="replace(java.lang.String,org.unitConverter.unit.Unit,org.unitConverter.unit.Unit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replace</h4> +<pre class="methodSignature">public boolean replace​(java.lang.String key, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> oldValue, + <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a> newValue)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>replace</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="replaceAll(java.util.function.BiFunction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replaceAll</h4> +<pre class="methodSignature">public void replaceAll​(java.util.function.BiFunction<? super java.lang.String,​? super <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>,​? extends <a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> function)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>replaceAll</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre class="methodSignature">public int size()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>size</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +<a id="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre class="methodSignature">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 id="values()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>values</h4> +<pre class="methodSignature">public java.util.Collection<<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>> values()</pre> +<div class="block"> + + <p> + Because of ambiguities between prefixes (i.e. kilokilo = mega), this method ignores prefixes. + </p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>values</code> in interface <code>java.util.Map<java.lang.String,​<a href="Unit.html" title="class in org.unitConverter.unit">Unit</a>></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +</div> +</main> +<!-- ========= END OF CLASS DATA ========= --> +<footer role="contentinfo"> +<nav role="navigation"> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a id="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/UnitDatabase.PrefixedUnitMap.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" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses.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> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</nav> +</footer> +</body> +</html> |