| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>UnitServices (Apache SIS 1.3 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.sis.measure, class: UnitServices"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.measure.UnitServices class"> |
| <meta name="keywords" content="getSystemOfUnits()"> |
| <meta name="keywords" content="getAvailableSystemsOfUnits()"> |
| <meta name="keywords" content="getSystemOfUnitsService()"> |
| <meta name="keywords" content="getUnitFormat()"> |
| <meta name="keywords" content="getAvailableFormatNames()"> |
| <meta name="keywords" content="getUnitFormatService()"> |
| <meta name="keywords" content="getQuantityFactory()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/UnitServices.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-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Nested</li> |
| <li>Field</li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.measure</a></div> |
| <h1 title="Class UnitServices" class="title">Class UnitServices</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html" title="class or interface in javax.measure.spi" class="external-link">ServiceProvider</a> |
| <div class="inheritance">UnitServices</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnitsService</a></code>, <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html" title="class or interface in javax.measure.spi" class="external-link">UnitFormatService</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">UnitServices</span> |
| <span class="extends-implements">extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html" title="class or interface in javax.measure.spi" class="external-link">ServiceProvider</a> |
| implements <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnitsService</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html" title="class or interface in javax.measure.spi" class="external-link">UnitFormatService</a></span></div> |
| <div class="block">The central point from which all unit services (parsing, formatting, listing, <i>etc</i>) can be obtained. |
| Apache SIS does not use this class (SIS rather uses <a href="Units.html" title="class in org.apache.sis.measure"><code>Units</code></a> predefined constants and <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/format/UnitFormat.html" title="class or interface in javax.measure.format" class="external-link"><code>UnitFormat</code></a> |
| directly since they are designed specifically for SIS needs). |
| This class is provided for allowing other applications to discover Apache SIS implementation of JSR-363 |
| without direct dependency. A <code>UnitServices</code> instance can be obtained by call to <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html#current()" title="class or interface in javax.measure.spi" class="external-link"><code>ServiceProvider.current()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.8</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">UnitServices</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new service provider.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAvailableFormatNames()" class="member-name-link">getAvailableFormatNames</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a list of available format names.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnits.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnits</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAvailableSystemsOfUnits()" class="member-name-link">getAvailableSystemsOfUnits</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the list of all available systems of units.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><Q extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a><Q>><br><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/QuantityFactory.html" title="class or interface in javax.measure.spi" class="external-link">QuantityFactory</a><Q></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuantityFactory(java.lang.Class)" class="member-name-link">getQuantityFactory</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><Q> type)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return a factory for the given <code>Quantity</code> type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnits.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnits</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSystemOfUnits()" class="member-name-link">getSystemOfUnits</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the default system of units used by Apache SIS.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnits.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnits</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSystemOfUnits(java.lang.String)" class="member-name-link">getSystemOfUnits</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the system of units having the specified name, or <code>null</code> if none.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnitsService</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSystemOfUnitsService()" class="member-name-link">getSystemOfUnitsService</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the service to obtain a <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnits.html" title="class or interface in javax.measure.spi" class="external-link"><code>SystemOfUnits</code></a> instances.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/format/UnitFormat.html" title="class or interface in javax.measure.format" class="external-link">UnitFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUnitFormat()" class="member-name-link">getUnitFormat</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an unit format instance for human-readable unit symbols in the default locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/format/UnitFormat.html" title="class or interface in javax.measure.format" class="external-link">UnitFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUnitFormat(java.lang.String)" class="member-name-link">getUnitFormat</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the unit format for the given name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html" title="class or interface in javax.measure.spi" class="external-link">UnitFormatService</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUnitFormatService()" class="member-name-link">getUnitFormatService</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the service to obtain a <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/format/UnitFormat.html" title="class or interface in javax.measure.format" class="external-link"><code>UnitFormat</code></a> instances.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-ServiceProvider">Methods inherited from class <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html" title="class or interface in javax.measure.spi" class="external-link">ServiceProvider</a></h3> |
| <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html#available()" title="class or interface in javax.measure.spi" class="external-link">available</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html#current()" title="class or interface in javax.measure.spi" class="external-link">current</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html#getPriority()" title="class or interface in javax.measure.spi" class="external-link">getPriority</a>, <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html#setCurrent(javax.measure.spi.ServiceProvider)" title="class or interface in javax.measure.spi" class="external-link">setCurrent</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>UnitServices</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">UnitServices</span>()</div> |
| <div class="block">Creates a new service provider. <code>UnitServices</code> should not be instantiated |
| directly unless the caller wants specifically the Apache SIS implementation. |
| For obtaining the default implementation, use <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html#current()" title="class or interface in javax.measure.spi" class="external-link"><code>ServiceProvider.current()</code></a> instead.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getSystemOfUnits()"> |
| <h3>getSystemOfUnits</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnits.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnits</a></span> <span class="element-name">getSystemOfUnits</span>()</div> |
| <div class="block">Returns the default system of units used by Apache SIS. |
| This include the International System of Units (SI) together with some imperial units and other units. |
| This system includes at least all the constants defined in the <a href="Units.html" title="class in org.apache.sis.measure"><code>Units</code></a> class.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html#getSystemOfUnits()" title="class or interface in javax.measure.spi" class="external-link">getSystemOfUnits</a></code> in interface <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnitsService</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the system of units used by Apache SIS.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSystemOfUnits(java.lang.String)"> |
| <h3>getSystemOfUnits</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnits.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnits</a></span> <span class="element-name">getSystemOfUnits</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Returns the system of units having the specified name, or <code>null</code> if none. |
| The argument can be any name in the following table: |
| |
| <table class="sis"> |
| <caption>Available system of units</caption> |
| <tr><th>Name</th> <th>Examples</th></tr> |
| <tr><td>SI</td> <td>m, km, m³, s, m∕s, K, °C, hPa, rad, µrad</td></tr> |
| <tr><td>SI + accepted</td> <td>s, min, h, m∕s, km∕h, °, ′, ″, ha</td></tr> |
| <tr><td>Imperial</td> <td>in, ft, mi (statute mile)</td></tr> |
| <tr><td>SI + other</td> <td>m, m∕s, km∕h, ft, mi, M (nautical mile)</td></tr> |
| </table> |
| |
| The search for name is case-insensitive and ignore whitespaces.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html#getSystemOfUnits(java.lang.String)" title="class or interface in javax.measure.spi" class="external-link">getSystemOfUnits</a></code> in interface <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnitsService</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the desired system of units.</dd> |
| <dt>Returns:</dt> |
| <dd>the system of units for the given name, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAvailableSystemsOfUnits()"> |
| <h3>getAvailableSystemsOfUnits</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnits.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnits</a>></span> <span class="element-name">getAvailableSystemsOfUnits</span>()</div> |
| <div class="block">Returns the list of all available systems of units.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html#getAvailableSystemsOfUnits()" title="class or interface in javax.measure.spi" class="external-link">getAvailableSystemsOfUnits</a></code> in interface <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnitsService</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>list of available systems of units.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSystemOfUnitsService()"> |
| <h3>getSystemOfUnitsService</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnitsService.html" title="class or interface in javax.measure.spi" class="external-link">SystemOfUnitsService</a></span> <span class="element-name">getSystemOfUnitsService</span>()</div> |
| <div class="block">Returns the service to obtain a <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnits.html" title="class or interface in javax.measure.spi" class="external-link"><code>SystemOfUnits</code></a> instances. |
| The default implementation returns <code>this</code> since this <code>UnitServices</code> class |
| implements directly all relevant interfaces. The methods related to system of units are: |
| |
| <ul> |
| <li><a href="#getSystemOfUnits()"><code>getSystemOfUnits()</code></a></li> |
| <li><a href="#getSystemOfUnits(java.lang.String)"><code>getSystemOfUnits(String)</code></a></li> |
| <li><a href="#getAvailableSystemsOfUnits()"><code>getAvailableSystemsOfUnits()</code></a></li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html#getSystemOfUnitsService()" title="class or interface in javax.measure.spi" class="external-link">getSystemOfUnitsService</a></code> in class <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html" title="class or interface in javax.measure.spi" class="external-link">ServiceProvider</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the service to obtain a <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/SystemOfUnits.html" title="class or interface in javax.measure.spi" class="external-link"><code>SystemOfUnits</code></a>, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnitFormat()"> |
| <h3>getUnitFormat</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/format/UnitFormat.html" title="class or interface in javax.measure.format" class="external-link">UnitFormat</a></span> <span class="element-name">getUnitFormat</span>()</div> |
| <div class="block">Returns an unit format instance for human-readable unit symbols in the default locale. |
| The format style is <a href="UnitFormat.Style.html#SYMBOL"><code>UnitFormat.Style.SYMBOL</code></a>. |
| This style requires support for Unicode characters; |
| for example square metres are formatted as “m²”, not “m2”.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html#getUnitFormat()" title="class or interface in javax.measure.spi" class="external-link">getUnitFormat</a></code> in interface <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html" title="class or interface in javax.measure.spi" class="external-link">UnitFormatService</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="UnitFormat.html" title="class in org.apache.sis.measure"><code>UnitFormat</code></a> instance for unit symbols.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnitFormat(java.lang.String)"> |
| <h3>getUnitFormat</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/format/UnitFormat.html" title="class or interface in javax.measure.format" class="external-link">UnitFormat</a></span> <span class="element-name">getUnitFormat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Returns the unit format for the given name. The argument can be the name of |
| any value in the <a href="UnitFormat.Style.html" title="enum class in org.apache.sis.measure"><code>UnitFormat.Style</code></a> enumeration. |
| The argument can be any name in the following table: |
| |
| <table class="sis"> |
| <caption>Available unit format name</caption> |
| <tr><th>Name</th> <th>Examples</th></tr> |
| <tr><td>SYMBOL</td> <td>km, m³, m∕s, N⋅m, K, °C, hPa, rad, µrad</td></tr> |
| <tr><td>UCUM</td> <td>km, m3, m/s, N.m</td></tr> |
| <tr><td>NAME</td> <td>kilometre, cubic metre, metres per second</td></tr> |
| </table> |
| |
| The <code>"NAME"</code> format is locale-sensitive. The format locale can be modified by a call |
| to <a href="UnitFormat.html#setLocale(java.util.Locale)"><code>UnitFormat.setLocale(Locale)</code></a> on the returned object.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html#getUnitFormat(java.lang.String)" title="class or interface in javax.measure.spi" class="external-link">getUnitFormat</a></code> in interface <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html" title="class or interface in javax.measure.spi" class="external-link">UnitFormatService</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the desired format.</dd> |
| <dt>Returns:</dt> |
| <dd>the corresponding unit format, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAvailableFormatNames()"> |
| <h3>getAvailableFormatNames</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getAvailableFormatNames</span>()</div> |
| <div class="block">Returns a list of available format names. The default implementation returns the names |
| of all values in the <a href="UnitFormat.Style.html" title="enum class in org.apache.sis.measure"><code>UnitFormat.Style</code></a> enumeration.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html#getAvailableFormatNames()" title="class or interface in javax.measure.spi" class="external-link">getAvailableFormatNames</a></code> in interface <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html" title="class or interface in javax.measure.spi" class="external-link">UnitFormatService</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>list of available formats.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnitFormatService()"> |
| <h3>getUnitFormatService</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/UnitFormatService.html" title="class or interface in javax.measure.spi" class="external-link">UnitFormatService</a></span> <span class="element-name">getUnitFormatService</span>()</div> |
| <div class="block">Returns the service to obtain a <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/format/UnitFormat.html" title="class or interface in javax.measure.format" class="external-link"><code>UnitFormat</code></a> instances. |
| The default implementation returns <code>this</code> since this <code>UnitServices</code> class |
| implements directly all relevant interfaces. The methods related to unit formats are: |
| |
| <ul> |
| <li><a href="#getUnitFormat()"><code>getUnitFormat()</code></a></li> |
| <li><a href="#getUnitFormat(java.lang.String)"><code>getUnitFormat(String)</code></a></li> |
| <li><a href="#getAvailableFormatNames()"><code>getAvailableFormatNames()</code></a></li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html#getUnitFormatService()" title="class or interface in javax.measure.spi" class="external-link">getUnitFormatService</a></code> in class <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html" title="class or interface in javax.measure.spi" class="external-link">ServiceProvider</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the service to obtain a <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/format/UnitFormat.html" title="class or interface in javax.measure.format" class="external-link"><code>UnitFormat</code></a>, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQuantityFactory(java.lang.Class)"> |
| <h3>getQuantityFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><Q extends <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link">Quantity</a><Q>></span> <span class="return-type"><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/QuantityFactory.html" title="class or interface in javax.measure.spi" class="external-link">QuantityFactory</a><Q></span> <span class="element-name">getQuantityFactory</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><Q> type)</span></div> |
| <div class="block">Return a factory for the given <code>Quantity</code> type. In the particular case of Apache SIS implementation, |
| <a href="Quantities.html#create(double,javax.measure.Unit)"><code>Quantities.create(double, Unit)</code></a> provides a more direct way to instantiate quantities.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html#getQuantityFactory(java.lang.Class)" title="class or interface in javax.measure.spi" class="external-link">getQuantityFactory</a></code> in class <code><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/spi/ServiceProvider.html" title="class or interface in javax.measure.spi" class="external-link">ServiceProvider</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>Q</code> - compile-time value of the <code>type</code> argument.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - type of the desired the quantity.</dd> |
| <dt>Returns:</dt> |
| <dd>the service to obtain <a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Quantity.html" title="class or interface in javax.measure" class="external-link"><code>Quantity</code></a> instances.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="Quantities.html#create(double,javax.measure.Unit)"><code>Quantities.create(double, Unit)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |