static/apidocs/org/apache/sis/geometry/ImmutableEnvelope.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
 <title>ImmutableEnvelope (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.geometry.ImmutableEnvelope class">
 <meta name="keywords" content="castOrCopy()">
 <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="ImmutableEnvelope (Apache SIS 1.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 var pathtoroot = "../../../../";
 var useModuleDirectories = false;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/ImmutableEnvelope.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&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <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>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.sis.geometry</a></div>
 <h2 title="Class ImmutableEnvelope" class="title">Class ImmutableEnvelope</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li>
 <li>
 <ul class="inheritance">
 <li><a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></li>
 <li>
 <ul class="inheritance">
 <li><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></li>
 <li>
 <ul class="inheritance">
 <li>ImmutableEnvelope</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="../util/Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></dd>
 </dl>
 <hr>
 <pre>public final class <span class="typeNameLabel">ImmutableEnvelope</span>
 extends <a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a>
 implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></pre>
 <div class="block">An immutable <code>Envelope</code> (a minimum bounding box or rectangle) of arbitrary dimension.
  This class is final in order to ensure that the immutability contract can not be broken
  (assuming not using <cite>Java Native Interface</cite> or reflections).

  <div class="section">Immutability and thread safety</div>
  This final class is immutable and thus inherently thread-safe if the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink"><code>CoordinateReferenceSystem</code></a>
  instance given to the constructor is immutable. This is usually the case in Apache SIS.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>0.3</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../serialized-form.html#org.apache.sis.geometry.ImmutableEnvelope">Serialized Form</a></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">
 <!-- ======== 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">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Constructor</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(double%5B%5D,double%5B%5D,org.opengis.referencing.crs.CoordinateReferenceSystem)">ImmutableEnvelope</a></span>&#8203;(double[]&nbsp;lowerCorner,
                  double[]&nbsp;upperCorner,
                  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a>&nbsp;crs)</code></th>
 <td class="colLast">
 <div class="block">Constructs an envelope defined by two corners given as sequences of coordinate values.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.geometry.DirectPosition,org.opengis.geometry.DirectPosition)">ImmutableEnvelope</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/DirectPosition.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">DirectPosition</a>&nbsp;lowerCorner,
                  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/DirectPosition.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">DirectPosition</a>&nbsp;upperCorner)</code></th>
 <td class="colLast">
 <div class="block">Constructs an envelope defined by two corners given as direct positions.</div>
 </td>
 </tr>
 <tr class="altColor">
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.geometry.Envelope)">ImmutableEnvelope</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>&nbsp;envelope)</code></th>
 <td class="colLast">
 <div class="block">Creates an immutable envelope with the values of the given envelope.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.metadata.extent.GeographicBoundingBox)">ImmutableEnvelope</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicBoundingBox.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicBoundingBox</a>&nbsp;box)</code></th>
 <td class="colLast">
 <div class="block">Constructs a new envelope with the same data than the specified geographic bounding box.</div>
 </td>
 </tr>
 <tr class="altColor">
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.referencing.crs.CoordinateReferenceSystem,java.lang.CharSequence)">ImmutableEnvelope</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a>&nbsp;crs,
                  <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>&nbsp;wkt)</code></th>
 <td class="colLast">
 <div class="block">Constructs a new envelope initialized to the values parsed from the given string in
  <code>BOX</code> or <cite>Well Known Text</cite> (WKT) format.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.geometry.Envelope)">ImmutableEnvelope</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a>&nbsp;crs,
                  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>&nbsp;envelope)</code></th>
 <td class="colLast">
 <div class="block">Creates an immutable envelope with the coordinate values of the given envelope but
  a different CRS.</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>static <a href="ImmutableEnvelope.html" title="class in org.apache.sis.geometry">ImmutableEnvelope</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.geometry.Envelope)">castOrCopy</a></span>&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>&nbsp;envelope)</code></th>
 <td class="colLast">
 <div class="block">Returns the given envelope as an <code>ImmutableEnvelope</code> instance.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<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>&nbsp;object)</code></th>
 <td class="colLast">
 <div class="block">Returns <code>true</code> if the specified object is an envelope of the same class
  with equals coordinates and <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getCoordinateReferenceSystem()" title="class or interface in org.opengis.geometry" class="externalLink">CRS</a>.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCoordinateReferenceSystem()">getCoordinateReferenceSystem</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the envelope coordinate reference system, or <code>null</code> if unknown.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDimension()">getDimension</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the length of coordinate sequence (the number of entries) in this envelope.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLower(int)">getLower</a></span>&#8203;(int&nbsp;dimension)</code></th>
 <td class="colLast">
 <div class="block">Returns the limit in the direction of decreasing coordinate values in the specified dimension.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaximum(int)">getMaximum</a></span>&#8203;(int&nbsp;dimension)</code></th>
 <td class="colLast">
 <div class="block">Returns the maximal coordinate value for the specified dimension.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMedian(int)">getMedian</a></span>&#8203;(int&nbsp;dimension)</code></th>
 <td class="colLast">
 <div class="block">Returns the median coordinate along the specified dimension.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinimum(int)">getMinimum</a></span>&#8203;(int&nbsp;dimension)</code></th>
 <td class="colLast">
 <div class="block">Returns the minimal coordinate value for the specified dimension.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSpan(int)">getSpan</a></span>&#8203;(int&nbsp;dimension)</code></th>
 <td class="colLast">
 <div class="block">Returns the envelope span (typically width or height) along the specified dimension.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpper(int)">getUpper</a></span>&#8203;(int&nbsp;dimension)</code></th>
 <td class="colLast">
 <div class="block">Returns the limit in the direction of increasing coordinate values in the specified dimension.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns a hash value for this envelope.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAllNaN()">isAllNaN</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns <code>false</code> if at least one coordinate value is not <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#NaN" title="class or interface in java.lang" class="externalLink">NaN</a>.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Determines whether or not this envelope is empty.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Formats this envelope as a "<code>BOX</code>" element.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.AbstractEnvelope">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;<a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></h3>
 <code><a href="AbstractEnvelope.html#contains(org.opengis.geometry.DirectPosition)">contains</a>, <a href="AbstractEnvelope.html#contains(org.opengis.geometry.Envelope)">contains</a>, <a href="AbstractEnvelope.html#contains(org.opengis.geometry.Envelope,boolean)">contains</a>, <a href="AbstractEnvelope.html#equals(org.opengis.geometry.Envelope,double,boolean)">equals</a>, <a href="AbstractEnvelope.html#formatTo(org.apache.sis.io.wkt.Formatter)">formatTo</a>, <a href="AbstractEnvelope.html#getLowerCorner()">getLowerCorner</a>, <a href="AbstractEnvelope.html#getMedian()">getMedian</a>, <a href="AbstractEnvelope.html#getSpan(int,javax.measure.Unit)">getSpan</a>, <a href="AbstractEnvelope.html#getUpperCorner()">getUpperCorner</a>, <a href="AbstractEnvelope.html#intersects(org.opengis.geometry.Envelope)">intersects</a>, <a href="AbstractEnvelope.html#intersects(org.opengis.geometry.Envelope,boolean)">intersects</a>, <a href="AbstractEnvelope.html#toSimpleEnvelopes()">toSimpleEnvelopes</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.FormattableObject">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;<a href="../io/wkt/FormattableObject.html" title="class in org.apache.sis.io.wkt">FormattableObject</a></h3>
 <code><a href="../io/wkt/FormattableObject.html#print()">print</a>, <a href="../io/wkt/FormattableObject.html#toString(org.apache.sis.io.wkt.Convention)">toString</a>, <a href="../io/wkt/FormattableObject.html#toWKT()">toWKT</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a id="&lt;init&gt;(org.opengis.geometry.DirectPosition,org.opengis.geometry.DirectPosition)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ImmutableEnvelope</h4>
 <pre>public&nbsp;ImmutableEnvelope&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/DirectPosition.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">DirectPosition</a>&nbsp;lowerCorner,
                          <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/DirectPosition.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">DirectPosition</a>&nbsp;upperCorner)
                   throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/MismatchedDimensionException.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">MismatchedDimensionException</a>,
                          <a href="MismatchedReferenceSystemException.html" title="class in org.apache.sis.geometry">MismatchedReferenceSystemException</a></pre>
 <div class="block">Constructs an envelope defined by two corners given as direct positions.
  The envelope CRS will be the CRS of the given positions.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>lowerCorner</code> - the limits in the direction of decreasing coordinate values for each dimension.</dd>
 <dd><code>upperCorner</code> - the limits in the direction of increasing coordinate values for each dimension.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/MismatchedDimensionException.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">MismatchedDimensionException</a></code> - if the two positions do not have the same dimension.</dd>
 <dd><code><a href="MismatchedReferenceSystemException.html" title="class in org.apache.sis.geometry">MismatchedReferenceSystemException</a></code> - if the CRS of the two position are not equal.</dd>
 </dl>
 </li>
 </ul>
 <a id="&lt;init&gt;(double[],double[],org.opengis.referencing.crs.CoordinateReferenceSystem)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ImmutableEnvelope</h4>
 <pre>public&nbsp;ImmutableEnvelope&#8203;(double[]&nbsp;lowerCorner,
                          double[]&nbsp;upperCorner,
                          <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a>&nbsp;crs)
                   throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/MismatchedDimensionException.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">MismatchedDimensionException</a></pre>
 <div class="block">Constructs an envelope defined by two corners given as sequences of coordinate values.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>lowerCorner</code> - the limits in the direction of decreasing coordinate values for each dimension.</dd>
 <dd><code>upperCorner</code> - the limits in the direction of increasing coordinate values for each dimension.</dd>
 <dd><code>crs</code> - the CRS to assign to this envelope, or <code>null</code>.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/MismatchedDimensionException.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">MismatchedDimensionException</a></code> - if the two sequences do not have the same length, or
          if the dimension of the given CRS is not equals to the dimension of the given corners.</dd>
 </dl>
 </li>
 </ul>
 <a id="&lt;init&gt;(org.opengis.metadata.extent.GeographicBoundingBox)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ImmutableEnvelope</h4>
 <pre>public&nbsp;ImmutableEnvelope&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/extent/GeographicBoundingBox.html?is-external=true" title="class or interface in org.opengis.metadata.extent" class="externalLink">GeographicBoundingBox</a>&nbsp;box)</pre>
 <div class="block">Constructs a new envelope with the same data than the specified geographic bounding box.
  The coordinate reference system is set to the
  <a href="../referencing/CommonCRS.html#defaultGeographic()">default geographic CRS</a>.
  Axis order is (<var>longitude</var>, <var>latitude</var>).</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>box</code> - the bounding box to copy.</dd>
 </dl>
 </li>
 </ul>
 <a id="&lt;init&gt;(org.opengis.geometry.Envelope)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ImmutableEnvelope</h4>
 <pre>public&nbsp;ImmutableEnvelope&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>&nbsp;envelope)</pre>
 <div class="block">Creates an immutable envelope with the values of the given envelope.
  This constructor can be used when the given envelope is known to not
  be an instance of <code>ImmutableEnvelope</code>. In case of doubt,
  consider using <a href="#castOrCopy(org.opengis.geometry.Envelope)"><code>castOrCopy(Envelope)</code></a> instead.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>envelope</code> - the envelope to copy.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="#castOrCopy(org.opengis.geometry.Envelope)"><code>castOrCopy(Envelope)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="&lt;init&gt;(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.geometry.Envelope)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ImmutableEnvelope</h4>
 <pre>public&nbsp;ImmutableEnvelope&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a>&nbsp;crs,
                          <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>&nbsp;envelope)
                   throws <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/MismatchedDimensionException.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">MismatchedDimensionException</a></pre>
 <div class="block">Creates an immutable envelope with the coordinate values of the given envelope but
  a different CRS. This method does <strong>not</strong> reproject the given envelope.
  It just assign the given CRS to this envelope without any check, except for the CRS
  dimension.

  <p>The main purpose of this method is to assign a non-null CRS when the envelope to
  copy has a null CRS.</p></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>crs</code> - the CRS to assign to this envelope, or <code>null</code>.</dd>
 <dd><code>envelope</code> - the envelope from which to copy coordinate values.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/MismatchedDimensionException.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">MismatchedDimensionException</a></code> - if the dimension of the given CRS is not equals
          to the dimension of the given envelope.</dd>
 </dl>
 </li>
 </ul>
 <a id="&lt;init&gt;(org.opengis.referencing.crs.CoordinateReferenceSystem,java.lang.CharSequence)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>ImmutableEnvelope</h4>
 <pre>public&nbsp;ImmutableEnvelope&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a>&nbsp;crs,
                          <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>&nbsp;wkt)
                   throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a>,
                          <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/MismatchedDimensionException.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">MismatchedDimensionException</a></pre>
 <div class="block">Constructs a new envelope initialized to the values parsed from the given string in
  <code>BOX</code> or <cite>Well Known Text</cite> (WKT) format. The given string is typically
  a <code>BOX</code> element like below:

  <blockquote><pre>BOX(-180 -90, 180 90)</pre></blockquote>

  However this constructor is lenient to other geometry types like <code>POLYGON</code>.
  See the javadoc of the <a href="GeneralEnvelope.html#%3Cinit%3E(java.lang.CharSequence)"><code>GeneralEnvelope</code></a>
  constructor for more information.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>crs</code> - the coordinate reference system, or <code>null</code> if none.</dd>
 <dd><code>wkt</code> - the <code>BOX</code>, <code>POLYGON</code> or other kind of element to parse.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the given string can not be parsed.</dd>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/MismatchedDimensionException.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">MismatchedDimensionException</a></code> - if the dimension of the given CRS is not equals
          to the dimension of the parsed envelope.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="castOrCopy(org.opengis.geometry.Envelope)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>castOrCopy</h4>
 <pre class="methodSignature">public static&nbsp;<a href="ImmutableEnvelope.html" title="class in org.apache.sis.geometry">ImmutableEnvelope</a>&nbsp;castOrCopy&#8203;(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a>&nbsp;envelope)</pre>
 <div class="block">Returns the given envelope as an <code>ImmutableEnvelope</code> instance. If the given envelope
  is already an instance of <code>ImmutableEnvelope</code>, then it is returned unchanged.
  Otherwise the coordinate values and the CRS of the given envelope are copied in a
  new envelope.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>envelope</code> - the envelope to cast, or <code>null</code>.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the values of the given envelope as an <code>ImmutableEnvelope</code> instance.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="AbstractEnvelope.html#castOrCopy(org.opengis.geometry.Envelope)"><code>AbstractEnvelope.castOrCopy(Envelope)</code></a>,
 <a href="GeneralEnvelope.html#castOrCopy(org.opengis.geometry.Envelope)"><code>GeneralEnvelope.castOrCopy(Envelope)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="getDimension()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getDimension</h4>
 <pre class="methodSignature">public&nbsp;int&nbsp;getDimension()</pre>
 <div class="block">Returns the length of coordinate sequence (the number of entries) in this envelope.
  This information is available even when the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getCoordinateReferenceSystem()" title="class or interface in org.opengis.geometry" class="externalLink">coordinate reference system</a> is unknown.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">getDimension</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the dimensionality of this envelope.</dd>
 </dl>
 </li>
 </ul>
 <a id="getCoordinateReferenceSystem()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCoordinateReferenceSystem</h4>
 <pre class="methodSignature">public&nbsp;<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/crs/CoordinateReferenceSystem.html?is-external=true" title="class or interface in org.opengis.referencing.crs" class="externalLink">CoordinateReferenceSystem</a>&nbsp;getCoordinateReferenceSystem()</pre>
 <div class="block">Returns the envelope coordinate reference system, or <code>null</code> if unknown.
  If non-null, it shall be the same as <a href="AbstractEnvelope.html#getLowerCorner()">lower corner</a>
  and <a href="AbstractEnvelope.html#getUpperCorner()">upper corner</a> CRS.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getCoordinateReferenceSystem()" title="class or interface in org.opengis.geometry" class="externalLink">getCoordinateReferenceSystem</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the envelope CRS, or <code>null</code> if unknown.</dd>
 </dl>
 </li>
 </ul>
 <a id="getLower(int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getLower</h4>
 <pre class="methodSignature">public&nbsp;double&nbsp;getLower&#8203;(int&nbsp;dimension)
                 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></pre>
 <div class="block">Returns the limit in the direction of decreasing coordinate values in the specified dimension.
  This is usually the algebraic <a href="AbstractEnvelope.html#getMinimum(int)">minimum</a>, except if this envelope
  spans the anti-meridian.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#getLower(int)">getLower</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>dimension</code> - the dimension for which to obtain the coordinate value.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the starting coordinate value at the given dimension.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is negative or is equals or greater
          than the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">envelope dimension</a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="getUpper(int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getUpper</h4>
 <pre class="methodSignature">public&nbsp;double&nbsp;getUpper&#8203;(int&nbsp;dimension)
                 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></pre>
 <div class="block">Returns the limit in the direction of increasing coordinate values in the specified dimension.
  This is usually the algebraic <a href="AbstractEnvelope.html#getMaximum(int)">maximum</a>, except if this envelope
  spans the anti-meridian.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#getUpper(int)">getUpper</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>dimension</code> - the dimension for which to obtain the coordinate value.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the starting coordinate value at the given dimension.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is negative or is equals or greater
          than the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">envelope dimension</a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="getMinimum(int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMinimum</h4>
 <pre class="methodSignature">public&nbsp;double&nbsp;getMinimum&#8203;(int&nbsp;dimension)
                   throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></pre>
 <div class="block">Returns the minimal coordinate value for the specified dimension. In the typical case
  of non-empty envelopes <em>not</em> spanning the anti-meridian, this method returns the
  <a href="AbstractEnvelope.html#getLower(int)"><code>AbstractEnvelope.getLower(int)</code></a> value verbatim. In the case of envelope spanning the anti-meridian,
  this method returns the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystemAxis.html?is-external=true#getMinimumValue()" title="class or interface in org.opengis.referencing.cs" class="externalLink">axis minimum value</a>.
  If the range in the given dimension is invalid, then this method returns <code>NaN</code>.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getMinimum(int)" title="class or interface in org.opengis.geometry" class="externalLink">getMinimum</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></dd>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#getMinimum(int)">getMinimum</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>dimension</code> - the dimension for which to obtain the coordinate value.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the minimal coordinate value at the given dimension.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is negative or is equals or greater
          than the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">envelope dimension</a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="getMaximum(int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMaximum</h4>
 <pre class="methodSignature">public&nbsp;double&nbsp;getMaximum&#8203;(int&nbsp;dimension)
                   throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></pre>
 <div class="block">Returns the maximal coordinate value for the specified dimension. In the typical case
  of non-empty envelopes <em>not</em> spanning the anti-meridian, this method returns the
  <a href="AbstractEnvelope.html#getUpper(int)"><code>AbstractEnvelope.getUpper(int)</code></a> value verbatim. In the case of envelope spanning the anti-meridian,
  this method returns the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystemAxis.html?is-external=true#getMaximumValue()" title="class or interface in org.opengis.referencing.cs" class="externalLink">axis maximum value</a>.
  If the range in the given dimension is invalid, then this method returns <code>NaN</code>.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getMaximum(int)" title="class or interface in org.opengis.geometry" class="externalLink">getMaximum</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></dd>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#getMaximum(int)">getMaximum</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>dimension</code> - the dimension for which to obtain the coordinate value.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the maximal coordinate value at the given dimension.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is negative or is equals or greater
          than the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">envelope dimension</a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="getMedian(int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMedian</h4>
 <pre class="methodSignature">public&nbsp;double&nbsp;getMedian&#8203;(int&nbsp;dimension)
                  throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></pre>
 <div class="block">Returns the median coordinate along the specified dimension.
  In most cases, the result is equals (minus rounding error) to:

  <blockquote><pre>median = (<b>getUpper</b>(dimension) + <b>getLower</b>(dimension)) / 2;</pre></blockquote>

  <div class="section">Spanning the anti-meridian of a Geographic CRS</div>
  If <var>upper</var> &lt; <var>lower</var> and the
  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystemAxis.html?is-external=true#getRangeMeaning()" title="class or interface in org.opengis.referencing.cs" class="externalLink">range meaning</a> for the requested
  dimension is <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/RangeMeaning.html?is-external=true#WRAPAROUND" title="class or interface in org.opengis.referencing.cs" class="externalLink">wraparound</a>, then the median calculated
  above is actually in the middle of the space <em>outside</em> the envelope. In such cases,
  this method shifts the <var>median</var> value by half of the periodicity (180° in the
  longitude case) in order to switch from <cite>outer</cite> space to <cite>inner</cite>
  space. If the axis range meaning is not <code>WRAPAROUND</code>, then this method returns
  <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#NaN" title="class or interface in java.lang" class="externalLink"><code>NaN</code></a>.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getMedian(int)" title="class or interface in org.opengis.geometry" class="externalLink">getMedian</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></dd>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#getMedian(int)">getMedian</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>dimension</code> - the dimension for which to obtain the coordinate value.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the median coordinate at the given dimension, or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#NaN" title="class or interface in java.lang" class="externalLink"><code>Double.NaN</code></a>.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is negative or is equals or greater
          than the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">envelope dimension</a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="getSpan(int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSpan</h4>
 <pre class="methodSignature">public&nbsp;double&nbsp;getSpan&#8203;(int&nbsp;dimension)
                throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></pre>
 <div class="block">Returns the envelope span (typically width or height) along the specified dimension.
  In most cases, the result is equals (minus rounding error) to:

  <blockquote><pre>span = <b>getUpper</b>(dimension) - <b>getLower</b>(dimension);</pre></blockquote>

  <div class="section">Spanning the anti-meridian of a Geographic CRS</div>
  If <var>upper</var> &lt; <var>lower</var> and the
  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/CoordinateSystemAxis.html?is-external=true#getRangeMeaning()" title="class or interface in org.opengis.referencing.cs" class="externalLink">range meaning</a> for the requested
  dimension is <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/referencing/cs/RangeMeaning.html?is-external=true#WRAPAROUND" title="class or interface in org.opengis.referencing.cs" class="externalLink">wraparound</a>, then the span calculated
  above is negative. In such cases, this method adds the periodicity (typically 360° of
  longitude) to the span. If the result is a positive number, it is returned. Otherwise
  this method returns <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#NaN" title="class or interface in java.lang" class="externalLink"><code>NaN</code></a>.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getSpan(int)" title="class or interface in org.opengis.geometry" class="externalLink">getSpan</a></code>&nbsp;in interface&nbsp;<code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink">Envelope</a></code></dd>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#getSpan(int)">getSpan</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>dimension</code> - the dimension for which to obtain the span.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the span (typically width or height) at the given dimension, or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#NaN" title="class or interface in java.lang" class="externalLink"><code>Double.NaN</code></a>.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the given index is negative or is equals or greater
          than the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">envelope dimension</a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="isEmpty()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isEmpty</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;isEmpty()</pre>
 <div class="block">Determines whether or not this envelope is empty. An envelope is empty if it has zero
  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">dimension</a>, or if the <a href="AbstractEnvelope.html#getSpan(int)">span</a> of
  at least one axis is negative, 0 or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#NaN" title="class or interface in java.lang" class="externalLink"><code>NaN</code></a>.

  <div class="note"><b>Note:</b>
  Strictly speaking, there is an ambiguity if a span is <code>NaN</code> or if the envelope contains
  both 0 and infinite spans (since 0⋅∞ = <code>NaN</code>). In such cases, this method arbitrarily
  ignores the infinite values and returns <code>true</code>.</div>

  If <code>isEmpty()</code> returns <code>false</code>, then <a href="AbstractEnvelope.html#isAllNaN()"><code>AbstractEnvelope.isAllNaN()</code></a> is guaranteed to
  also return <code>false</code>. However the converse is not always true.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../util/Emptiable.html#isEmpty()">isEmpty</a></code>&nbsp;in interface&nbsp;<code><a href="../util/Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a></code></dd>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#isEmpty()">isEmpty</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if this envelope is empty.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../metadata/iso/extent/DefaultGeographicBoundingBox.html#isEmpty()"><code>DefaultGeographicBoundingBox.isEmpty()</code></a>,
 <a href="https://docs.oracle.com/javase/8/docs/api/java/awt/geom/RectangularShape.html?is-external=true#isEmpty()" title="class or interface in java.awt.geom" class="externalLink"><code>RectangularShape.isEmpty()</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="isAllNaN()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isAllNaN</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;isAllNaN()</pre>
 <div class="block">Returns <code>false</code> if at least one coordinate value is not <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#NaN" title="class or interface in java.lang" class="externalLink">NaN</a>.
  This <code>isAllNaN()</code> check is different than the <a href="AbstractEnvelope.html#isEmpty()"><code>AbstractEnvelope.isEmpty()</code></a> check since it
  returns <code>false</code> for a partially initialized envelope, while <code>isEmpty()</code>
  returns <code>false</code> only after all dimensions have been initialized.
  More specifically, the following rules apply:

  <ul>
    <li>If <code>isAllNaN() == true</code>, then <code>isEmpty() == true</code></li>
    <li>If <code>isEmpty() == false</code>, then <code>isAllNaN() == false</code></li>
    <li>The converse of the above-cited rules are not always true.</li>
  </ul>

  Note that an all-NaN envelope can still have a non-null
  <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getCoordinateReferenceSystem()" title="class or interface in org.opengis.geometry" class="externalLink">coordinate reference system</a>.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#isAllNaN()">isAllNaN</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if this envelope has NaN values.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="GeneralEnvelope.html#setToNaN()"><code>GeneralEnvelope.setToNaN()</code></a>,
 <a href="../metadata/iso/extent/DefaultGeographicBoundingBox.html#isEmpty()"><code>DefaultGeographicBoundingBox.isEmpty()</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="hashCode()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>hashCode</h4>
 <pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
 <div class="block">Returns a hash value for this envelope.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#hashCode()">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="equals(java.lang.Object)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>equals</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<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>&nbsp;object)</pre>
 <div class="block">Returns <code>true</code> if the specified object is an envelope of the same class
  with equals coordinates and <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getCoordinateReferenceSystem()" title="class or interface in org.opengis.geometry" class="externalLink">CRS</a>.

  <div class="note"><b>Implementation note:</b>
  This implementation requires that the provided <code>object</code> argument is of the same class than this envelope.
  We do not relax this rule since not every implementations in the SIS code base follow the same contract.</div></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#equals(java.lang.Object)">equals</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>object</code> - the object to compare with this envelope.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if the given object is equal to this envelope.</dd>
 </dl>
 </li>
 </ul>
 <a id="toString()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>toString</h4>
 <pre class="methodSignature">public&nbsp;<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>&nbsp;toString()</pre>
 <div class="block">Formats this envelope as a "<code>BOX</code>" element.
  The output is of the form "<code>BOX</code><var>n</var><code>D(</code><a href="AbstractEnvelope.html#getLowerCorner()">lower corner</a><code>,</code><a href="AbstractEnvelope.html#getUpperCorner()">upper corner</a><code>)</code>"
  where <var>n</var> is the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/geometry/Envelope.html?is-external=true#getDimension()" title="class or interface in org.opengis.geometry" class="externalLink">number of dimensions</a>.
  The number of dimension is written only if different than 2.

  <div class="note"><b>Example:</b>
    <ul>
      <li><code>BOX(-90 -180, 90 180)</code></li>
      <li><code>BOX3D(-90 -180 0, 90 180 1)</code></li>
    </ul>
  </div>

  <div class="note"><b>Note:</b>
  The <code>BOX</code> element is not part of the standard <cite>Well Known Text</cite> (WKT) format.
  However it is understood by many software libraries, for example GDAL and PostGIS.</div>

  This method formats the numbers as with <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#toString(double)" title="class or interface in java.lang" class="externalLink"><code>Double.toString(double)</code></a> (i.e. without fixed number of fraction digits).
  The string returned by this method can be <a href="GeneralEnvelope.html#%3Cinit%3E(java.lang.CharSequence)">parsed</a>
  by the <code>GeneralEnvelope</code> constructor.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="AbstractEnvelope.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEnvelope.html" title="class in org.apache.sis.geometry">AbstractEnvelope</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>this envelope as a <code>BOX</code> or <code>BOX3D</code> (most typical dimensions) element.</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/ImmutableEnvelope.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&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <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>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>