sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1768088 - in /sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation: AbstractCoordinateOperation.java CoordinateOperationRegistry.java
Date Fri, 04 Nov 2016 20:29:27 GMT
Author: desruisseaux
Date: Fri Nov  4 20:29:27 2016
New Revision: 1768088

URL: http://svn.apache.org/viewvc?rev=1768088&view=rev
Log:
Javadoc formatting.

Modified:
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/CoordinateOperationRegistry.java

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java?rev=1768088&r1=1768087&r2=1768088&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java
[UTF-8] Fri Nov  4 20:29:27 2016
@@ -17,6 +17,7 @@
 package org.apache.sis.referencing.operation;
 
 import java.util.Map;
+import java.util.Objects;
 import java.util.Collection;
 import java.util.Collections;
 import javax.xml.bind.Unmarshaller;
@@ -66,9 +67,6 @@ import org.apache.sis.internal.system.Lo
 
 import static org.apache.sis.util.Utilities.deepEquals;
 
-// Branch-dependent imports
-import java.util.Objects;
-
 
 /**
  * Describes the operation for transforming coordinates in the source CRS to coordinates
in the target CRS.
@@ -318,12 +316,12 @@ public class AbstractCoordinateOperation
      * The math transform shall let the interpolation coordinates {@linkplain DefaultPassThroughOperation
pass through
      * the operation}.
      *
-     * @param properties The properties to be given to the identified object.
-     * @param sourceCRS  The source CRS, or {@code null} if unspecified.
-     * @param targetCRS  The target CRS, or {@code null} if unspecified.
-     * @param interpolationCRS The CRS of additional coordinates needed for the operation,
or {@code null} if none.
-     * @param transform  Transform from positions in the source CRS to positions in the target
CRS,
-     *                   or {@code null} if unspecified.
+     * @param  properties        the properties to be given to the identified object.
+     * @param  sourceCRS         the source CRS, or {@code null} if unspecified.
+     * @param  targetCRS         the target CRS, or {@code null} if unspecified.
+     * @param  interpolationCRS  the CRS of additional coordinates needed for the operation,
or {@code null} if none.
+     * @param  transform         transform from positions in the source CRS to positions
in the target CRS,
+     *                           or {@code null} if unspecified.
      */
     public AbstractCoordinateOperation(final Map<String,?>             properties,
                                        final CoordinateReferenceSystem sourceCRS,
@@ -344,7 +342,7 @@ public class AbstractCoordinateOperation
      * are consistent with {@link #transform} input and output dimensions.
      */
     final void checkDimensions(final Map<String,?> properties) {
-        final MathTransform transform = this.transform;   // Protect from changes.
+        final MathTransform transform = this.transform;                     // Protect from
changes.
         if (transform != null) {
             final int interpDim = ReferencingUtilities.getDimension(interpolationCRS);
 check:      for (int isTarget=0; ; isTarget++) {        // 0 == source check; 1 == target
check.
@@ -380,7 +378,7 @@ check:      for (int isTarget=0; ; isTar
      *
      * <p>This constructor performs a shallow copy, i.e. the properties are not cloned.</p>
      *
-     * @param operation The coordinate operation to copy.
+     * @param  operation  the coordinate operation to copy.
      *
      * @see #castOrCopy(CoordinateOperation)
      */
@@ -422,8 +420,8 @@ check:      for (int isTarget=0; ; isTar
      *       properties 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 AbstractCoordinateOperation castOrCopy(final CoordinateOperation object)
{
@@ -435,7 +433,7 @@ check:      for (int isTarget=0; ; isTar
      * The default implementation returns {@code CoordinateOperation.class}.
      * Subclasses implementing a more specific GeoAPI interface shall override this method.
      *
-     * @return The coordinate operation interface implemented by this class.
+     * @return the coordinate operation interface implemented by this class.
      */
     @Override
     public Class<? extends CoordinateOperation> getInterface() {
@@ -478,7 +476,7 @@ check:      for (int isTarget=0; ; isTar
      * This information is optional for {@linkplain DefaultConversion conversions} according
      * the ISO 19111 standard, but Apache SIS tries to provide that CRS in most cases anyway.
      *
-     * @return The source CRS, or {@code null} if not available.
+     * @return the source CRS, or {@code null} if not available.
      */
     @Override
     public CoordinateReferenceSystem getSourceCRS() {
@@ -491,7 +489,7 @@ check:      for (int isTarget=0; ; isTar
      * This information is optional for {@linkplain DefaultConversion conversions} according
      * the ISO 19111 standard, but Apache SIS tries to provide that CRS in most cases anyway.
      *
-     * @return The target CRS, or {@code null} if not available.
+     * @return the target CRS, or {@code null} if not available.
      */
     @Override
     public CoordinateReferenceSystem getTargetCRS() {
@@ -507,7 +505,7 @@ check:      for (int isTarget=0; ; isTar
      * in order to interpolate in a grid. This method returns the CRS of the grid where such
interpolations
      * are performed.</div>
      *
-     * @return The CRS (neither source or target CRS) required for interpolating the values,
or {@code null} if none.
+     * @return the CRS (neither source or target CRS) required for interpolating the values,
or {@code null} if none.
      */
     public CoordinateReferenceSystem getInterpolationCRS() {
         return interpolationCRS;
@@ -527,7 +525,7 @@ check:      for (int isTarget=0; ; isTar
      * nature of the parameters. In principle this property is irrelevant to coordinate
      * {@linkplain DefaultConversion conversions}, but Apache SIS accepts it anyway.
      *
-     * @return The coordinate operation version, or {@code null} in none.
+     * @return the coordinate operation version, or {@code null} in none.
      */
     @Override
     @XmlElement(name = "operationVersion")
@@ -540,7 +538,7 @@ check:      for (int isTarget=0; ; isTar
      * The positional accuracy gives position error estimates for target coordinates
      * of this coordinate operation, assuming no errors in source coordinates.
      *
-     * @return The position error estimations, or an empty collection if not available.
+     * @return the position error estimations, or an empty collection if not available.
      *
      * @see #getLinearAccuracy()
      */
@@ -584,7 +582,7 @@ check:      for (int isTarget=0; ; isTar
      *       if the math transforms are highly non-linear.</div></li>
      * </ul>
      *
-     * @return The accuracy estimation (always in meters), or NaN if unknown.
+     * @return the accuracy estimation (always in meters), or NaN if unknown.
      *
      * @see org.apache.sis.referencing.CRS#getLinearAccuracy(CoordinateOperation)
      */
@@ -595,7 +593,7 @@ check:      for (int isTarget=0; ; isTar
     /**
      * Returns the area or region or timeframe in which this coordinate operation is valid.
      *
-     * @return The coordinate operation valid domain, or {@code null} if not available.
+     * @return the coordinate operation valid domain, or {@code null} if not available.
      */
     @Override
     @XmlElement(name = "domainOfValidity")
@@ -606,7 +604,7 @@ check:      for (int isTarget=0; ; isTar
     /**
      * Returns a description of domain of usage, or limitations of usage, for which this
operation is valid.
      *
-     * @return A description of domain of usage, or {@code null} if none.
+     * @return a description of domain of usage, or {@code null} if none.
      */
     @Override
     @XmlElement(name = "scope", required = true)
@@ -633,7 +631,7 @@ check:      for (int isTarget=0; ; isTar
      * The interpolation coordinates will {@linkplain DefaultPassThroughOperation pass through
the operation}
      * and appear in the math transform outputs, in the same order than inputs.
      *
-     * @return The transform from source to target CRS, or {@code null} if not applicable.
+     * @return the transform from source to target CRS, or {@code null} if not applicable.
      */
     @Override
     public MathTransform getMathTransform() {
@@ -644,7 +642,7 @@ check:      for (int isTarget=0; ; isTar
      * Returns the operation method. This apply only to {@link AbstractSingleOperation} subclasses,
      * which will make this method public.
      *
-     * @return The operation method, or {@code null} if none.
+     * @return the operation method, or {@code null} if none.
      */
     OperationMethod getMethod() {
         return null;
@@ -698,7 +696,7 @@ check:      for (int isTarget=0; ; isTar
      * Returns the parameter values. The default implementation infers the
      * parameter values from the {@linkplain #transform}, if possible.
      *
-     * @return The parameter values (never {@code null}).
+     * @return the parameter values (never {@code null}).
      * @throws UnsupportedOperationException if the parameter values can not
      *         be determined for the current math transform implementation.
      */
@@ -734,10 +732,10 @@ check:      for (int isTarget=0; ; isTar
      * properties are compared including the {@linkplain #getDomainOfValidity() domain of
validity} and the
      * {@linkplain #getScope() scope}.
      *
-     * @param  object The object to compare to {@code this}.
-     * @param  mode {@link ComparisonMode#STRICT STRICT} for performing a strict comparison,
or
-     *         {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for ignoring properties
-     *         that do not make a difference in the numerical results of coordinate operations.
+     * @param  object  the object to compare to {@code this}.
+     * @param  mode    {@link ComparisonMode#STRICT STRICT} for performing a strict comparison,
or
+     *                 {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for ignoring
properties
+     *                 that do not make a difference in the numerical results of coordinate
operations.
      * @return {@code true} if both objects are equal for the given comparison mode.
      */
     @Override
@@ -837,7 +835,7 @@ check:      for (int isTarget=0; ; isTar
      * Invoked by {@code hashCode()} for computing the hash code when first needed.
      * See {@link AbstractIdentifiedObject#computeHashCode()} for more information.
      *
-     * @return The hash code value. This value may change in any future Apache SIS version.
+     * @return the hash code value. This value may change in any future Apache SIS version.
      */
     @Override
     protected long computeHashCode() {
@@ -852,7 +850,7 @@ check:      for (int isTarget=0; ; isTar
     /**
      * Formats this coordinate operation in Well Known Text (WKT) version 2 format.
      *
-     * @param  formatter The formatter to use.
+     * @param  formatter  the formatter to use.
      * @return {@code "CoordinateOperation"}.
      *
      * @see <a href="http://docs.opengeospatial.org/is/12-063r5/12-063r5.html#113">WKT
2 specification §17</a>
@@ -921,9 +919,9 @@ check:      for (int isTarget=0; ; isTar
     /**
      * Appends the given CRS (if non-null) wrapped in an element of the given name.
      *
-     * @param formatter The formatter where to append the object name.
-     * @param crs       The object to append, or {@code null} if none.
-     * @param type      The keyword to write before the object.
+     * @param formatter  the formatter where to append the object name.
+     * @param crs        the object to append, or {@code null} if none.
+     * @param type       the keyword to write before the object.
      */
     private static void append(final Formatter formatter, final CoordinateReferenceSystem
crs, final String type) {
         if (crs != null) {

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/CoordinateOperationRegistry.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/CoordinateOperationRegistry.java?rev=1768088&r1=1768087&r2=1768088&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/CoordinateOperationRegistry.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/CoordinateOperationRegistry.java
[UTF-8] Fri Nov  4 20:29:27 2016
@@ -286,8 +286,8 @@ class CoordinateOperationRegistry {
      *
      * @param  sourceCRS  input coordinate reference system.
      * @param  targetCRS  output coordinate reference system.
-     * @return a coordinate operation from {@code sourceCRS} to {@code targetCRS}, or {@code
null}
-     *         if no such operation is explicitly defined in the underlying database.
+     * @return a coordinate operation from {@code sourceCRS} to {@code targetCRS},
+     *         or {@code null} if no such operation is explicitly defined in the underlying
database.
      * @throws OperationNotFoundException if no operation path was found from {@code sourceCRS}
to {@code targetCRS}.
      * @throws FactoryException if the operation creation failed for some other reason.
      */
@@ -353,9 +353,7 @@ class CoordinateOperationRegistry {
      *
      * @param  sourceCRS  source coordinate reference system.
      * @param  targetCRS  target coordinate reference system.
-     * @return A coordinate operation from {@code sourceCRS} to {@code targetCRS},
-     *         or {@code null} if no such operation is explicitly defined in the underlying
database.
-     * @return A coordinate operation from {@code sourceCRS} to {@code targetCRS}, or {@code
null}
+     * @return a coordinate operation from {@code sourceCRS} to {@code targetCRS}, or {@code
null}
      *         if no such operation is explicitly defined in the underlying database.
      * @throws IllegalArgumentException if the coordinate systems are not of the same type
or axes do not match.
      * @throws IncommensurableException if the units are not compatible or a unit conversion
is non-linear.
@@ -539,8 +537,8 @@ class CoordinateOperationRegistry {
      * a new query of EPSG database may be necessary, and if no explicit definition is found
there is too many arbitrary
      * values to set in a default inverse operation for making that API public.</p>
      *
-     * @param  operation The operation to invert, or {@code null}.
-     * @return The inverse of {@code operation}, or {@code null} if none.
+     * @param  operation  the operation to invert, or {@code null}.
+     * @return the inverse of {@code operation}, or {@code null} if none.
      * @throws NoninvertibleTransformException if the operation is not invertible.
      * @throws FactoryException if the operation creation failed for an other reason.
      */
@@ -956,7 +954,7 @@ class CoordinateOperationRegistry {
      * Consequently, the Apache SIS implementation relaxes the rule requiring an operation
      * version and we do not try to provide this information here for now.</div>
      *
-     * @param  name  The name to put in a map.
+     * @param  name  the name to put in a map.
      * @return a modifiable map containing the given name. Callers can put other entries
in this map.
      */
     static Map<String,Object> properties(final Identifier name) {
@@ -996,14 +994,14 @@ class CoordinateOperationRegistry {
      *       DefaultCoordinateOperationFactory.createSingleOperation(…)}.</li>
      * </ul>
      *
-     * @param  properties The properties to give to the operation, as a modifiable map.
-     * @param  sourceCRS  The source coordinate reference system.
-     * @param  targetCRS  The destination coordinate reference system.
-     * @param  transform  The math transform.
-     * @param  method     The operation method, or {@code null} if unknown.
-     * @param  parameters The operations parameters, or {@code null} for automatic detection
(not always reliable).
-     * @param  type       {@code Conversion.class}, {@code Transformation.class}, or {@code
null} if unknown.
-     * @return A coordinate operation using the specified math transform.
+     * @param  properties  the properties to give to the operation, as a modifiable map.
+     * @param  sourceCRS   the source coordinate reference system.
+     * @param  targetCRS   the destination coordinate reference system.
+     * @param  transform   the math transform.
+     * @param  method      the operation method, or {@code null} if unknown.
+     * @param  parameters  the operations parameters, or {@code null} for automatic detection
(not always reliable).
+     * @param  type        {@code Conversion.class}, {@code Transformation.class}, or {@code
null} if unknown.
+     * @return a coordinate operation using the specified math transform.
      * @throws FactoryException if the operation can not be created.
      */
     final CoordinateOperation createFromMathTransform(final Map<String,Object>    
   properties,



Mime
View raw message