blob: 9900e355f8eb26df2c91645fc7a82ac3f3aa30fb [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>DefaultTelephone (Apache SIS 1.4 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-10-05">
<meta name="description" content="declaration: module: org.apache.sis.metadata, package: org.apache.sis.metadata.iso.citation, class: DefaultTelephone">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.metadata.iso.citation.DefaultTelephone class">
<meta name="keywords" content="castOrCopy()">
<meta name="keywords" content="getNumber()">
<meta name="keywords" content="setNumber()">
<meta name="keywords" content="getNumberType()">
<meta name="keywords" content="setNumberType()">
<meta name="keywords" content="getVoices()">
<meta name="keywords" content="setVoices()">
<meta name="keywords" content="getFacsimiles()">
<meta name="keywords" content="setFacsimiles()">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="../../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li><a href="#nested-class-summary">Nested</a></li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../../module-summary.html">org.apache.sis.metadata</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.metadata.iso.citation</a></div>
<h1 title="Class DefaultTelephone" class="title">Class DefaultTelephone</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
<div class="inheritance"><a href="../../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a>
<div class="inheritance"><a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a>
<div class="inheritance"><a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a>
<div class="inheritance">DefaultTelephone</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../../../../../../org.apache.sis.util/org/apache/sis/util/Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a></code>, <code><a href="../../../../../../../org.apache.sis.util/org/apache/sis/util/LenientComparable.html" title="interface in org.apache.sis.util">Lenient­Comparable</a></code>, <code><a href="../../../xml/IdentifiedObject.html" title="interface in org.apache.sis.xml">Identified­Object</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Telephone</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultTelephone</span>
<span class="extends-implements">extends <a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a>
implements <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Telephone</a></span></div>
<div class="block">Telephone numbers for contacting the responsible individual or organization.
The following property is mandatory in a well-formed metadata according ISO 19115:
<div class="preformat"><code>CI_Telephone</code>
<code>  └─number……</code> Telephone number by which individuals can contact responsible organisation or individual.</div>
<h2 id="differences-between-versions-2003-and-2014-of-iso-19115-heading">Differences between versions 2003 and 2014 of ISO 19115</h2>
For any contact having more than one telephone number, the way to organize the information
changed significantly between the two versions of ISO standard:
<ul>
<li>In ISO 19115:2003, each <code>Contact</code> had only one <code>Telephone</code> instance, but that instance
could have an arbitrary number of "voice" and "facsimile" numbers. The methods (now deprecated) were
<a href="DefaultContact.html#getPhone()"><code>Default­Contact​.get­Phone()</code></a>, <a href="#getVoices()"><code>get­Voices()</code></a> and <a href="#getFacsimiles()"><code>get­Facsimiles()</code></a>.</li>
<li>In ISO 19115:2014, each <code>Contact</code> has an arbitrary number of <code>Telephone</code> instances, and
each telephone has exactly one number. The new methods are <a href="DefaultContact.html#getPhones()"><code>Default­Contact​.get­Phones()</code></a>,
<a href="#getNumber()"><code>get­Number()</code></a> and <a href="#getNumberType()"><code>get­Number­Type()</code></a>.</li>
</ul>
<h2 id="limitations-heading">Limitations</h2>
<ul>
<li>Instances of this class are not synchronized for multi-threading.
Synchronization, if needed, is caller's responsibility.</li>
<li>Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use <a href="../../../xml/XML.html" title="class in org.apache.sis.xml"><code>XML</code></a> instead.</li>
</ul></div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.5</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="DefaultContact.html#getPhones()"><code>Default­Contact​.get­Phones()</code></a></li>
<li><a href="../../../../../../../serialized-form.html#org.apache.sis.metadata.iso.citation.DefaultTelephone">Serialized Form</a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.sis.metadata.ModifiableMetadata">Nested classes/interfaces inherited from class&nbsp;<a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h2>
<code><a href="../../ModifiableMetadata.State.html" title="enum class in org.apache.sis.metadata">Modifiable­Metadata​.State</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-ISOMetadata">Fields inherited from class&nbsp;<a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3>
<code><a href="../ISOMetadata.html#identifiers">identifiers</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Default­Telephone</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs a default telephone.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.opengis.metadata.citation.Telephone)" class="member-name-link">Default­Telephone</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Telephone</a>&nbsp;object)</code></div>
<div class="col-last odd-row-color">
<div class="block">Constructs a new instance initialized with the values from the specified metadata object.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DefaultTelephone.html" title="class in org.apache.sis.metadata.iso.citation">Default­Telephone</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#castOrCopy(org.opengis.metadata.citation.Telephone)" class="member-name-link">cast­Or­Copy</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Telephone</a>&nbsp;object)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns a SIS metadata implementation with the values of the given arbitrary implementation.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getFacsimiles()" class="member-name-link">get­Facsimiles</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">As of ISO 19115:2014, replaced by a <a href="#getNumber()">number</a>
code <code>Telephone­Type​.FACSIMILE</code>.</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumber()" class="member-name-link">get­Number</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the telephone number by which individuals can contact responsible organization or individual.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/CodeList.html" title="class or interface in org.opengis.util" class="external-link">Code­List</a><wbr>&lt;?&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumberType()" class="member-name-link">get­Number­Type</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the type of telephone number, or <code>null</code> if none.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getVoices()" class="member-name-link">get­Voices</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">As of ISO 19115:2014, replaced by a <a href="#getNumber()">number</a>
with <code>Telephone­Type​.VOICE</code>.</div>
</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setFacsimiles(java.util.Collection)" class="member-name-link">set­Facsimiles</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;? extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;new­Values)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">As of ISO 19115:2014, replaced by a <a href="#setNumber(java.lang.String)">number</a>
with <code>Telephone­Type​.FACSIMILE</code>.</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNumber(java.lang.String)" class="member-name-link">set­Number</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;new­Value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the telephone number by which individuals can contact responsible organization or individual.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNumberType(org.opengis.util.CodeList)" class="member-name-link">set­Number­Type</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/CodeList.html" title="class or interface in org.opengis.util" class="external-link">Code­List</a>&lt;?&gt;&nbsp;new­Value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the type of telephone number.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setVoices(java.util.Collection)" class="member-name-link">set­Voices</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;? extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;new­Values)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">As of ISO 19115:2014, replaced by a <a href="#setNumber(java.lang.String)">number</a>
code <code>Telephone­Type​.VOICE</code>.</div>
</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-ISOMetadata">Methods inherited from class&nbsp;<a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3>
<code><a href="../ISOMetadata.html#getIdentifier()">get­Identifier</a>, <a href="../ISOMetadata.html#getIdentifierMap()">get­Identifier­Map</a>, <a href="../ISOMetadata.html#getIdentifiers()">get­Identifiers</a>, <a href="../ISOMetadata.html#getStandard()">get­Standard</a>, <a href="../ISOMetadata.html#setIdentifier(org.opengis.metadata.Identifier)">set­Identifier</a>, <a href="../ISOMetadata.html#transitionTo(org.apache.sis.metadata.ModifiableMetadata.State)">transition­To</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-ModifiableMetadata">Methods inherited from class&nbsp;<a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h3>
<code><a href="../../ModifiableMetadata.html#checkWritePermission(java.lang.Object)">check­Write­Permission</a>, <a href="../../ModifiableMetadata.html#collectionType(java.lang.Class)">collection­Type</a>, <a href="../../ModifiableMetadata.html#copyCollection(java.util.Collection,java.lang.Class)">copy­Collection</a>, <a href="../../ModifiableMetadata.html#copyList(java.util.Collection,java.lang.Class)">copy­List</a>, <a href="../../ModifiableMetadata.html#copyMap(java.util.Map,java.lang.Class)">copy­Map</a>, <a href="../../ModifiableMetadata.html#copySet(java.util.Collection,java.lang.Class)">copy­Set</a>, <a href="../../ModifiableMetadata.html#deepCopy(org.apache.sis.metadata.ModifiableMetadata.State)">deep­Copy</a>, <a href="../../ModifiableMetadata.html#nonNullCollection(java.util.Collection,java.lang.Class)">non­Null­Collection</a>, <a href="../../ModifiableMetadata.html#nonNullList(java.util.List,java.lang.Class)">non­Null­List</a>, <a href="../../ModifiableMetadata.html#nonNullMap(java.util.Map,java.lang.Class)">non­Null­Map</a>, <a href="../../ModifiableMetadata.html#nonNullSet(java.util.Set,java.lang.Class)">non­Null­Set</a>, <a href="../../ModifiableMetadata.html#singleton(E,java.lang.Class)">singleton</a>, <a href="../../ModifiableMetadata.html#state()">state</a>, <a href="../../ModifiableMetadata.html#writeCollection(java.util.Collection,java.util.Collection,java.lang.Class)">write­Collection</a>, <a href="../../ModifiableMetadata.html#writeList(java.util.Collection,java.util.List,java.lang.Class)">write­List</a>, <a href="../../ModifiableMetadata.html#writeMap(java.util.Map,java.util.Map,java.lang.Class)">write­Map</a>, <a href="../../ModifiableMetadata.html#writeSet(java.util.Collection,java.util.Set,java.lang.Class)">write­Set</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-AbstractMetadata">Methods inherited from class&nbsp;<a href="../../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a></h3>
<code><a href="../../AbstractMetadata.html#asMap()">as­Map</a>, <a href="../../AbstractMetadata.html#asTreeTable()">as­Tree­Table</a>, <a href="../../AbstractMetadata.html#equals(java.lang.Object)">equals</a>, <a href="../../AbstractMetadata.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a>, <a href="../../AbstractMetadata.html#getInterface()">get­Interface</a>, <a href="../../AbstractMetadata.html#hashCode()">hash­Code</a>, <a href="../../AbstractMetadata.html#isEmpty()">is­Empty</a>, <a href="../../AbstractMetadata.html#prune()">prune</a>, <a href="../../AbstractMetadata.html#toString()">to­String</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>DefaultTelephone</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DefaultTelephone</span>()</div>
<div class="block">Constructs a default telephone.</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.opengis.metadata.citation.Telephone)">
<h3>DefaultTelephone</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DefaultTelephone</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Telephone</a>&nbsp;object)</span></div>
<div class="block">Constructs a new instance initialized with the values from the specified metadata object.
This is a <em>shallow</em> copy constructor, because the other metadata contained in the
given object are not recursively copied.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>object</code> - the metadata to copy values from, or <code>null</code> if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="#castOrCopy(org.opengis.metadata.citation.Telephone)"><code>cast­Or­Copy(Telephone)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="castOrCopy(org.opengis.metadata.citation.Telephone)">
<h3>castOrCopy</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="DefaultTelephone.html" title="class in org.apache.sis.metadata.iso.citation">DefaultTelephone</a></span>&nbsp;<span class="element-name">castOrCopy</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Telephone</a>&nbsp;object)</span></div>
<div class="block">Returns a SIS metadata 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 already an instance of
<code>Default­Telephone</code>, then it is returned unchanged.</li>
<li>Otherwise a new <code>Default­Telephone</code> instance is created using the
<a href="#%3Cinit%3E(org.opengis.metadata.citation.Telephone)">copy constructor</a> and returned.
Note that this is a <em>shallow</em> copy operation, because the other
metadata contained in the given object are not recursively copied.</li>
</ul></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>object</code> - the object to get as a SIS implementation, or <code>null</code> if none.</dd>
<dt>Returns:</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>
</section>
</li>
<li>
<section class="detail" id="getNumber()">
<h3>getNumber</h3>
<div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="number",
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#MANDATORY" title="class or interface in org.opengis.annotation" class="external-link">MANDATORY</a>,
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>)
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getNumber</span>()</div>
<div class="block">Returns the telephone number by which individuals can contact responsible organization or individual.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>telephone number by which individuals can contact responsible organization or individual.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setNumber(java.lang.String)">
<h3>setNumber</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setNumber</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;newValue)</span></div>
<div class="block">Sets the telephone number by which individuals can contact responsible organization or individual.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Value</code> - the new telephone number by which individuals can contact responsible organization or individual.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNumberType()">
<h3>getNumberType</h3>
<div class="member-signature"><span class="annotations"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html" title="class or interface in org.opengis.annotation" class="external-link">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#identifier()" title="class or interface in org.opengis.annotation" class="external-link">identifier</a>="numberType",
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#obligation()" title="class or interface in org.opengis.annotation" class="external-link">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Obligation.html#OPTIONAL" title="class or interface in org.opengis.annotation" class="external-link">OPTIONAL</a>,
<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/UML.html#specification()" title="class or interface in org.opengis.annotation" class="external-link">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/annotation/Specification.html#ISO_19115" title="class or interface in org.opengis.annotation" class="external-link">ISO_19115</a>)
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/CodeList.html" title="class or interface in org.opengis.util" class="external-link">CodeList</a>&lt;?&gt;</span>&nbsp;<span class="element-name">getNumberType</span>()</div>
<div class="block">Returns the type of telephone number, or <code>null</code> if none.
If non-null, the type can be <code>"VOICE"</code>, <code>"FACSIMILE"</code> or <code>"SMS"</code>.
<div class="warning"><b>Upcoming API change — specialization</b><br>
The return type will be changed to the <code>Telephone­Type</code> code list
when GeoAPI will provide it (tentatively in GeoAPI 3.1).
</div></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>type of telephone number, or <code>null</code> if none.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setNumberType(org.opengis.util.CodeList)">
<h3>setNumberType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setNumberType</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/CodeList.html" title="class or interface in org.opengis.util" class="external-link">CodeList</a>&lt;?&gt;&nbsp;newValue)</span></div>
<div class="block">Sets the type of telephone number.
If non-null, the type can only be <code>"VOICE"</code>, <code>"FACSIMILE"</code> or <code>"SMS"</code>.
<div class="warning"><b>Upcoming API change — specialization</b><br>
The argument type will be changed to the <code>Telephone­Type</code> code list when GeoAPI will provide it
(tentatively in GeoAPI 3.1). In the meantime, users can define their own code list class as below:
<div class="snippet-container"><button class="copy snippet-copy" aria-label="Copy snippet" onclick="copySnippet(this)"><span data-copied="Copied!">Copy</span><img src="../../../../../../../copy.svg" alt="Copy snippet"></button>
<pre class="snippet"><code class="language-java">final class UnsupportedCodeList extends CodeList&lt;UnsupportedCodeList&gt; {
private static final List&lt;UnsupportedCodeList&gt; VALUES = new ArrayList&lt;UnsupportedCodeList&gt;();
// Need to declare at least one code list element.
public static final UnsupportedCodeList MY_CODE_LIST = new UnsupportedCodeList("MY_CODE_LIST");
private UnsupportedCodeList(String name) {
super(name, VALUES);
}
public static UnsupportedCodeList valueOf(String code) {
return valueOf(UnsupportedCodeList.class, code);
}
@Override
public UnsupportedCodeList[] family() {
synchronized (VALUES) {
return VALUES.toArray(new UnsupportedCodeList[VALUES.size()]);
}
}
}
</code></pre>
</div>
</div></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Value</code> - the new type of telephone number.</dd>
<dt>Since:</dt>
<dd>0.5</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getVoices()">
<h3>getVoices</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link">since</a>="1.0")
</span><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getVoices</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">As of ISO 19115:2014, replaced by a <a href="#getNumber()">number</a>
with <code>Telephone­Type​.VOICE</code>.</div>
</div>
<div class="block">Returns the telephone numbers by which individuals can speak to the responsible organization or individual.
This method searches in the <a href="DefaultContact.html#getPhones()">contact phones</a>, if the contact that own
this phone is known.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html#getVoices()" title="class or interface in org.opengis.metadata.citation" class="external-link">get­Voices</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Telephone</a></code></dd>
<dt>Returns:</dt>
<dd>telephone numbers by which individuals can speak to the responsible organization or individual.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setVoices(java.util.Collection)">
<h3>setVoices</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link">since</a>="1.0")
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setVoices</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;? extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;newValues)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">As of ISO 19115:2014, replaced by a <a href="#setNumber(java.lang.String)">number</a>
code <code>Telephone­Type​.VOICE</code>.</div>
</div>
<div class="block">Sets the telephone numbers by which individuals can speak to the responsible organization or individual.
This method writes in the <a href="DefaultContact.html#getPhones()">contact phones</a>, if the contact that own
this phone is known.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Values</code> - the new telephone numbers, or <code>null</code> if none.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFacsimiles()">
<h3>getFacsimiles</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link">since</a>="1.0")
</span><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getFacsimiles</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">As of ISO 19115:2014, replaced by a <a href="#getNumber()">number</a>
code <code>Telephone­Type​.FACSIMILE</code>.</div>
</div>
<div class="block">Returns the telephone numbers of a facsimile machine for the responsible organization or individual.
This method searches in the <a href="DefaultContact.html#getPhones()">contact phones</a>, if the contact
that own this phone is known.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html#getFacsimiles()" title="class or interface in org.opengis.metadata.citation" class="external-link">get­Facsimiles</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/Telephone.html" title="class or interface in org.opengis.metadata.citation" class="external-link">Telephone</a></code></dd>
<dt>Returns:</dt>
<dd>telephone numbers of a facsimile machine for the responsible organization or individual.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setFacsimiles(java.util.Collection)">
<h3>setFacsimiles</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html#since()" title="class or interface in java.lang" class="external-link">since</a>="1.0")
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setFacsimiles</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;? extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;newValues)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">As of ISO 19115:2014, replaced by a <a href="#setNumber(java.lang.String)">number</a>
with <code>Telephone­Type​.FACSIMILE</code>.</div>
</div>
<div class="block">Sets the telephone number of a facsimile machine for the responsible organization or individual.
This method writes in the <a href="DefaultContact.html#getPhones()">contact phones</a>, if the contact
that own this phone is known.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>new­Values</code> - the new telephone number, or <code>null</code> if none.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>