static/apidocs/org/apache/sis/measure/UnitFormat.Style.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
 <title>UnitFormat.Style (Apache SIS 1.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2019-09-20">
 <meta name="keywords" content="org.apache.sis.measure.UnitFormat.Style class">
 <meta name="keywords" content="values()">
 <meta name="keywords" content="valueOf()">
 <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="../../../../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="UnitFormat.Style (Apache SIS 1.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":9,"i1":9};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 var pathtoroot = "../../../../";
 var useModuleDirectories = false;
 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/UnitFormat.Style.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">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.sis.measure</a></div>
 <h2 title="Enum UnitFormat.Style" class="title">Enum UnitFormat.Style</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li>
 <li>
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;<a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a>&gt;</li>
 <li>
 <ul class="inheritance">
 <li>Style</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a>&lt;<a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a>&gt;</code></dd>
 </dl>
 <dl>
 <dt>Enclosing class:</dt>
 <dd><a href="UnitFormat.html" title="class in org.apache.sis.measure">UnitFormat</a></dd>
 </dl>
 <hr>
 <pre>public static enum <span class="typeNameLabel">UnitFormat.Style</span>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a>&lt;<a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a>&gt;</pre>
 <div class="block">Identify whether unit formatting uses ASCII symbols, Unicode symbols or full localized names.
  For example the <a href="Units.html#CUBIC_METRE"><code>Units.CUBIC_METRE</code></a> units can be formatted in the following ways:

  <ul>
    <li>As a symbol using Unicode characters: <b>m³</b></li>
    <li>As a symbol restricted to the ASCII characters set: <b>m3</b></li>
    <li>As a long name:<ul>
      <li>in English: <cite>cubic metre</cite></li>
      <li>in French: <cite>mètre cube</cite></li>
    </ul></li>
  </ul></div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.8</dd>

 <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="enum.constant.summary">
 <!--   -->
 </a>
 <h3>Enum Constant Summary</h3>
 <table class="memberSummary">
 <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Enum Constant</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#NAME">NAME</a></span></code></th>
 <td class="colLast">
 <div class="block">Format unit symbols as localized long names if known, or Unicode symbols otherwise.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SYMBOL">SYMBOL</a></span></code></th>
 <td class="colLast">
 <div class="block">Format unit symbols using Unicode characters.</div>
 </td>
 </tr>
 <tr class="altColor">
 <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#UCUM">UCUM</a></span></code></th>
 <td class="colLast">
 <div class="block">Format unit symbols using a syntax close to the Unified Code for Units of Measure (UCUM) one.</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>static <a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
 <td class="colLast">
 <div class="block">Returns the enum constant of this type with the specified name.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>static <a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a>[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns an array containing the constants of this enum type, in
 the order they are declared.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.Enum">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang" class="externalLink">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang" class="externalLink">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang" class="externalLink">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang" class="externalLink">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="externalLink">valueOf</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ ENUM CONSTANT DETAIL =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="enum.constant.detail">
 <!--   -->
 </a>
 <h3>Enum Constant Detail</h3>
 <a id="SYMBOL">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>SYMBOL</h4>
 <pre>public static final&nbsp;<a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a> SYMBOL</pre>
 <div class="block">Format unit symbols using Unicode characters. Units formatted in this style use superscript digits
  for exponents (as in “m³”), the dot operator (“⋅”) for multiplications, specialized characters when
  they exist (e.g. U+212A “K” for Kelvin sign), <i>etc.</i>

  <p>This is the default style of <a href="UnitFormat.html" title="class in org.apache.sis.measure"><code>UnitFormat</code></a>.</p></div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true#getSymbol()" title="class or interface in javax.measure" class="externalLink"><code>Unit.getSymbol()</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="UCUM">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>UCUM</h4>
 <pre>public static final&nbsp;<a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a> UCUM</pre>
 <div class="block">Format unit symbols using a syntax close to the Unified Code for Units of Measure (UCUM) one.
  The character set is restricted to ASCII. The multiplication operator is the period (“.”).

  <div class="section">Modification to UCUM syntax rules</div>
  UCUM does not allow floating point numbers in unit terms, so the use of period as an operator
  should not be ambiguous. However Apache SIS relaxes this restriction in order to support the
  scale factors commonly found in angular units (e.g. π/180). The meaning of a period in a string
  is resolved with two SIS-specific rules:

  <ul>
    <li>Unit symbols shall not begin or end with a decimal digit or a superscript.</li>
    <li>A period between two decimal digits is interpreted as a decimal separator.</li>
  </ul></div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../util/CharSequences.html#toASCII(java.lang.CharSequence)"><code>CharSequences.toASCII(CharSequence)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="NAME">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>NAME</h4>
 <pre>public static final&nbsp;<a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a> NAME</pre>
 <div class="block">Format unit symbols as localized long names if known, or Unicode symbols otherwise.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://unitsofmeasurement.github.io/unit-api/site/apidocs/javax/measure/Unit.html?is-external=true#getName()" title="class or interface in javax.measure" class="externalLink"><code>Unit.getName()</code></a></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="values()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>values</h4>
 <pre class="methodSignature">public static&nbsp;<a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a>[]&nbsp;values()</pre>
 <div class="block">Returns an array containing the constants of this enum type, in
 the order they are declared. This method may be used to iterate
 over the constants as follows:
 <pre>
 for (UnitFormat.Style c : UnitFormat.Style.values())
 &nbsp;   System.out.println(c);
 </pre></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an array containing the constants of this enum type, in the order they are declared</dd>
 </dl>
 </li>
 </ul>
 <a id="valueOf(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>valueOf</h4>
 <pre class="methodSignature">public static&nbsp;<a href="UnitFormat.Style.html" title="enum in org.apache.sis.measure">UnitFormat.Style</a>&nbsp;valueOf&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
 <div class="block">Returns the enum constant of this type with the specified name.
 The string must match <i>exactly</i> an identifier used to declare an
 enum constant in this type.  (Extraneous whitespace characters are
 not permitted.)</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>name</code> - the name of the enum constant to be returned.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the enum constant with the specified name</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the argument is null</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/UnitFormat.Style.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">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>