sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1774417 - in /sis/branches/JDK8/core: sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/ sis-referencing/src/main/java/org/apache/sis/geometry/
Date Thu, 15 Dec 2016 11:29:57 GMT
Author: desruisseaux
Date: Thu Dec 15 11:29:57 2016
New Revision: 1774417

URL: http://svn.apache.org/viewvc?rev=1774417&view=rev
Log:
Javadoc formatting and add a @XmlTransient annotation on AbstractEnvelope (for subclassing
by modules that use JAXB for parsing envelopes).

Modified:
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractElement.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractPositionalAccuracy.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultAbsoluteExternalPositionalAccuracy.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultRelativeInternalPositionalAccuracy.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractElement.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractElement.java?rev=1774417&r1=1774416&r2=1774417&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractElement.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractElement.java
[UTF-8] Thu Dec 15 11:29:57 2016
@@ -301,8 +301,8 @@ public class AbstractElement extends ISO
     /**
      * Creates an element initialized to the given result.
      *
-     * @param result The value obtained from applying a data quality measure against a specified
-     *               acceptable conformance quality level.
+     * @param result  the value obtained from applying a data quality measure against a specified
+     *                acceptable conformance quality level.
      */
     public AbstractElement(final Result result) {
         results = singleton(result, Result.class);
@@ -313,7 +313,7 @@ public class AbstractElement extends ISO
      * This is a <cite>shallow</cite> copy constructor, since the other metadata
contained in the
      * given object are not recursively copied.
      *
-     * @param object The metadata to copy values from, or {@code null} if none.
+     * @param object  the metadata to copy values from, or {@code null} if none.
      *
      * @see #castOrCopy(Element)
      */
@@ -351,8 +351,8 @@ public class AbstractElement extends ISO
      *       metadata contained in the given object are not recursively copied.</li>
      * </ul>
      *
-     * @param  object The object to get as a SIS implementation, or {@code null} if none.
-     * @return A SIS implementation containing the values of the given object (may be the
+     * @param  object  the object to get as a SIS implementation, or {@code null} if none.
+     * @return a SIS implementation containing the values of the given object (may be the
      *         given object itself), or {@code null} if the argument was null.
      */
     public static AbstractElement castOrCopy(final Element object) {
@@ -384,7 +384,7 @@ public class AbstractElement extends ISO
     /**
      * Returns the name of the test applied to the data.
      *
-     * @return Name of the test applied to the data.
+     * @return name of the test applied to the data.
      */
     @Override
     @XmlElement(name = "nameOfMeasure")
@@ -395,7 +395,7 @@ public class AbstractElement extends ISO
     /**
      * Sets the name of the test applied to the data.
      *
-     * @param newValues The new name of measures.
+     * @param  newValues  the new name of measures.
      */
     public void setNamesOfMeasure(final Collection<? extends InternationalString> newValues)
{
         namesOfMeasure = writeCollection(newValues, namesOfMeasure, InternationalString.class);
@@ -404,7 +404,7 @@ public class AbstractElement extends ISO
     /**
      * Returns the code identifying a registered standard procedure, or {@code null} if none.
      *
-     * @return Code identifying a registered standard procedure, or {@code null}.
+     * @return code identifying a registered standard procedure, or {@code null}.
      */
     @Override
     @XmlElement(name = "measureIdentification")
@@ -415,7 +415,7 @@ public class AbstractElement extends ISO
     /**
      * Sets the code identifying a registered standard procedure.
      *
-     * @param newValue The new measure identification.
+     * @param  newValue  the new measure identification.
      */
     public void setMeasureIdentification(final Identifier newValue)  {
         checkWritePermission();
@@ -425,7 +425,7 @@ public class AbstractElement extends ISO
     /**
      * Returns the description of the measure being determined.
      *
-     * @return Description of the measure being determined, or {@code null}.
+     * @return description of the measure being determined, or {@code null}.
      */
     @Override
     @XmlElement(name = "measureDescription")
@@ -436,7 +436,7 @@ public class AbstractElement extends ISO
     /**
      * Sets the description of the measure being determined.
      *
-     * @param newValue The new measure description.
+     * @param  newValue  the new measure description.
      */
     public void setMeasureDescription(final InternationalString newValue)  {
         checkWritePermission();
@@ -446,7 +446,7 @@ public class AbstractElement extends ISO
     /**
      * Returns the type of method used to evaluate quality of the dataset.
      *
-     * @return Type of method used to evaluate quality, or {@code null}.
+     * @return type of method used to evaluate quality, or {@code null}.
      */
     @Override
     @XmlElement(name = "evaluationMethodType")
@@ -457,7 +457,7 @@ public class AbstractElement extends ISO
     /**
      * Sets the type of method used to evaluate quality of the dataset.
      *
-     * @param newValue The new evaluation method type.
+     * @param  newValue  the new evaluation method type.
      */
     public void setEvaluationMethodType(final EvaluationMethodType newValue)  {
         checkWritePermission();
@@ -467,7 +467,7 @@ public class AbstractElement extends ISO
     /**
      * Returns the description of the evaluation method.
      *
-     * @return Description of the evaluation method, or {@code null}.
+     * @return description of the evaluation method, or {@code null}.
      */
     @Override
     @XmlElement(name = "evaluationMethodDescription")
@@ -478,7 +478,7 @@ public class AbstractElement extends ISO
     /**
      * Sets the description of the evaluation method.
      *
-     * @param newValue The new evaluation method description.
+     * @param  newValue  the new evaluation method description.
      */
     public void setEvaluationMethodDescription(final InternationalString newValue)  {
         checkWritePermission();
@@ -488,7 +488,7 @@ public class AbstractElement extends ISO
     /**
      * Returns the reference to the procedure information, or {@code null} if none.
      *
-     * @return Reference to the procedure information, or {@code null}.
+     * @return reference to the procedure information, or {@code null}.
      */
     @Override
     @XmlElement(name = "evaluationProcedure")
@@ -499,7 +499,7 @@ public class AbstractElement extends ISO
     /**
      * Sets the reference to the procedure information.
      *
-     * @param newValue The new evaluation procedure.
+     * @param  newValue  the new evaluation procedure.
      */
     public void setEvaluationProcedure(final Citation newValue) {
         checkWritePermission();
@@ -511,7 +511,7 @@ public class AbstractElement extends ISO
      * The collection size is 1 for a single date, or 2 for a range.
      * Returns an empty collection if this information is not available.
      *
-     * @return Date or range of dates on which a data quality measure was applied.
+     * @return date or range of dates on which a data quality measure was applied.
      */
     @Override
     @XmlElement(name = "dateTime")
@@ -530,7 +530,7 @@ public class AbstractElement extends ISO
      * Sets the date or range of dates on which a data quality measure was applied.
      * The collection size is 1 for a single date, or 2 for a range.
      *
-     * @param newValues The new dates, or {@code null}.
+     * @param  newValues  the new dates, or {@code null}.
      */
     public void setDates(final Collection<? extends Date> newValues) {
         checkWritePermission();
@@ -559,7 +559,7 @@ public class AbstractElement extends ISO
      * the out come of evaluating the obtained value (or set of values) against a specified
      * acceptable conformance quality level.
      *
-     * @return Set of values obtained from applying a data quality measure.
+     * @return set of values obtained from applying a data quality measure.
      */
     @Override
     @XmlElement(name = "result", required = true)
@@ -572,7 +572,7 @@ public class AbstractElement extends ISO
      * the out come of evaluating the obtained value (or set of values) against a specified
      * acceptable conformance quality level.
      *
-     * @param newValues The new results.
+     * @param  newValues  the new results.
      */
     public void setResults(final Collection<? extends Result> newValues) {
         results = writeCollection(newValues, results, Result.class);

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractPositionalAccuracy.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractPositionalAccuracy.java?rev=1774417&r1=1774416&r2=1774417&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractPositionalAccuracy.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractPositionalAccuracy.java
[UTF-8] Thu Dec 15 11:29:57 2016
@@ -66,8 +66,8 @@ public class AbstractPositionalAccuracy
     /**
      * Creates an positional accuracy initialized to the given result.
      *
-     * @param result The value obtained from applying a data quality measure against a specified
-     *               acceptable conformance quality level.
+     * @param result  the value obtained from applying a data quality measure against a specified
+     *                acceptable conformance quality level.
      */
     public AbstractPositionalAccuracy(final Result result) {
         super(result);
@@ -78,7 +78,7 @@ public class AbstractPositionalAccuracy
      * This is a <cite>shallow</cite> copy constructor, since the other metadata
contained in the
      * given object are not recursively copied.
      *
-     * @param object The metadata to copy values from, or {@code null} if none.
+     * @param object  the metadata to copy values from, or {@code null} if none.
      *
      * @see #castOrCopy(PositionalAccuracy)
      */
@@ -105,8 +105,8 @@ public class AbstractPositionalAccuracy
      *       metadata contained in the given object are not recursively copied.</li>
      * </ul>
      *
-     * @param  object The object to get as a SIS implementation, or {@code null} if none.
-     * @return A SIS implementation containing the values of the given object (may be the
+     * @param  object  the object to get as a SIS implementation, or {@code null} if none.
+     * @return a SIS implementation containing the values of the given object (may be the
      *         given object itself), or {@code null} if the argument was null.
      */
     public static AbstractPositionalAccuracy castOrCopy(final PositionalAccuracy object)
{

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultAbsoluteExternalPositionalAccuracy.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultAbsoluteExternalPositionalAccuracy.java?rev=1774417&r1=1774416&r2=1774417&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultAbsoluteExternalPositionalAccuracy.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultAbsoluteExternalPositionalAccuracy.java
[UTF-8] Thu Dec 15 11:29:57 2016
@@ -59,8 +59,8 @@ public class DefaultAbsoluteExternalPosi
     /**
      * Creates an positional accuracy initialized to the given result.
      *
-     * @param result The value obtained from applying a data quality measure against a specified
-     *               acceptable conformance quality level.
+     * @param result  the value obtained from applying a data quality measure against a specified
+     *                acceptable conformance quality level.
      */
     public DefaultAbsoluteExternalPositionalAccuracy(final Result result) {
         super(result);
@@ -71,7 +71,7 @@ public class DefaultAbsoluteExternalPosi
      * This is a <cite>shallow</cite> copy constructor, since the other metadata
contained in the
      * given object are not recursively copied.
      *
-     * @param object The metadata to copy values from, or {@code null} if none.
+     * @param  object  the metadata to copy values from, or {@code null} if none.
      *
      * @see #castOrCopy(AbsoluteExternalPositionalAccuracy)
      */
@@ -93,8 +93,8 @@ public class DefaultAbsoluteExternalPosi
      *       metadata contained in the given object are not recursively copied.</li>
      * </ul>
      *
-     * @param  object The object to get as a SIS implementation, or {@code null} if none.
-     * @return A SIS implementation containing the values of the given object (may be the
+     * @param  object  the object to get as a SIS implementation, or {@code null} if none.
+     * @return a SIS implementation containing the values of the given object (may be the
      *         given object itself), or {@code null} if the argument was null.
      */
     public static DefaultAbsoluteExternalPositionalAccuracy castOrCopy(final AbsoluteExternalPositionalAccuracy
object) {

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultRelativeInternalPositionalAccuracy.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultRelativeInternalPositionalAccuracy.java?rev=1774417&r1=1774416&r2=1774417&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultRelativeInternalPositionalAccuracy.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultRelativeInternalPositionalAccuracy.java
[UTF-8] Thu Dec 15 11:29:57 2016
@@ -61,7 +61,7 @@ public class DefaultRelativeInternalPosi
      * This is a <cite>shallow</cite> copy constructor, since the other metadata
contained in the
      * given object are not recursively copied.
      *
-     * @param object The metadata to copy values from, or {@code null} if none.
+     * @param object  the metadata to copy values from, or {@code null} if none.
      *
      * @see #castOrCopy(RelativeInternalPositionalAccuracy)
      */
@@ -83,8 +83,8 @@ public class DefaultRelativeInternalPosi
      *       metadata contained in the given object are not recursively copied.</li>
      * </ul>
      *
-     * @param  object The object to get as a SIS implementation, or {@code null} if none.
-     * @return A SIS implementation containing the values of the given object (may be the
+     * @param  object  the object to get as a SIS implementation, or {@code null} if none.
+     * @return a SIS implementation containing the values of the given object (may be the
      *         given object itself), or {@code null} if the argument was null.
      */
     public static DefaultRelativeInternalPositionalAccuracy castOrCopy(final RelativeInternalPositionalAccuracy
object) {

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java?rev=1774417&r1=1774416&r2=1774417&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/geometry/AbstractEnvelope.java
[UTF-8] Thu Dec 15 11:29:57 2016
@@ -21,9 +21,11 @@ package org.apache.sis.geometry;
  * support Java2D (e.g. Android),  or applications that do not need it may want to avoid
to
  * force installation of the Java2D module (e.g. JavaFX/SWT).
  */
+import java.util.Objects;
 import java.io.Serializable;
 import javax.measure.Unit;
 import javax.measure.IncommensurableException;
+import javax.xml.bind.annotation.XmlTransient;
 import org.opengis.geometry.Envelope;
 import org.opengis.geometry.DirectPosition;
 import org.opengis.geometry.MismatchedDimensionException;
@@ -48,9 +50,6 @@ import static org.apache.sis.math.MathFu
 import static org.apache.sis.math.MathFunctions.isNegative;
 import static org.apache.sis.math.MathFunctions.isPositive;
 
-// Branch-dependent imports
-import java.util.Objects;
-
 
 /**
  * Default implementations of most {@code Envelope} methods, leaving the data storage to
subclasses.
@@ -113,6 +112,7 @@ import java.util.Objects;
  * @version 0.8
  * @module
  */
+@XmlTransient
 public abstract class AbstractEnvelope implements Envelope, Emptiable {
     /**
      * An empty array of envelopes, to be returned by {@link #toSimpleEnvelopes()}
@@ -132,8 +132,8 @@ public abstract class AbstractEnvelope i
      * then it is returned unchanged. Otherwise the coordinate values and the CRS
      * of the given envelope are copied in a new envelope.
      *
-     * @param  envelope The envelope to cast, or {@code null}.
-     * @return The values of the given envelope as an {@code AbstractEnvelope} instance.
+     * @param  envelope  the envelope to cast, or {@code null}.
+     * @return the values of the given envelope as an {@code AbstractEnvelope} instance.
      *
      * @see GeneralEnvelope#castOrCopy(Envelope)
      * @see ImmutableEnvelope#castOrCopy(Envelope)
@@ -163,9 +163,9 @@ public abstract class AbstractEnvelope i
     /**
      * Returns the common CRS of specified points.
      *
-     * @param  lowerCorner The first position.
-     * @param  upperCorner The second position.
-     * @return Their common CRS, or {@code null} if none.
+     * @param  lowerCorner  the first position.
+     * @param  upperCorner  the second position.
+     * @return their common CRS, or {@code null} if none.
      * @throws MismatchedReferenceSystemException if the two positions don't use equal CRS.
      */
     static CoordinateReferenceSystem getCommonCRS(final DirectPosition lowerCorner,
@@ -190,9 +190,9 @@ public abstract class AbstractEnvelope i
      * Returns the axis of the given coordinate reference system for the given dimension,
      * or {@code null} if none.
      *
-     * @param  crs The envelope CRS, or {@code null}.
-     * @param  dimension The dimension for which to get the axis.
-     * @return The axis at the given dimension, or {@code null}.
+     * @param  crs        the envelope CRS, or {@code null}.
+     * @param  dimension  the dimension for which to get the axis.
+     * @return the axis at the given dimension, or {@code null}.
      */
     static CoordinateSystemAxis getAxis(final CoordinateReferenceSystem crs, final int dimension)
{
         if (crs != null) {
@@ -208,8 +208,8 @@ public abstract class AbstractEnvelope i
      * Returns {@code true} if the axis for the given dimension has the
      * {@link RangeMeaning#WRAPAROUND WRAPAROUND} range meaning.
      *
-     * @param  crs The envelope CRS, or {@code null}.
-     * @param  dimension The dimension for which to get the axis.
+     * @param  crs        the envelope CRS, or {@code null}.
+     * @param  dimension  the dimension for which to get the axis.
      * @return {@code true} if the range meaning is {@code WRAPAROUND}.
      */
     static boolean isWrapAround(final CoordinateReferenceSystem crs, final int dimension)
{
@@ -221,8 +221,8 @@ public abstract class AbstractEnvelope i
      * If the range meaning of the given axis is "wraparound", returns the spanning of that
axis.
      * Otherwise returns {@link Double#NaN}.
      *
-     * @param  axis The axis for which to get the spanning.
-     * @return The spanning of the given axis.
+     * @param  axis  the axis for which to get the spanning.
+     * @return the spanning of the given axis.
      */
     static double getSpan(final CoordinateSystemAxis axis) {
         if (axis != null && RangeMeaning.WRAPAROUND.equals(axis.getRangeMeaning()))
{
@@ -265,7 +265,7 @@ public abstract class AbstractEnvelope i
      * lower corner longitude greater than the upper corner longitude. Such extended interpretation
applies
      * mostly to axes having {@code WRAPAROUND} range meaning.</div>
      *
-     * @return A view over the lower corner, typically (but not necessarily) containing minimal
ordinate values.
+     * @return a view over the lower corner, typically (but not necessarily) containing minimal
ordinate values.
      */
     @Override
     public DirectPosition getLowerCorner() {
@@ -290,7 +290,7 @@ public abstract class AbstractEnvelope i
      * upper corner longitude less than the lower corner longitude. Such extended interpretation
applies
      * mostly to axes having {@code WRAPAROUND} range meaning.</div>
      *
-     * @return A view over the upper corner, typically (but not necessarily) containing maximal
ordinate values.
+     * @return a view over the upper corner, typically (but not necessarily) containing maximal
ordinate values.
      */
     @Override
     public DirectPosition getUpperCorner() {
@@ -304,7 +304,7 @@ public abstract class AbstractEnvelope i
      * The default implementation returns a view over the {@link #getMedian(int)} method,
      * so changes in this envelope will be immediately reflected in the returned direct position.
      *
-     * @return The median coordinates.
+     * @return the median coordinates.
      */
     public DirectPosition getMedian() {
         // We do not cache the object because it is very cheap to create and we
@@ -317,9 +317,9 @@ public abstract class AbstractEnvelope i
      * This is usually the algebraic {@linkplain #getMinimum(int) minimum}, except if this
envelope
      * spans the anti-meridian.
      *
-     * @param  dimension The dimension for which to obtain the ordinate value.
-     * @return The starting ordinate value at the given dimension.
-     * @throws IndexOutOfBoundsException If the given index is negative or is equals or greater
+     * @param  dimension  the dimension for which to obtain the ordinate value.
+     * @return the starting ordinate value at the given dimension.
+     * @throws IndexOutOfBoundsException if the given index is negative or is equals or greater
      *         than the {@linkplain #getDimension() envelope dimension}.
      */
     public abstract double getLower(int dimension) throws IndexOutOfBoundsException;
@@ -329,9 +329,9 @@ public abstract class AbstractEnvelope i
      * This is usually the algebraic {@linkplain #getMaximum(int) maximum}, except if this
envelope
      * spans the anti-meridian.
      *
-     * @param  dimension The dimension for which to obtain the ordinate value.
-     * @return The starting ordinate value at the given dimension.
-     * @throws IndexOutOfBoundsException If the given index is negative or is equals or greater
+     * @param  dimension  the dimension for which to obtain the ordinate value.
+     * @return the starting ordinate value at the given dimension.
+     * @throws IndexOutOfBoundsException if the given index is negative or is equals or greater
      *         than the {@linkplain #getDimension() envelope dimension}.
      */
     public abstract double getUpper(int dimension) throws IndexOutOfBoundsException;
@@ -342,9 +342,9 @@ public abstract class AbstractEnvelope i
      * {@link #getLower(int)} value verbatim. In the case of envelope spanning the anti-meridian,
      * this method returns the {@linkplain CoordinateSystemAxis#getMinimumValue() axis minimum
value}.
      *
-     * @param  dimension The dimension for which to obtain the ordinate value.
-     * @return The minimal ordinate value at the given dimension.
-     * @throws IndexOutOfBoundsException If the given index is negative or is equals or greater
+     * @param  dimension  the dimension for which to obtain the ordinate value.
+     * @return the minimal ordinate value at the given dimension.
+     * @throws IndexOutOfBoundsException if the given index is negative or is equals or greater
      *         than the {@linkplain #getDimension() envelope dimension}.
      */
     @Override
@@ -363,9 +363,9 @@ public abstract class AbstractEnvelope i
      * {@link #getUpper(int)} value verbatim. In the case of envelope spanning the anti-meridian,
      * this method returns the {@linkplain CoordinateSystemAxis#getMaximumValue() axis maximum
value}.
      *
-     * @param  dimension The dimension for which to obtain the ordinate value.
-     * @return The maximal ordinate value at the given dimension.
-     * @throws IndexOutOfBoundsException If the given index is negative or is equals or greater
+     * @param  dimension  the dimension for which to obtain the ordinate value.
+     * @return the maximal ordinate value at the given dimension.
+     * @throws IndexOutOfBoundsException if the given index is negative or is equals or greater
      *         than the {@linkplain #getDimension() envelope dimension}.
      */
     @Override
@@ -396,9 +396,9 @@ public abstract class AbstractEnvelope i
      * space. If the axis range meaning is not {@code WRAPAROUND}, then this method returns
      * {@link Double#NaN NaN}.
      *
-     * @param  dimension The dimension for which to obtain the ordinate value.
-     * @return The median ordinate at the given dimension, or {@link Double#NaN}.
-     * @throws IndexOutOfBoundsException If the given index is negative or is equals or greater
+     * @param  dimension  the dimension for which to obtain the ordinate value.
+     * @return the median ordinate at the given dimension, or {@link Double#NaN}.
+     * @throws IndexOutOfBoundsException if the given index is negative or is equals or greater
      *         than the {@linkplain #getDimension() envelope dimension}.
      */
     @Override
@@ -445,9 +445,9 @@ public abstract class AbstractEnvelope i
      * longitude) to the span. If the result is a positive number, it is returned. Otherwise
      * this method returns {@link Double#NaN NaN}.
      *
-     * @param  dimension The dimension for which to obtain the span.
-     * @return The span (typically width or height) at the given dimension, or {@link Double#NaN}.
-     * @throws IndexOutOfBoundsException If the given index is negative or is equals or greater
+     * @param  dimension  the dimension for which to obtain the span.
+     * @return the span (typically width or height) at the given dimension, or {@link Double#NaN}.
+     * @throws IndexOutOfBoundsException if the given index is negative or is equals or greater
      *         than the {@linkplain #getDimension() envelope dimension}.
      */
     @Override
@@ -463,9 +463,9 @@ public abstract class AbstractEnvelope i
      * Transforms a negative span into a valid value if the axis range meaning is "wraparound".
      * Returns {@code NaN} otherwise.
      *
-     * @param  axis The axis for the span dimension, or {@code null}.
-     * @param  span The negative span.
-     * @return A positive span, or NaN if the span can not be fixed.
+     * @param  axis  the axis for the span dimension, or {@code null}.
+     * @param  span  the negative span.
+     * @return a positive span, or NaN if the span can not be fixed.
      */
     static double fixSpan(final CoordinateSystemAxis axis, double span) {
         if (axis != null && RangeMeaning.WRAPAROUND.equals(axis.getRangeMeaning()))
{
@@ -484,10 +484,10 @@ public abstract class AbstractEnvelope i
      * Returns the envelope span along the specified dimension, in terms of the given units.
      * The default implementation invokes {@link #getSpan(int)} and converts the result.
      *
-     * @param  dimension The dimension to query.
-     * @param  unit The unit for the return value.
-     * @return The span in terms of the given unit.
-     * @throws IndexOutOfBoundsException If the given index is out of bounds.
+     * @param  dimension  the dimension to query.
+     * @param  unit  the unit for the return value.
+     * @return the span in terms of the given unit.
+     * @throws IndexOutOfBoundsException if the given index is out of bounds.
      * @throws IncommensurableException if the length can't be converted to the specified
units.
      */
     public double getSpan(final int dimension, final Unit<?> unit)
@@ -525,7 +525,7 @@ public abstract class AbstractEnvelope i
      *       represents this envelope as 2ⁿ separated simple envelopes.
      * </ul>
      *
-     * @return A representation of this envelope as an array of non-empty envelope.
+     * @return a representation of this envelope as an array of non-empty envelope.
      *
      * @see Envelope2D#toRectangles()
      * @see GeneralEnvelope#simplify()
@@ -692,10 +692,10 @@ public abstract class AbstractEnvelope i
      * inside the envelope interior, this method tests if the given point is <em>outside</em>
the
      * envelope <em>exterior</em>.
      *
-     * @param  position The point to text.
+     * @param  position  the point to text.
      * @return {@code true} if the specified coordinate is inside the boundary of this envelope;
{@code false} otherwise.
      * @throws MismatchedDimensionException if the specified point doesn't have the expected
dimension.
-     * @throws AssertionError If assertions are enabled and the envelopes have mismatched
CRS.
+     * @throws AssertionError if assertions are enabled and the envelopes have mismatched
CRS.
      */
     public boolean contains(final DirectPosition position) throws MismatchedDimensionException
{
         ensureNonNull("position", position);
@@ -741,10 +741,10 @@ public abstract class AbstractEnvelope i
      *
      * <p><img src="doc-files/Contains.png" alt="Examples of envelope inclusions"></p>
      *
-     * @param  envelope The envelope to test for inclusion.
+     * @param  envelope  the envelope to test for inclusion.
      * @return {@code true} if this envelope completely encloses the specified one.
      * @throws MismatchedDimensionException if the specified envelope doesn't have the expected
dimension.
-     * @throws AssertionError If assertions are enabled and the envelopes have mismatched
CRS.
+     * @throws AssertionError if assertions are enabled and the envelopes have mismatched
CRS.
      *
      * @see #intersects(Envelope)
      * @see #equals(Envelope, double, boolean)
@@ -768,11 +768,11 @@ public abstract class AbstractEnvelope i
      * 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  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.
      * @throws MismatchedDimensionException if the specified envelope doesn't have the expected
dimension.
-     * @throws AssertionError If assertions are enabled and the envelopes have mismatched
CRS.
+     * @throws AssertionError if assertions are enabled and the envelopes have mismatched
CRS.
      *
      * @see #intersects(Envelope, boolean)
      */
@@ -856,10 +856,10 @@ public abstract class AbstractEnvelope i
      * <div class="section">Spanning the anti-meridian of a Geographic CRS</div>
      * This method can handle envelopes spanning the anti-meridian.
      *
-     * @param  envelope The envelope to test for intersection.
+     * @param  envelope  the envelope to test for intersection.
      * @return {@code true} if this envelope intersects the specified one.
      * @throws MismatchedDimensionException if the specified envelope doesn't have the expected
dimension.
-     * @throws AssertionError If assertions are enabled and the envelopes have mismatched
CRS.
+     * @throws AssertionError if assertions are enabled and the envelopes have mismatched
CRS.
      *
      * @see #contains(Envelope, boolean)
      * @see #equals(Envelope, double, boolean)
@@ -882,11 +882,11 @@ public abstract class AbstractEnvelope i
      * 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  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.
      * @throws MismatchedDimensionException if the specified envelope doesn't have the expected
dimension.
-     * @throws AssertionError If assertions are enabled and the envelopes have mismatched
CRS.
+     * @throws AssertionError if assertions are enabled and the envelopes have mismatched
CRS.
      *
      * @see #contains(Envelope, boolean)
      * @see #equals(Envelope, double, boolean)
@@ -992,10 +992,10 @@ public abstract class AbstractEnvelope i
      * ignoring metadata}. If at least one envelope has a null CRS, then the CRS are ignored
and the
      * ordinate values are compared as if the CRS were equal.
      *
-     * @param  other The envelope to compare with.
-     * @param  eps   The tolerance value to use for numerical comparisons.
-     * @param  epsIsRelative {@code true} if the tolerance value should be relative to
-     *         axis length, or {@code false} if it is an absolute value.
+     * @param  other          the envelope to compare with.
+     * @param  eps            the tolerance value to use for numerical comparisons.
+     * @param  epsIsRelative  {@code true} if the tolerance value should be relative to axis
length,
+     *                        or {@code false} if it is an absolute value.
      * @return {@code true} if the given object is equal to this envelope up to the given
tolerance value.
      *
      * @see #contains(Envelope)
@@ -1036,7 +1036,7 @@ public abstract class AbstractEnvelope i
      * This implementation requires that the provided {@code object} 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>
      *
-     * @param object The object to compare with this envelope.
+     * @param  object  the object to compare with this envelope.
      * @return {@code true} if the given object is equal to this envelope.
      */
     @Override
@@ -1105,7 +1105,7 @@ public abstract class AbstractEnvelope i
      * The string returned by this method can be {@linkplain GeneralEnvelope#GeneralEnvelope(CharSequence)
parsed}
      * by the {@code GeneralEnvelope} constructor.
      *
-     * @return This envelope as a {@code BOX} or {@code BOX3D} (most typical dimensions)
element.
+     * @return this envelope as a {@code BOX} or {@code BOX3D} (most typical dimensions)
element.
      */
     @Override
     public String toString() {
@@ -1236,12 +1236,12 @@ public abstract class AbstractEnvelope i
      * since this class intentionally have no public setter methods. This is necessary for
      * preserving the immutable aspect of {@link ImmutableEnvelope} subclass among others.</p>
      *
-     * @param  dimension The dimension to set.
+     * @param  dimension  the dimension to set.
      * @param  lower     The limit in the direction of decreasing ordinate values.
      * @param  upper     The limit in the direction of increasing ordinate values.
-     * @throws UnmodifiableGeometryException If this envelope is not modifiable.
-     * @throws IndexOutOfBoundsException If the given index is out of bounds.
-     * @throws IllegalArgumentException If {@code lower > upper}, this envelope has a
CRS
+     * @throws UnmodifiableGeometryException if this envelope is not modifiable.
+     * @throws IndexOutOfBoundsException if the given index is out of bounds.
+     * @throws IllegalArgumentException if {@code lower > upper}, this envelope has a
CRS
      *         and the axis range meaning at the given dimension is not "wraparound".
      */
     void setRange(final int dimension, final double lower, final double upper)



Mime
View raw message