| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>Builder (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.referencing.Builder class"> |
| <meta name="keywords" content="properties"> |
| <meta name="keywords" content="setCodeSpace()"> |
| <meta name="keywords" content="setVersion()"> |
| <meta name="keywords" content="addName()"> |
| <meta name="keywords" content="addIdentifier()"> |
| <meta name="keywords" content="addNamesAndIdentifiers()"> |
| <meta name="keywords" content="rename()"> |
| <meta name="keywords" content="reidentify()"> |
| <meta name="keywords" content="setDescription()"> |
| <meta name="keywords" content="setRemarks()"> |
| <meta name="keywords" content="setDeprecated()"> |
| <meta name="keywords" content="onCreate()"> |
| <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="Builder (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = 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/Builder.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.referencing</a></div> |
| <h2 title="Class Builder" class="title">Class Builder<B extends Builder<B>></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>Builder<B></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>B</code> - the builder subclass.</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../parameter/ParameterBuilder.html" title="class in org.apache.sis.parameter">ParameterBuilder</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">Builder<B extends Builder<B>></span> |
| extends <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></pre> |
| <div class="block">Base class of builders for various kind of <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>IdentifiedObject</code></a>. This class provides convenience methods |
| for filling the <a href="#properties"><code>properties</code></a> map to be given to an <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ObjectFactory.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ObjectFactory</code></a>. |
| The main properties are: |
| |
| <ul class="verbose"> |
| <li><b><a href="AbstractIdentifiedObject.html#getName()">Name</a>:</b><br> |
| each <code>IdentifiedObject</code> shall have a name, which can be specified by a call to any of the |
| <a href="#addName(java.lang.CharSequence)"><code>addName(…)</code></a> methods defined in this class.</li> |
| |
| <li><b><a href="AbstractIdentifiedObject.html#getAlias()">Aliases</a>:</b><br> |
| <code>IdentifiedObject</code>s can optionally have an arbitrary amount of aliases, which are also specified |
| by the <code>addName(…)</code> methods. Each call after the first one adds an alias.</li> |
| |
| <li><b><a href="AbstractIdentifiedObject.html#getIdentifiers()">Identifiers</a>:</b><br> |
| <code>IdentifiedObject</code>s can also have an arbitrary amount of identifiers, which are specified by any |
| of the <a href="#addIdentifier(java.lang.String)"><code>addIdentifier(…)</code></a> methods. Like names, more than one identifier |
| can be added by invoking the method many time.</li> |
| |
| <li><b><a href="ImmutableIdentifier.html#getCodeSpace()">Code space</a>:</b><br> |
| <code>IdentifiedObject</code> names and identifiers can be local to a code space defined by an authority. |
| Both the authority and code space can be specified by the <a href="#setCodeSpace(org.opengis.metadata.citation.Citation,java.lang.String)"><code>setCodeSpace(Citation, String)</code></a> method, |
| and usually (but not necessarily) apply to all <code>Identifier</code> instances.</li> |
| |
| <li><b><a href="ImmutableIdentifier.html#getVersion()">Version</a>:</b><br> |
| <code>Identifier</code>s can optionally have a version specified by the <a href="#setVersion(java.lang.String)"><code>setVersion(String)</code></a> method. |
| The version usually (but not necessarily) applies to all <code>Identifier</code> instances.</li> |
| |
| <li><b><a href="ImmutableIdentifier.html#getDescription()">Description</a>:</b><br> |
| <code>Identifier</code>s can optionally have a description specified by the <a href="#setDescription(java.lang.CharSequence)"><code>setDescription(CharSequence)</code></a> method. |
| The description applies only to the next identifier to create.</li> |
| |
| <li><b><a href="AbstractIdentifiedObject.html#getRemarks()">Remarks</a>:</b><br> |
| <code>IdentifiedObject</code>s can have at most one remark, which is specified by the |
| <a href="#setRemarks(java.lang.CharSequence)"><code>code setRemarks(…)</code></a> method.</li> |
| </ul> |
| |
| <div class="section">Namespaces and scopes</div> |
| The <code>addName(…)</code> and <code>addIdentifier(…)</code> methods come in three flavors: |
| |
| <ul class="verbose"> |
| <li>The <a href="#addIdentifier(java.lang.String)"><code>addIdentifier(String)</code></a> and <a href="#addName(java.lang.CharSequence)"><code>addName(CharSequence)</code></a> methods combine the given argument |
| with the above-cited authority, code space, version and description information. |
| The result is a <a href="../util/iso/DefaultLocalName.html" title="class in org.apache.sis.util.iso">local name</a> or identifier, |
| in which the code space information is stored but not shown by the <code>toString()</code> method.</li> |
| |
| <li>The <a href="#addIdentifier(org.opengis.metadata.citation.Citation,java.lang.String)"><code>addIdentifier(Citation, String)</code></a> and <a href="#addName(org.opengis.metadata.citation.Citation,java.lang.CharSequence)"><code>addName(Citation, CharSequence)</code></a> methods use the given |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink"><code>Citation</code></a> argument, ignoring any authority or code space information given to this <code>Builder</code>. |
| The result is a <a href="../util/iso/DefaultScopedName.html" title="class in org.apache.sis.util.iso">scoped name</a> or identifier, |
| in which the code space information is shown by the <code>toString()</code> method.</li> |
| |
| <li>The <code>addIdentifier(Identifier)</code>, <code>addName(Identifier)</code> and <a href="#addName(org.opengis.util.GenericName)"><code>addName(GenericName)</code></a> |
| methods take the given object <cite>as-is</cite>. Any authority, code space, version or description |
| information given to the <code>Builder</code> are ignored.</li> |
| </ul> |
| |
| <div class="note"><b>Example:</b> |
| The EPSG database defines a projection named <cite>"Mercator (variant A)"</cite> (EPSG:9804). |
| This projection was named <cite>"Mercator (1SP)"</cite> in older EPSG database versions. |
| The same projection was also named "<code>Mercator_1SP</code>" by OGC some specifications. |
| If we choose EPSG as our primary naming authority, then those three names can be declared as below: |
| |
| <blockquote><pre>builder.<b>setCodespace</b> (Citations.EPSG, <font color="orangered">"EPSG"</font>) |
| .<b>addName</b>(<font color="orangered">"Mercator (variant A)"</font>) |
| .<b>addName</b>(<font color="orangered">"Mercator (1SP)"</font>) |
| .<b>addName</b>(Citations.OGC, <font color="orangered">"Mercator_1SP"</font>)</pre></blockquote> |
| |
| The <code>toString()</code> representation of those three names are <code>"Mercator (variant A)"</code>, |
| <code>"Mercator (1SP)"</code> (note the absence of <code>"EPSG:"</code> prefix, which is stored as the |
| name <a href="../util/iso/DefaultLocalName.html#scope()">scope</a> but not shown) and |
| <code>"<b>OGC:</b>Mercator_1SP"</code> respectively.</div> |
| |
| |
| <div class="section">Builder property lifetimes</div> |
| Some complex objects require the creation of many components. For example constructing a |
| <a href="crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">Coordinate Reference System</a> (CRS) may require constructing a |
| <a href="cs/AbstractCS.html" title="class in org.apache.sis.referencing.cs">coordinate system</a>, a |
| <a href="datum/AbstractDatum.html" title="class in org.apache.sis.referencing.datum">datum</a> and an |
| <a href="datum/DefaultEllipsoid.html" title="class in org.apache.sis.referencing.datum">ellipsoid</a> among other components. |
| However all those components often (but not necessarily) share the same authority, code space and version information. |
| In order to simplify that common usage, two groups of properties have different lifetimes in the <code>Builder</code> class: |
| |
| <ul> |
| <li> |
| <a href="ImmutableIdentifier.html#getAuthority()">Authority</a>, |
| <a href="ImmutableIdentifier.html#getCodeSpace()">code space</a> and |
| <a href="ImmutableIdentifier.html#getVersion()">version</a>:<br> |
| Kept until they are specified again, because those properties are typically shared by all components. |
| </li><li> |
| <a href="AbstractIdentifiedObject.html#getName()">Name</a>, |
| <a href="AbstractIdentifiedObject.html#getAlias()">aliases</a>, |
| <a href="AbstractIdentifiedObject.html#getIdentifiers()">identifiers</a>, |
| <a href="ImmutableIdentifier.html#getDescription()">description</a> and |
| <a href="AbstractIdentifiedObject.html#getRemarks()">remarks</a>:<br> |
| Cleared after each call to a <code>createXXX(…)</code> method, because those properties are usually specific |
| to a particular <code>IdentifiedObject</code> or <code>Identifier</code> instance. |
| </li> |
| </ul> |
| |
| <div class="section">Usage examples</div> |
| See <a href="../parameter/ParameterBuilder.html" title="class in org.apache.sis.parameter"><code>ParameterBuilder</code></a> class javadoc for more examples with the |
| <cite>Mercator</cite> projection parameters. |
| |
| <div class="section">Note for subclass implementers</div> |
| <ul> |
| <li>The type <code><B></code> shall be exactly the subclass type. |
| For performance reasons, this is verified only if Java assertions are enabled.</li> |
| <li>All <code>createXXX(…)</code> methods shall invoke <a href="#onCreate(boolean)"><code>onCreate(boolean)</code></a> before and after |
| usage of <a href="#properties"><code>properties</code></a> map by the factory.</li> |
| </ul> |
| |
| <div class="note"><b>Example:</b> |
| <blockquote><pre><font color="green">public</font> <font color="green">class</font> MyBuilder <font color="green">extends</font> Builder<MyBuilder> { |
| <font color="green">public</font> Foo <b>createFoo</b>() { |
| <b>onCreate</b>(<font color="green">false</font>); |
| Foo foo = factory.<b>createFoo</b>(properties); |
| <b>onCreate</b>(<font color="green">true</font>); |
| <font color="green">return</font> foo; |
| } |
| }</pre></blockquote> |
| </div></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​<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>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties">properties</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The properties to be given to <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ObjectFactory.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ObjectFactory</code></a> methods.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">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()">Builder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new builder.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.referencing.IdentifiedObject)">Builder</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new builder initialized to properties of the given object.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addIdentifier(java.lang.String)">addIdentifier</a></span>​(<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> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds an <code>IdentifiedObject</code> identifier given by a <code>String</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addIdentifier(org.opengis.metadata.citation.Citation,java.lang.String)">addIdentifier</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds an <code>IdentifiedObject</code> identifier in an alternative namespace.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addIdentifier(org.opengis.referencing.ReferenceIdentifier)">addIdentifier</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a> identifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds an <code>IdentifiedObject</code> identifier fully specified by the given identifier.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addName(java.lang.CharSequence)">addName</a></span>​(<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">Adds an <code>IdentifiedObject</code> name given by a <code>String</code> or <code>InternationalString</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addName(org.opengis.metadata.citation.Citation,java.lang.CharSequence)">addName</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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">Adds an <code>IdentifiedObject</code> name in an alternative namespace.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addName(org.opengis.referencing.ReferenceIdentifier)">addName</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds an <code>IdentifiedObject</code> name fully specified by the given identifier.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addName(org.opengis.util.GenericName)">addName</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">Adds an <code>IdentifiedObject</code> name fully specified by the given generic name.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addNamesAndIdentifiers(org.opengis.referencing.IdentifiedObject)">addNamesAndIdentifiers</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds all non-deprecated names and identifiers from the given object.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onCreate(boolean)">onCreate</a></span>​(boolean cleanup)</code></th> |
| <td class="colLast"> |
| <div class="block">Initializes/cleanups the <a href="#properties"><code>properties</code></a> map before/after a <code>createXXX(…)</code> execution.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reidentify(org.opengis.metadata.citation.Citation,java.lang.String...)">reidentify</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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>... replacements)</code></th> |
| <td class="colLast"> |
| <div class="block">Replaces the identifiers associated to the given authority by the given new identifiers.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rename(org.opengis.metadata.citation.Citation,java.lang.CharSequence...)">rename</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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>... replacements)</code></th> |
| <td class="colLast"> |
| <div class="block">Replaces the names associated to the given authority by the given new names.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCodeSpace(org.opengis.metadata.citation.Citation,java.lang.String)">setCodeSpace</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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> codespace)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <code>Identifier</code> authority and code space.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeprecated(boolean)">setDeprecated</a></span>​(boolean deprecated)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether the next <code>Identifier</code> or <code>IdentifiedObject</code>s to create shall be considered deprecated.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDescription(java.lang.CharSequence)">setDescription</a></span>​(<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> description)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets an <code>Identifier</code> or <code>IdentifiedObject</code> description.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRemarks(java.lang.CharSequence)">setRemarks</a></span>​(<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> remarks)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets remarks as a <code>String</code> or <code>InternationalString</code> instance.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="Builder.html" title="type parameter in Builder">B</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVersion(java.lang.String)">setVersion</a></span>​(<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> version)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <code>Identifier</code> version of object definitions.</div> |
| </td> |
| </tr> |
| </table> |
| <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#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/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#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</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#toString()" title="class or interface in java.lang" class="externalLink">toString</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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="properties"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<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>,​<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>> properties</pre> |
| <div class="block">The properties to be given to <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ObjectFactory.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink"><code>ObjectFactory</code></a> methods. |
| This map may contain values for the |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#NAME_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"name"</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#ALIAS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"alias"</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#IDENTIFIERS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"identifiers"</a> and |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true#REMARKS_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"remarks"</a> keys. |
| Subclasses may add other entries like |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true#DOMAIN_OF_VALIDITY_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"domainOfValidity"</a> and |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceSystem.html?is-external=true#SCOPE_KEY" title="class or interface in org.opengis.referencing" class="externalLink">"scope"</a> keys. |
| |
| <p>See <cite>Notes for subclass implementers</cite> in class javadoc for usage conditions.</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#onCreate(boolean)"><code>onCreate(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>protected Builder()</pre> |
| <div class="block">Creates a new builder.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.opengis.referencing.IdentifiedObject)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>protected Builder​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a> object)</pre> |
| <div class="block">Creates a new builder initialized to properties of the given object. |
| The properties recognized by this constructor are documented |
| <a href="IdentifiedObjects.html#getProperties(org.opengis.referencing.IdentifiedObject,java.lang.String...)">here</a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the identified object from which to inherit properties, or <code>null</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</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="setCodeSpace(org.opengis.metadata.citation.Citation,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCodeSpace</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> setCodeSpace​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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> codespace)</pre> |
| <div class="block">Sets the <code>Identifier</code> authority and code space. |
| The code space is often the authority's abbreviation, but not necessarily. |
| |
| <div class="note"><b>Example:</b> Coordinate Reference System (CRS) objects identified by codes from the |
| EPSG database are maintained by the <cite>International Association of Oil & Gas producers</cite> (IOGP) |
| authority, but the code space is <code>"EPSG"</code> for historical reasons.</div> |
| |
| This method is typically invoked only once, since a compound object often uses the same code space |
| for all individual components. |
| |
| <p><b>Condition:</b> |
| this method can not be invoked after one or more names or identifiers have been added (by calls to the |
| <code>addName(…)</code> or <code>addIdentifier(…)</code> methods) for the next object to create. This method can be |
| invoked again after the name, aliases and identifiers have been cleared by a call to <code>createXXX(…)</code>.</p> |
| |
| <p><b>Lifetime:</b> |
| this property is kept unchanged until this <code>setCodeSpace(…)</code> method is invoked again.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authority</code> - bibliographic reference to the authority defining the codes, or <code>null</code> if none.</dd> |
| <dd><code>codespace</code> - the <code>IdentifiedObject</code> codespace, or <code>null</code> for inferring it from the authority.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if <code>addName(…)</code> or <code>addIdentifier(…)</code> has been invoked at least |
| once since builder construction or since the last call to a <code>createXXX(…)</code> method.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ImmutableIdentifier.html#getAuthority()"><code>ImmutableIdentifier.getAuthority()</code></a>, |
| <a href="ImmutableIdentifier.html#getCodeSpace()"><code>ImmutableIdentifier.getCodeSpace()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setVersion(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVersion</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> setVersion​(<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> version)</pre> |
| <div class="block">Sets the <code>Identifier</code> version of object definitions. This method is typically invoked only once, |
| since a compound object often uses the same version for all individual components. |
| |
| <p><b>Condition:</b> |
| this method can not be invoked after one or more names or identifiers have been added (by calls to the |
| <code>addName(…)</code> or <code>addIdentifier(…)</code> methods) for the next object to create. This method can be |
| invoked again after the name, aliases and identifiers have been cleared by a call to <code>createXXX(…)</code>.</p> |
| |
| <p><b>Lifetime:</b> |
| this property is kept unchanged until this <code>setVersion(…)</code> method is invoked again.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>version</code> - the version of code definitions, or <code>null</code> if none.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if <code>addName(…)</code> or <code>addIdentifier(…)</code> has been invoked at least |
| once since builder construction or since the last call to a <code>createXXX(…)</code> method.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addName(java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addName</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> addName​(<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">Adds an <code>IdentifiedObject</code> name given by a <code>String</code> or <code>InternationalString</code>. |
| The given string will be combined with the authority, <a href="#setCodeSpace(org.opengis.metadata.citation.Citation,java.lang.String)">code space</a> and <a href="#setVersion(java.lang.String)">version</a> information for creating the |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink"><code>Identifier</code></a> or <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"><code>GenericName</code></a> object. |
| |
| <div class="section">Name and aliases</div> |
| This method can be invoked many times. The first invocation sets the |
| <a href="AbstractIdentifiedObject.html#getName()">primary name</a>, and |
| all subsequent invocations add an <a href="AbstractIdentifiedObject.html#getAlias()">alias</a>. |
| |
| <div class="section">Deprecated names</div> |
| Some names may exist for historical reasons but have their use discouraged. |
| If <code><a href="#setDeprecated(boolean)">setDeprecated</a>(true)</code> has been invoked, then this |
| method creates a deprecated alias with the current <a href="#setRemarks(java.lang.CharSequence)">remarks</a>. |
| The remark should suggest a replacement, for example with a sentence like |
| <cite>"Superseded by <new-name>"</cite>. |
| |
| <p>Note that deprecated names are always added as aliases, never as the primary name of an identified object.</p> |
| |
| <p><b>Lifetime:</b> |
| the name and all aliases are cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the <code>IdentifiedObject</code> name as a <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"><code>String</code></a> or <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> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addName(org.opengis.metadata.citation.Citation,java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addName</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> addName​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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">Adds an <code>IdentifiedObject</code> name in an alternative namespace. This method is typically invoked for |
| <a href="AbstractIdentifiedObject.html#getAlias()">aliases</a> defined after the primary name. |
| |
| <div class="note"><b>Example:</b> |
| The <cite>"Longitude of natural origin"</cite> parameter defined by EPSG is named differently |
| by OGC and GeoTIFF. Those alternative names can be defined as below: |
| |
| <blockquote><pre>builder.<b>setCodespace</b>(Citations.EPSG, <font color="orangered">"EPSG"</font>) <i><font color="gray">// Sets the default namespace to "EPSG".</font></i> |
| .<b>addName</b>(<font color="orangered">"Longitude of natural origin"</font>) <i><font color="gray">// Primary name in builder default namespace.</font></i> |
| .<b>addName</b>(Citations.OGC, <font color="orangered">"central_meridian"</font>) <i><font color="gray">// First alias in "OGC" namespace.</font></i> |
| .<b>addName</b>(Citations.GEOTIFF, <font color="orangered">"NatOriginLong"</font>); <i><font color="gray">// Second alias in "GeoTIFF" namespace.</font></i></pre></blockquote> |
| |
| In this example, <code>"central_meridian"</code> will be the |
| <a href="../util/iso/AbstractName.html#tip()">tip</a> and <code>"OGC"</code> will be the |
| <a href="../util/iso/AbstractName.html#head()">head</a> of the first alias.</div> |
| |
| <p><b>Lifetime:</b> |
| the name and all aliases are cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authority</code> - bibliographic reference to the authority defining the codes, or <code>null</code> if none.</dd> |
| <dd><code>name</code> - the <code>IdentifiedObject</code> alias as a name in the namespace of the given authority.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addIdentifier(org.opengis.metadata.citation.Citation,java.lang.String)"><code>addIdentifier(Citation, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addName(org.opengis.referencing.ReferenceIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addName</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> addName​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a> name)</pre> |
| <div class="block">Adds an <code>IdentifiedObject</code> name fully specified by the given identifier. |
| This method ignores the authority, <a href="#setCodeSpace(org.opengis.metadata.citation.Citation,java.lang.String)">code space</a>, |
| <a href="#setVersion(java.lang.String)">version</a> and <a href="#setDescription(java.lang.CharSequence)">description</a> |
| specified to this builder (if any), since the given identifier may already contain those information. |
| |
| <div class="section">Name and aliases</div> |
| This method can be invoked many times. The first invocation sets the |
| <a href="AbstractIdentifiedObject.html#getName()">primary name</a> to the given value, and |
| all subsequent invocations add an <a href="AbstractIdentifiedObject.html#getAlias()">alias</a>. |
| |
| <p><b>Lifetime:</b> |
| the name and all aliases are cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the <code>IdentifiedObject</code> name as an identifier.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addName(org.opengis.util.GenericName)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addName</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> addName​(<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">Adds an <code>IdentifiedObject</code> name fully specified by the given generic name. |
| This method ignores the authority, <a href="#setCodeSpace(org.opengis.metadata.citation.Citation,java.lang.String)">code space</a>, |
| <a href="#setVersion(java.lang.String)">version</a> and <a href="#setDescription(java.lang.CharSequence)">description</a> |
| specified to this builder (if any), since the given generic name may already contain those information. |
| |
| <div class="section">Name and aliases</div> |
| This method can be invoked many times. The first invocation sets the |
| <a href="AbstractIdentifiedObject.html#getName()">primary name</a> to the given value, and |
| all subsequent invocations add an <a href="AbstractIdentifiedObject.html#getAlias()">alias</a>. |
| |
| <p><b>Lifetime:</b> |
| the name and all aliases are cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the <code>IdentifiedObject</code> name as an identifier.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addIdentifier(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIdentifier</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> addIdentifier​(<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> identifier)</pre> |
| <div class="block">Adds an <code>IdentifiedObject</code> identifier given by a <code>String</code>. |
| The given string will be combined with the authority, <a href="#setCodeSpace(org.opengis.metadata.citation.Citation,java.lang.String)">code space</a> |
| <a href="#setVersion(java.lang.String)">version</a> and <a href="#setDescription(java.lang.CharSequence)">description</a> information |
| for creating the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/Identifier.html?is-external=true" title="class or interface in org.opengis.metadata" class="externalLink"><code>Identifier</code></a> object. |
| |
| <div class="section">Deprecated identifiers</div> |
| Some identifiers may exist for historical reasons but have their use discouraged. |
| If <code><a href="#setDeprecated(boolean)">setDeprecated</a>(true)</code> has been invoked, then this |
| method creates a deprecated identifier with the current <a href="#setRemarks(java.lang.CharSequence)">remarks</a>. |
| The remark should suggest a replacement, for example with a sentence like |
| <cite>"Superseded by <new-code>"</cite>. |
| |
| <p><b>Lifetime:</b> |
| all identifiers are cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - the <code>IdentifiedObject</code> identifier.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addIdentifier(org.opengis.metadata.citation.Citation,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIdentifier</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> addIdentifier​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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> identifier)</pre> |
| <div class="block">Adds an <code>IdentifiedObject</code> identifier in an alternative namespace. |
| This method is typically invoked in complement to <a href="#addName(org.opengis.metadata.citation.Citation,java.lang.CharSequence)"><code>addName(Citation, CharSequence)</code></a>. |
| |
| <p><b>Lifetime:</b> |
| all identifiers are cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authority</code> - bibliographic reference to the authority defining the codes, or <code>null</code> if none.</dd> |
| <dd><code>identifier</code> - the <code>IdentifiedObject</code> identifier as a code in the namespace of the given authority.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#addName(org.opengis.metadata.citation.Citation,java.lang.CharSequence)"><code>addName(Citation, CharSequence)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addIdentifier(org.opengis.referencing.ReferenceIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIdentifier</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> addIdentifier​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/ReferenceIdentifier.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">ReferenceIdentifier</a> identifier)</pre> |
| <div class="block">Adds an <code>IdentifiedObject</code> identifier fully specified by the given identifier. |
| This method ignores the authority, <a href="#setCodeSpace(org.opengis.metadata.citation.Citation,java.lang.String)">code space</a>, |
| <a href="#setVersion(java.lang.String)">version</a> and <a href="#setDescription(java.lang.CharSequence)">description</a> |
| specified to this builder (if any), since the given identifier already contains those information. |
| |
| <p><b>Lifetime:</b> |
| all identifiers are cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifier</code> - the <code>IdentifiedObject</code> identifier.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addNamesAndIdentifiers(org.opengis.referencing.IdentifiedObject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addNamesAndIdentifiers</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> addNamesAndIdentifiers​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/IdentifiedObject.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">IdentifiedObject</a> object)</pre> |
| <div class="block">Adds all non-deprecated names and identifiers from the given object. |
| Other properties like description and remarks are ignored. |
| |
| <p>This is a convenience method for using an existing object as a template, before to modify |
| some names by calls to <a href="#rename(org.opengis.metadata.citation.Citation,java.lang.CharSequence...)"><code>rename(Citation, CharSequence[])</code></a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object from which to copy the references to names and identifiers.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rename(org.opengis.metadata.citation.Citation,java.lang.CharSequence...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rename</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> rename​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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>... replacements)</pre> |
| <div class="block">Replaces the names associated to the given authority by the given new names. |
| More specifically: |
| |
| <ul> |
| <li>The first occurrence of a name associated to <code>authority</code> will be replaced by a new name |
| with the same authority and the local part defined by <code>replacements[0]</code>.</li> |
| <li>The second occurrence of a name associated to <code>authority</code> will be replaced by a new name |
| with the same authority and the local part defined by <code>replacements[1]</code>.</li> |
| <li><i>etc.</i> until one of the following conditions is met: |
| <ul> |
| <li>There is no more name associated to the given authority in this <code>Builder</code>, in which case |
| new names are inserted for all remaining elements in the <code>replacements</code> array.</li> |
| <li>There is no more elements in the <code>replacements</code> array, in which case all remaining |
| names associated to the given authority in this <code>Builder</code> are removed.</li> |
| </ul> |
| </li> |
| </ul> |
| |
| This method could also be understood as a <code>setNames(Citation, ...)</code> method, except that it modifies |
| only the names associated to the given authority and preserves the same order than previous names.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authority</code> - the authority of the names to replaces.</dd> |
| <dd><code>replacements</code> - the new local parts for the names to replace, |
| or <code>null</code> or an empty array for removing all names associated to the given authority.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="reidentify(org.opengis.metadata.citation.Citation,java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reidentify</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> reidentify​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/Citation.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink">Citation</a> authority, |
| <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>... replacements)</pre> |
| <div class="block">Replaces the identifiers associated to the given authority by the given new identifiers. |
| More specifically: |
| |
| <ul> |
| <li>The first occurrence of an identifier associated to <code>authority</code> will be replaced by |
| a new identifier with the same authority and the code defined by <code>replacements[0]</code>.</li> |
| <li>The second occurrence of an identifier associated to <code>authority</code> will be replaced by a |
| new identifier with the same authority and the local part defined by <code>replacements[1]</code>.</li> |
| <li><i>etc.</i> until one of the following conditions is met: |
| <ul> |
| <li>There is no more identifier associated to the given authority in this <code>Builder</code>, in which case |
| new identifiers are inserted for all remaining elements in the <code>replacements</code> array.</li> |
| <li>There is no more elements in the <code>replacements</code> array, in which case all remaining |
| identifiers associated to the given authority in this <code>Builder</code> are removed.</li> |
| </ul> |
| </li> |
| </ul> |
| |
| This method could also be understood as a <code>setIdentifiers(Citation, ...)</code> method, except that it modifies |
| only the identifiers associated to the given authority and preserves the same order than previous identifiers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>authority</code> - the authority of the names to replaces.</dd> |
| <dd><code>replacements</code> - the new local parts for the names to replace, |
| or <code>null</code> or an empty array for removing all names associated to the given authority.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDescription(java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescription</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> setDescription​(<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> description)</pre> |
| <div class="block">Sets an <code>Identifier</code> or <code>IdentifiedObject</code> description. |
| Descriptions can be used in various contexts: |
| |
| <ul> |
| <li>Before calls to <a href="#addIdentifier(java.lang.String)"><code>addIdentifier(String)</code></a> or <a href="#addIdentifier(org.opengis.metadata.citation.Citation,java.lang.String)"><code>addIdentifier(Citation, String)</code></a> |
| for specifying a natural language description of the meaning of the code value. |
| |
| <div class="note"><b>Example:</b> |
| <code>setDescription("World Geodetic System 1984").addIdentifier("4326")</code></div></li> |
| |
| <li>Before calls to a <code>createXXX(…)</code> method for providing a narrative explanation |
| of the role of the object. Not all <code>IdentifiedObject</code> supports description.</li> |
| </ul> |
| |
| Calls to this method overwrite any previous value. |
| |
| <p><b>Lifetime:</b> |
| previous descriptions are discarded by calls to <code>setDescription(…)</code>. |
| Descriptions are cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - the description as a <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"><code>String</code></a> or <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> instance, or <code>null</code> if none.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="ImmutableIdentifier.html#getDescription()"><code>ImmutableIdentifier.getDescription()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRemarks(java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRemarks</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> setRemarks​(<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> remarks)</pre> |
| <div class="block">Sets remarks as a <code>String</code> or <code>InternationalString</code> instance. |
| Calls to this method overwrite any previous value. |
| |
| <p><b>Lifetime:</b> |
| previous remarks are discarded by calls to <code>setRemarks(…)</code>. |
| Remarks are cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remarks</code> - the remarks as a <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"><code>String</code></a> or <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> instance, or <code>null</code> if none.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDeprecated(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeprecated</h4> |
| <pre class="methodSignature">public <a href="Builder.html" title="type parameter in Builder">B</a> setDeprecated​(boolean deprecated)</pre> |
| <div class="block">Sets whether the next <code>Identifier</code> or <code>IdentifiedObject</code>s to create shall be considered deprecated. |
| Deprecated objects exist in some <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/AuthorityFactory.html?is-external=true" title="class or interface in org.opengis.referencing" class="externalLink">authority factories</a> like |
| the EPSG database. |
| |
| <p>Note that this method does not apply to name and identifiers, which have their own |
| <code>addDeprecatedFoo(…)</code> methods.</p> |
| |
| <p><b>Lifetime:</b> |
| Deprecation status is cleared after a <code>createXXX(…)</code> method has been invoked.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deprecated</code> - <code>true</code> if the next names, identifiers and identified objects should be |
| considered deprecated, or <code>false</code> otherwise.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code>, for method call chaining.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="AbstractIdentifiedObject.html#isDeprecated()"><code>AbstractIdentifiedObject.isDeprecated()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onCreate(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onCreate</h4> |
| <pre class="methodSignature">protected void onCreate​(boolean cleanup)</pre> |
| <div class="block">Initializes/cleanups the <a href="#properties"><code>properties</code></a> map before/after a <code>createXXX(…)</code> execution. |
| Subclasses shall invoke this method in their <code>createXXX(…)</code> methods as below: |
| |
| <blockquote><pre><font color="green">public</font> Foo <b>createFoo</b>() { |
| <font color="green">final</font> Foo foo; |
| <b>onCreate</b>(<font color="green">false</font>); |
| <font color="green">try</font> { |
| foo = factory.<b>createFoo</b>(properties); |
| } <font color="green">finally</font> { |
| <b>onCreate</b>(<font color="green">true</font>); |
| } |
| <font color="green">return</font> foo; |
| }</pre></blockquote> |
| |
| If <code>cleanup</code> is <code>true</code>, then this method clears the identification information |
| (name, aliases, identifiers, description, remarks and deprecation status) for preparing the |
| builder to the construction of an other object. |
| The authority, codespace and version properties are not cleared by this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cleanup</code> - <code>false</code> when this method is invoked before object creation, and |
| <code>true</code> when this method is invoked after object creation.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#properties"><code>properties</code></a></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/Builder.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <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> |