org.apache.sis.util/org/apache/sis/util/Deprecable.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
 <title>Deprecable (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.util, package: org.apache.sis.util, interface: Deprecable">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.util.Deprecable interface">
 <meta name="keywords" content="isDeprecated()">
 <meta name="keywords" content="getRemarks()">
 <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>Nested</li>
 <li>Field</li>
 <li>Constr</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li>Field</li>
 <li>Constr</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>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&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>Constr&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.util</a></div>
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.util</a></div>
 <h1 title="Interface Deprecable" class="title">Interface Deprecable</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/operation/AbstractCoordinateOperation.html" title="class in org.apache.sis.referencing.operation">AbstractCoordinateOperation</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">AbstractCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/AbstractCS.html" title="class in org.apache.sis.referencing.cs">AbstractCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/datum/AbstractDatum.html" title="class in org.apache.sis.referencing.datum">AbstractDatum</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing">AbstractIdentifiedObject</a></code>, <code><a href="../../../../../org.apache.sis.feature/org/apache/sis/feature/AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></code>, <code><a href="../../../../../org.apache.sis.feature/org/apache/sis/feature/AbstractOperation.html" title="class in org.apache.sis.feature">AbstractOperation</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/parameter/AbstractParameterDescriptor.html" title="class in org.apache.sis.parameter">AbstractParameterDescriptor</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractReferenceSystem.html" title="class in org.apache.sis.referencing">AbstractReferenceSystem</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultAffineCS.html" title="class in org.apache.sis.referencing.cs">DefaultAffineCS</a></code>, <code><a href="../../../../../org.apache.sis.feature/org/apache/sis/feature/DefaultAssociationRole.html" title="class in org.apache.sis.feature">DefaultAssociationRole</a></code>, <code><a href="../../../../../org.apache.sis.feature/org/apache/sis/feature/DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultCartesianCS.html" title="class in org.apache.sis.referencing.cs">DefaultCartesianCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultCompoundCRS.html" title="class in org.apache.sis.referencing.crs">DefaultCompoundCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultCompoundCS.html" title="class in org.apache.sis.referencing.cs">DefaultCompoundCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/operation/DefaultConversion.html" title="class in org.apache.sis.referencing.operation">DefaultConversion</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultCoordinateSystemAxis.html" title="class in org.apache.sis.referencing.cs">DefaultCoordinateSystemAxis</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultCylindricalCS.html" title="class in org.apache.sis.referencing.cs">DefaultCylindricalCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultDerivedCRS.html" title="class in org.apache.sis.referencing.crs">DefaultDerivedCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/datum/DefaultEllipsoid.html" title="class in org.apache.sis.referencing.datum">DefaultEllipsoid</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultEllipsoidalCS.html" title="class in org.apache.sis.referencing.cs">DefaultEllipsoidalCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultEngineeringCRS.html" title="class in org.apache.sis.referencing.crs">DefaultEngineeringCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/datum/DefaultEngineeringDatum.html" title="class in org.apache.sis.referencing.datum">DefaultEngineeringDatum</a></code>, <code><a href="../../../../../org.apache.sis.feature/org/apache/sis/feature/DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultGeocentricCRS.html" title="class in org.apache.sis.referencing.crs">DefaultGeocentricCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/datum/DefaultGeodeticDatum.html" title="class in org.apache.sis.referencing.datum">DefaultGeodeticDatum</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultGeographicCRS.html" title="class in org.apache.sis.referencing.crs">DefaultGeographicCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultImageCRS.html" title="class in org.apache.sis.referencing.crs">DefaultImageCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/datum/DefaultImageDatum.html" title="class in org.apache.sis.referencing.datum">DefaultImageDatum</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultLinearCS.html" title="class in org.apache.sis.referencing.cs">DefaultLinearCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/operation/DefaultOperationMethod.html" title="class in org.apache.sis.referencing.operation">DefaultOperationMethod</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/parameter/DefaultParameterDescriptor.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptor</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/parameter/DefaultParameterDescriptorGroup.html" title="class in org.apache.sis.parameter">DefaultParameterDescriptorGroup</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultParametricCRS.html" title="class in org.apache.sis.referencing.crs">DefaultParametricCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultParametricCS.html" title="class in org.apache.sis.referencing.cs">DefaultParametricCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/datum/DefaultParametricDatum.html" title="class in org.apache.sis.referencing.datum">DefaultParametricDatum</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/operation/DefaultPassThroughOperation.html" title="class in org.apache.sis.referencing.operation">DefaultPassThroughOperation</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultPolarCS.html" title="class in org.apache.sis.referencing.cs">DefaultPolarCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/datum/DefaultPrimeMeridian.html" title="class in org.apache.sis.referencing.datum">DefaultPrimeMeridian</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultProjectedCRS.html" title="class in org.apache.sis.referencing.crs">DefaultProjectedCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultSphericalCS.html" title="class in org.apache.sis.referencing.cs">DefaultSphericalCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultTemporalCRS.html" title="class in org.apache.sis.referencing.crs">DefaultTemporalCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/datum/DefaultTemporalDatum.html" title="class in org.apache.sis.referencing.datum">DefaultTemporalDatum</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultTimeCS.html" title="class in org.apache.sis.referencing.cs">DefaultTimeCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/operation/DefaultTransformation.html" title="class in org.apache.sis.referencing.operation">DefaultTransformation</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultUserDefinedCS.html" title="class in org.apache.sis.referencing.cs">DefaultUserDefinedCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/crs/DefaultVerticalCRS.html" title="class in org.apache.sis.referencing.crs">DefaultVerticalCRS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/cs/DefaultVerticalCS.html" title="class in org.apache.sis.referencing.cs">DefaultVerticalCS</a></code>, <code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/datum/DefaultVerticalDatum.html" title="class in org.apache.sis.referencing.datum">DefaultVerticalDatum</a></code>, <code><a href="../../../../../org.apache.sis.referencing.gazetteer/org/apache/sis/referencing/gazetteer/GeohashReferenceSystem.html" title="class in org.apache.sis.referencing.gazetteer">GeohashReferenceSystem</a></code>, <code><a href="../../../../../org.apache.sis.referencing.gazetteer/org/apache/sis/referencing/gazetteer/MilitaryGridReferenceSystem.html" title="class in org.apache.sis.referencing.gazetteer">MilitaryGridReferenceSystem</a></code>, <code><a href="../../../../../org.apache.sis.referencing.gazetteer/org/apache/sis/referencing/gazetteer/ReferencingByIdentifiers.html" title="class in org.apache.sis.referencing.gazetteer">ReferencingByIdentifiers</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Deprecable</span></div>
 <div class="block">Interface of classes for which deprecated instances may exist. Despite the name, the entities deprecated
  by this interface are unrelated to the entities deprecated by the Java <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"><code>Deprecated</code></a> annotation.
  This interface is for identifying deprecated <em>data</em> rather than language constructs.

  <h2 id="examples-heading">Examples</h2>
  When an error is discovered in the definition of a Coordinate Reference System (CRS) in the EPSG database,
  the EPSG maintainers do not change the data. Instead, they deprecate the erroneous definition and create a
  new one with a new EPSG code. The <a href="#isDeprecated()"><code>isDeprecated()</code></a> method in this interface allows users to identify
  CRS instances created from such deprecated database records, for example in order to log a warning when data
  are projected to a deprecated CRS.

  <p>Some examples of deprecated instances are:</p>

  <ul>
    <li>An <a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/AbstractIdentifiedObject.html" title="class in org.apache.sis.referencing"><code>AbstractIdentifiedObject</code></a> (typically a CRS)
        which has been built from a deprecated EPSG code.</li>
    <li>A <a href="../../../../../org.apache.sis.referencing/org/apache/sis/referencing/NamedIdentifier.html" title="class in org.apache.sis.referencing"><code>NamedIdentifier</code></a> containing the legacy name
        of an object which has been renamed.</li>
  </ul></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>0.3</dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRemarks()" class="member-name-link">getRemarks</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">If this instance is deprecated, the reason or the alternative to use.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isDeprecated()" class="member-name-link">isDeprecated</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Returns <code>true</code> if this instance is deprecated.</div>
 </div>
 </div>
 </div>
 </div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="isDeprecated()">
 <h3>isDeprecated</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isDeprecated</span>()</div>
 <div class="block">Returns <code>true</code> if this instance is deprecated.
  In such case, the <a href="#getRemarks()">remarks</a> may contain information about the new object to use.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd><code>true</code> if this instance is deprecated.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getRemarks()">
 <h3>getRemarks</h3>
 <div class="member-signature"><span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a></span>&nbsp;<span class="element-name">getRemarks</span>()</div>
 <div class="block">If this instance is deprecated, the reason or the alternative to use.
  Otherwise, an optional free text.

  <div class="note"><b>Example:</b> "superseded by code XYZ".</div></div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>comments about this instance, or <code>null</code> if none. Shall be the reason for deprecation
          or the alternative to use if this instance <a href="#isDeprecated()">is deprecated</a>.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 </div>
 </div>
 </body>
 </html>