| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>DefaultLocalName (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.util.iso.DefaultLocalName class"> |
| <meta name="keywords" content="castOrCopy()"> |
| <meta name="keywords" content="scope()"> |
| <meta name="keywords" content="depth()"> |
| <meta name="keywords" content="getParsedNames()"> |
| <meta name="keywords" content="head()"> |
| <meta name="keywords" content="tip()"> |
| <meta name="keywords" content="toString()"> |
| <meta name="keywords" content="toInternationalString()"> |
| <meta name="keywords" content="compareTo()"> |
| <meta name="keywords" content="equals()"> |
| <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="DefaultLocalName (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| 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/DefaultLocalName.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 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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a 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.apache.sis.util.iso</a></div> |
| <h2 title="Class DefaultLocalName" class="title">Class DefaultLocalName</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="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>DefaultLocalName</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><<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a>></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="DefaultMemberName.html" title="class in org.apache.sis.util.iso">DefaultMemberName</a></code>, <code><a href="DefaultTypeName.html" title="class in org.apache.sis.util.iso">DefaultTypeName</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">DefaultLocalName</span> |
| extends <a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a> |
| implements <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></pre> |
| <div class="block">Identifier within a <a href="DefaultNameSpace.html" title="class in org.apache.sis.util.iso">name space</a> for a local object. |
| Local names are names which are directly accessible to and maintained by a name space. |
| Names are local to one and only one name space. |
| The name space within which they are local is indicated by the <a href="#scope()">scope</a>. |
| |
| <p><code>DefaultLocalName</code> can be instantiated by any of the following methods:</p> |
| <ul> |
| <li><a href="DefaultNameFactory.html#createLocalName(org.opengis.util.NameSpace,java.lang.CharSequence)"><code>DefaultNameFactory.createLocalName(NameSpace, CharSequence)</code></a>.</li> |
| <li><a href="DefaultNameFactory.html#createGenericName(org.opengis.util.NameSpace,java.lang.CharSequence...)"><code>DefaultNameFactory.createGenericName(NameSpace, CharSequence[])</code></a> with an array of length 1.</li> |
| <li><a href="DefaultNameFactory.html#parseGenericName(org.opengis.util.NameSpace,java.lang.CharSequence)"><code>DefaultNameFactory.parseGenericName(NameSpace, CharSequence)</code></a> with no occurrence of the separator in the path.</li> |
| <li>Similar static convenience methods in <a href="Names.html" title="class in org.apache.sis.util.iso"><code>Names</code></a>.</li> |
| </ul> |
| |
| <div class="section">Immutability and thread safety</div> |
| This class is immutable and thus inherently thread-safe if the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/NameSpace.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>NameSpace</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>CharSequence</code></a> |
| arguments given to the constructor are also immutable. Subclasses shall make sure that any overridden methods |
| remain safe to call from multiple threads and do not change any public <code>LocalName</code> state.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DefaultNameSpace.html" title="class in org.apache.sis.util.iso"><code>DefaultNameSpace</code></a>, |
| <a href="DefaultScopedName.html" title="class in org.apache.sis.util.iso"><code>DefaultScopedName</code></a>, |
| <a href="../../../../../serialized-form.html#org.apache.sis.util.iso.DefaultLocalName">Serialized Form</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.util.NameSpace,java.lang.CharSequence)">DefaultLocalName</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/NameSpace.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">NameSpace</a> scope, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a local name from the given character sequence.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="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="DefaultLocalName.html" title="class in org.apache.sis.util.iso">DefaultLocalName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.util.LocalName)">castOrCopy</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a SIS local name implementation with the values of the given arbitrary implementation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compareTo(org.opengis.util.GenericName)">compareTo</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares this name with the specified object for order.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#depth()">depth</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the depth, which is always 1 for a local name.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<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> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares this local name with the specified object for equality.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">DefaultLocalName</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParsedNames()">getParsedNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the sequence of local name for this name.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#head()">head</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>this</code> since this object is already a local name.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/NameSpace.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">NameSpace</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scope()">scope</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the scope (name space) in which this name is local.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tip()">tip</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>this</code> since this object is already a local name.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toInternationalString()">toInternationalString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a local-dependent string representation of this local name.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a locale-independent string representation of this local name.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.AbstractName"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></h3> |
| <code><a href="AbstractName.html#castOrCopy(org.opengis.util.GenericName)">castOrCopy</a>, <a href="AbstractName.html#hashCode()">hashCode</a>, <a href="AbstractName.html#push(org.opengis.util.GenericName)">push</a>, <a href="AbstractName.html#toFullyQualifiedName()">toFullyQualifiedName</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <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#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.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/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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.GenericName"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></h3> |
| <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#push(org.opengis.util.GenericName)" title="class or interface in org.opengis.util" class="externalLink">push</a>, <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#toFullyQualifiedName()" title="class or interface in org.opengis.util" class="externalLink">toFullyQualifiedName</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.opengis.util.NameSpace,java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultLocalName</h4> |
| <pre>protected DefaultLocalName​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/NameSpace.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">NameSpace</a> scope, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a> name)</pre> |
| <div class="block">Constructs a local name from the given character sequence. |
| If the character sequence is an instance of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a>, |
| then its <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true#toString(java.util.Locale)" title="class or interface in org.opengis.util" class="externalLink"><code>toString(Locale.ROOT)</code></a> |
| method will be invoked for fetching an unlocalized name. |
| Otherwise the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink"><code>CharSequence.toString()</code></a> method will be used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scope</code> - the scope of this name, or <code>null</code> for a global scope.</dd> |
| <dd><code>name</code> - the local name (never <code>null</code>).</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="castOrCopy(org.opengis.util.LocalName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>castOrCopy</h4> |
| <pre class="methodSignature">public static <a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">DefaultLocalName</a> castOrCopy​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a> object)</pre> |
| <div class="block">Returns a SIS local name implementation with the values of the given arbitrary implementation. |
| This method performs the first applicable action in the following choices: |
| |
| <ul> |
| <li>If the given object is <code>null</code>, then this method returns <code>null</code>.</li> |
| <li>Otherwise if the given object is an instance of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/MemberName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>MemberName</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/TypeName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>TypeName</code></a>, |
| then this method delegates to <code>castOrCopy(…)</code> method of the corresponding subclass.</li> |
| <li>Otherwise if the given object is already an instance of <code>DefaultLocalName</code>, |
| then it is returned unchanged.</li> |
| <li>Otherwise a new <code>DefaultLocalName</code> instance is created |
| with the same values than the given name.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object to get as a SIS implementation, or <code>null</code> if none.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a SIS implementation containing the values of the given object (may be the |
| given object itself), or <code>null</code> if the argument was null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="scope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scope</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/NameSpace.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">NameSpace</a> scope()</pre> |
| <div class="block">Returns the scope (name space) in which this name is local. This method returns a |
| non-null value in all cases, even when the scope given to the constructor was null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#scope()" title="class or interface in org.opengis.util" class="externalLink">scope</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AbstractName.html#scope()">scope</a></code> in class <code><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the scope of this name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="depth()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>depth</h4> |
| <pre class="methodSignature">public final int depth()</pre> |
| <div class="block">Returns the depth, which is always 1 for a local name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#depth()" title="class or interface in org.opengis.util" class="externalLink">depth</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#depth()" title="class or interface in org.opengis.util" class="externalLink">depth</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractName.html#depth()">depth</a></code> in class <code><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the depth of this name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParsedNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParsedNames</h4> |
| <pre class="methodSignature">public final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DefaultLocalName.html" title="class in org.apache.sis.util.iso">DefaultLocalName</a>> getParsedNames()</pre> |
| <div class="block">Returns the sequence of local name for this name. |
| Since this object is itself a local name, this method always returns a singleton |
| containing only <code>this</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#getParsedNames()" title="class or interface in org.opengis.util" class="externalLink">getParsedNames</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#getParsedNames()" title="class or interface in org.opengis.util" class="externalLink">getParsedNames</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AbstractName.html#getParsedNames()">getParsedNames</a></code> in class <code><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local names making this generic name, without the <a href="AbstractName.html#scope()">scope</a>. |
| Shall never be <code>null</code> neither empty.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="head()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>head</h4> |
| <pre class="methodSignature">public final <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a> head()</pre> |
| <div class="block">Returns <code>this</code> since this object is already a local name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#head()" title="class or interface in org.opengis.util" class="externalLink">head</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#head()" title="class or interface in org.opengis.util" class="externalLink">head</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractName.html#head()">head</a></code> in class <code><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="tip()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tip</h4> |
| <pre class="methodSignature">public final <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a> tip()</pre> |
| <div class="block">Returns <code>this</code> since this object is already a local name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#tip()" title="class or interface in org.opengis.util" class="externalLink">tip</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#tip()" title="class or interface in org.opengis.util" class="externalLink">tip</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractName.html#tip()">tip</a></code> in class <code><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <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> toString()</pre> |
| <div class="block">Returns a locale-independent string representation of this local name. |
| This string does not include the scope, which is consistent with the |
| <a href="#getParsedNames()">parsed names</a> definition.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#toString()" title="class or interface in org.opengis.util" class="externalLink">toString</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true#toString()" title="class or interface in org.opengis.util" class="externalLink">toString</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/LocalName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">LocalName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractName.html#toString()">toString</a></code> in class <code><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a local-independent string representation of this name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toInternationalString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toInternationalString</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a> toInternationalString()</pre> |
| <div class="block">Returns a local-dependent string representation of this local name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true#toInternationalString()" title="class or interface in org.opengis.util" class="externalLink">toInternationalString</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractName.html#toInternationalString()">toInternationalString</a></code> in class <code><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a localizable string representation of this name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="compareTo(org.opengis.util.GenericName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareTo</h4> |
| <pre class="methodSignature">public int compareTo​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a> name)</pre> |
| <div class="block">Compares this name with the specified object for order. Returns a negative integer, |
| zero, or a positive integer as this name lexicographically precedes, is equal to, |
| or follows the specified object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang" class="externalLink">compareTo</a></code> in interface <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><<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractName.html#compareTo(org.opengis.util.GenericName)">compareTo</a></code> in class <code><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the other name to compare with this name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>-1 if this name precedes the given one, +1 if it follows, 0 if equals.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<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> object)</pre> |
| <div class="block">Compares this local name with the specified object for equality.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractName.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="AbstractName.html" title="class in org.apache.sis.util.iso">AbstractName</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object to compare with this name for equality.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the given object is equal to this name.</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/DefaultLocalName.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 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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
