blob: 8609b1e0c24fb25ad71210c5f0ee3b3999881867 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>Localized (Apache SIS 1.3 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="description" content="declaration: package: org.apache.sis.util, interface: Localized">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.util.Localized interface">
<meta name="keywords" content="getLocale()">
<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">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.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="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/Localized.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#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="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.util</a></div>
<h1 title="Interface Localized" class="title">Interface Localized</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../measure/AngleFormat.html" title="class in org.apache.sis.measure">Angle­Format</a></code>, <code><a href="../feature/builder/AssociationRoleBuilder.html" title="class in org.apache.sis.feature.builder">Association­Role­Builder</a></code>, <code><a href="../feature/builder/AttributeTypeBuilder.html" title="class in org.apache.sis.feature.builder">Attribute­Type­Builder</a></code>, <code><a href="../portrayal/Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></code>, <code><a href="../storage/event/CascadedStoreEvent.html" title="class in org.apache.sis.storage.event">Cascaded­Store­Event</a></code>, <code><a href="../feature/builder/CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a></code>, <code><a href="../storage/event/CloseEvent.html" title="class in org.apache.sis.storage.event">Close­Event</a></code>, <code><a href="../io/CompoundFormat.html" title="class in org.apache.sis.io">Compound­Format</a></code>, <code><a href="../geometry/CoordinateFormat.html" title="class in org.apache.sis.geometry">Coordinate­Format</a></code>, <code><a href="../gui/coverage/CoverageCanvas.html" title="class in org.apache.sis.gui.coverage">Coverage­Canvas</a></code>, <code><a href="../gui/coverage/CoverageExplorer.html" title="class in org.apache.sis.gui.coverage">Coverage­Explorer</a></code>, <code><a href="../storage/DataStore.html" title="class in org.apache.sis.storage">Data­Store</a></code>, <code><a href="../referencing/factory/sql/EPSGDataAccess.html" title="class in org.apache.sis.referencing.factory.sql">EPSGData­Access</a></code>, <code><a href="../referencing/factory/sql/EPSGFactory.html" title="class in org.apache.sis.referencing.factory.sql">EPSGFactory</a></code>, <code><a href="../feature/FeatureFormat.html" title="class in org.apache.sis.feature">Feature­Format</a></code>, <code><a href="../feature/builder/FeatureTypeBuilder.html" title="class in org.apache.sis.feature.builder">Feature­Type­Builder</a></code>, <code><a href="../io/wkt/Formatter.html" title="class in org.apache.sis.io.wkt">Formatter</a></code>, <code><a href="../storage/geotiff/GeoTiffStore.html" title="class in org.apache.sis.storage.geotiff">Geo­Tiff­Store</a></code>, <code><a href="../gui/coverage/GridSliceSelector.html" title="class in org.apache.sis.gui.coverage">Grid­Slice­Selector</a></code>, <code><a href="../referencing/factory/IdentifiedObjectSet.html" title="class in org.apache.sis.referencing.factory">Identified­Object­Set</a></code>, <code><a href="../gui/coverage/ImagePropertyExplorer.html" title="class in org.apache.sis.gui.coverage">Image­Property­Explorer</a></code>, <code>Indexed­Resource­Bundle</code>, <code><a href="../storage/landsat/LandsatStore.html" title="class in org.apache.sis.storage.landsat">Landsat­Store</a></code>, <code><a href="../referencing/gazetteer/LocationFormat.html" title="class in org.apache.sis.referencing.gazetteer">Location­Format</a></code>, <code><a href="../gui/dataset/LogViewer.html" title="class in org.apache.sis.gui.dataset">Log­Viewer</a></code>, <code><a href="../gui/map/MapCanvas.html" title="class in org.apache.sis.gui.map">Map­Canvas</a></code>, <code><a href="../gui/map/MapCanvasAWT.html" title="class in org.apache.sis.gui.map">Map­Canvas­AWT</a></code>, <code><a href="../gui/metadata/MetadataSummary.html" title="class in org.apache.sis.gui.metadata">Metadata­Summary</a></code>, <code><a href="../storage/netcdf/NetcdfStore.html" title="class in org.apache.sis.storage.netcdf">Netcdf­Store</a></code>, <code><a href="../setup/OptionalInstallations.html" title="class in org.apache.sis.setup">Optional­Installations</a></code>, <code><a href="../parameter/ParameterFormat.html" title="class in org.apache.sis.parameter">Parameter­Format</a></code>, <code><a href="../portrayal/PlanarCanvas.html" title="class in org.apache.sis.portrayal">Planar­Canvas</a></code>, <code><a href="../feature/builder/PropertyTypeBuilder.html" title="class in org.apache.sis.feature.builder">Property­Type­Builder</a></code>, <code><a href="../measure/RangeFormat.html" title="class in org.apache.sis.measure">Range­Format</a></code>, <code><a href="../gui/dataset/ResourceExplorer.html" title="class in org.apache.sis.gui.dataset">Resource­Explorer</a></code>, <code><a href="../cloud/aws/internal/Resources.html" title="class in org.apache.sis.cloud.aws.internal">Resources</a></code>, <code><a href="../console/ResourcesDownloader.html" title="class in org.apache.sis.console">Resources­Downloader</a></code>, <code><a href="../storage/sql/SQLStore.html" title="class in org.apache.sis.storage.sql">SQLStore</a></code>, <code><a href="../math/StatisticsFormat.html" title="class in org.apache.sis.math">Statistics­Format</a></code>, <code><a href="../gui/map/StatusBar.html" title="class in org.apache.sis.gui.map">Status­Bar</a></code>, <code><a href="../storage/event/StoreEvent.html" title="class in org.apache.sis.storage.event">Store­Event</a></code>, <code><a href="../storage/event/StoreListeners.html" title="class in org.apache.sis.storage.event">Store­Listeners</a></code>, <code><a href="../io/wkt/Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></code>, <code><a href="../io/TabularFormat.html" title="class in org.apache.sis.io">Tabular­Format</a></code>, <code><a href="collection/TreeTableFormat.html" title="class in org.apache.sis.util.collection">Tree­Table­Format</a></code>, <code><a href="../feature/builder/TypeBuilder.html" title="class in org.apache.sis.feature.builder">Type­Builder</a></code>, <code><a href="../measure/UnitFormat.html" title="class in org.apache.sis.measure">Unit­Format</a></code>, <code><a href="../storage/event/WarningEvent.html" title="class in org.apache.sis.storage.event">Warning­Event</a></code>, <code><a href="../io/wkt/Warnings.html" title="class in org.apache.sis.io.wkt">Warnings</a></code>, <code><a href="../gui/Widget.html" title="class in org.apache.sis.gui">Widget</a></code>, <code><a href="../io/wkt/WKTFormat.html" title="class in org.apache.sis.io.wkt">WKTFormat</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Localized</span></div>
<div class="block">Interface of classes for which each instance is configured for a particular locale.
Those classes are often parsers or formatters.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.3</dd>
<p><font size="-1">Defined in the <code>sis-utility</code> module</font></p>
</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="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLocale()" class="member-name-link">get­Locale</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the locale of the implemented service.</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="getLocale()">
<h3>getLocale</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></span>&nbsp;<span class="element-name">getLocale</span>()</div>
<div class="block">Returns the locale of the implemented service. Some implementations may return
<code>null</code> if no locale is explicitly defined. The meaning of null locale is
implementation-dependent, but typical interpretations are:
<ul>
<li>A synonymous of the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html#getDefault()" title="class or interface in java.util" class="external-link">system default locale</a>.</li>
<li>A synonymous of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html#ROOT" title="class or interface in java.util" class="external-link"><code>Locale​.ROOT</code></a> for an "unlocalized" service. For example, the
service may format numbers using <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Double.html#toString(double)" title="class or interface in java.lang" class="external-link"><code>Double​.to­String(double)</code></a> instead of
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/NumberFormat.html" title="class or interface in java.text" class="external-link"><code>Number­Format</code></a>.</li>
</ul>
Implementations are encouraged to return a non-null value in every cases.
Nevertheless client codes should be prepared to receive null values.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the locale, or <code>null</code> if not explicitly defined.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>