sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1583772 - /sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java
Date Tue, 01 Apr 2014 20:10:54 GMT
Author: desruisseaux
Date: Tue Apr  1 20:10:54 2014
New Revision: 1583772

URL: http://svn.apache.org/r1583772
Log:
Added a warning in javadoc of contains(Envelope, boolean) and intersects(Envelope, boolean)
methods
that their API may change (see SIS-172 for this issue). Users are advised to use contains(Envelope)
and intersects(Envelope) instead for API stability.

Modified:
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java

Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java?rev=1583772&r1=1583771&r2=1583772&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java
[UTF-8] Tue Apr  1 20:10:54 2014
@@ -728,7 +728,6 @@ public abstract class AbstractEnvelope i
 
     /**
      * Returns {@code true} if this envelope completely encloses the specified envelope.
-     * All edges of this envelope are considered inclusive.
      *
      * {@section Pre-conditions}
      * This method assumes that the specified envelope uses the same CRS than this envelope.
@@ -750,7 +749,7 @@ public abstract class AbstractEnvelope i
      *
      * @since 0.4
      */
-    public final boolean contains(final Envelope envelope) throws MismatchedDimensionException
{
+    public boolean contains(final Envelope envelope) throws MismatchedDimensionException
{
         return contains(envelope, true);
     }
 
@@ -763,6 +762,10 @@ public abstract class AbstractEnvelope i
      * <p>This method is subject to the same pre-conditions than {@link #contains(Envelope)},
      * and handles envelopes spanning the anti-meridian in the same way.</p>
      *
+     * <div class="warning"><b>Warning:</b> This method may change or be
removed in a future SIS version.
+     * For API stability, use the {@link #contains(Envelope)} method instead.
+     * See <a href="http://issues.apache.org/jira/browse/SIS-172">SIS-172</a>
for more information.</div>
+     *
      * @param  envelope The envelope to test for inclusion.
      * @param  edgesInclusive {@code true} if this envelope edges are inclusive.
      * @return {@code true} if this envelope completely encloses the specified one.
@@ -843,7 +846,6 @@ public abstract class AbstractEnvelope i
 
     /**
      * Returns {@code true} if this envelope intersects the specified envelope.
-     * All edges of this envelope are considered inclusive.
      *
      * {@section Pre-conditions}
      * This method assumes that the specified envelope uses the same CRS than this envelope.
@@ -874,6 +876,10 @@ public abstract class AbstractEnvelope i
      * <p>This method is subject to the same pre-conditions than {@link #intersects(Envelope)},
      * and handles envelopes spanning the anti-meridian in the same way.</p>
      *
+     * <div class="warning"><b>Warning:</b> This method may change or be
removed in a future SIS version.
+     * For API stability, use the {@link #intersects(Envelope)} method instead.
+     * See <a href="http://issues.apache.org/jira/browse/SIS-172">SIS-172</a>
for more information.</div>
+     *
      * @param  envelope The envelope to test for intersection.
      * @param  edgesInclusive {@code true} if this envelope edges are inclusive.
      * @return {@code true} if this envelope intersects the specified one.



Mime
View raw message