Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -133,7 +133,7 @@ public abstract class AbstractMathTransf /** * Gets the dimension of input points. * - * @return The dimension of input points. + * @return the dimension of input points. * * @see org.apache.sis.referencing.operation.DefaultOperationMethod#getSourceDimensions() */ @@ -143,7 +143,7 @@ public abstract class AbstractMathTransf /** * Gets the dimension of output points. * - * @return The dimension of output points. + * @return the dimension of output points. * * @see org.apache.sis.referencing.operation.DefaultOperationMethod#getTargetDimensions() */ @@ -159,7 +159,7 @@ public abstract class AbstractMathTransf * {@linkplain Units#METRE metres} or {@linkplain Units#DEGREE decimal degrees}). * * - * @return The parameter descriptors for this math transform, or {@code null} if unspecified. + * @return the parameter descriptors for this math transform, or {@code null} if unspecified. * * @see org.apache.sis.referencing.operation.DefaultOperationMethod#getParameters() */ @@ -181,7 +181,7 @@ public abstract class AbstractMathTransf * to take in account the context of this math transform, i.e. the scales and offsets applied before * and after this transform. This information is provided by {@link #getContextualParameters()}. * - * @return The parameter values for this math transform, or {@code null} if unspecified. + * @return the parameter values for this math transform, or {@code null} if unspecified. * Note that those parameters may be normalized (e.g. represent a transformation * of an ellipsoid of semi-major axis length of 1). * @@ -208,7 +208,7 @@ public abstract class AbstractMathTransf * If a split has been done, then this {@code MathTransform} represents only the non-linear step and Apache SIS * needs this method for reconstructing the parameters of the complete transform. * - * @return The parameters values for the sequence of normalize → {@code this} → denormalize + * @return the parameters values for the sequence of normalize → {@code this} → denormalize * transforms, or {@code null} if unspecified. * Callers should not modify the returned parameters, since modifications (if allowed) * will generally not be reflected back in this {@code MathTransform}. @@ -231,9 +231,9 @@ public abstract class AbstractMathTransf /** * Constructs an error message for the {@link MismatchedDimensionException}. * - * @param argument The argument name with the wrong number of dimensions. - * @param expected The expected dimension. - * @param dimension The wrong dimension. + * @param argument the argument name with the wrong number of dimensions. + * @param expected the expected dimension. + * @param dimension the wrong dimension. */ static MismatchedDimensionException mismatchedDimension(final String argument, final int expected, final int dimension) { return new MismatchedDimensionException(Errors.format(Errors.Keys.MismatchedDimension_3, argument, expected, dimension)); @@ -252,8 +252,8 @@ public abstract class AbstractMathTransf * * This method does not update the associated {@link org.opengis.referencing.crs.CoordinateReferenceSystem} value. * - * @param ptSrc the coordinate point to be transformed. - * @param ptDst the coordinate point that stores the result of transforming {@code ptSrc}, or {@code null}. + * @param ptSrc the coordinate point to be transformed. + * @param ptDst the coordinate point that stores the result of transforming {@code ptSrc}, or {@code null}. * @return the coordinate point after transforming {@code ptSrc} and storing the result in {@code ptDst}, * or a newly created point if {@code ptDst} was null. * @throws MismatchedDimensionException if {@code ptSrc} or {@code ptDst} doesn't have the expected dimension. @@ -336,13 +336,13 @@ public abstract class AbstractMathTransf * The source and destination may overlap. Consequently, implementors must read all source * ordinate values before to start writing the transformed ordinates in the destination array. * - * @param srcPts The array containing the source coordinate (can not be {@code null}). - * @param srcOff The offset to the point to be transformed in the source array. - * @param dstPts The array into which the transformed coordinate is returned. May be the same than {@code srcPts}. - * May be {@code null} if only the derivative matrix is desired. - * @param dstOff The offset to the location of the transformed point that is stored in the destination array. - * @param derivate {@code true} for computing the derivative, or {@code false} if not needed. - * @return The matrix of the transform derivative at the given source position, + * @param srcPts the array containing the source coordinate (can not be {@code null}). + * @param srcOff the offset to the point to be transformed in the source array. + * @param dstPts the array into which the transformed coordinate is returned. May be the same than {@code srcPts}. + * May be {@code null} if only the derivative matrix is desired. + * @param dstOff the offset to the location of the transformed point that is stored in the destination array. + * @param derivate {@code true} for computing the derivative, or {@code false} if not needed. + * @return the matrix of the transform derivative at the given source position, * or {@code null} if the {@code derivate} argument is {@code false}. * @throws TransformException if the point can not be transformed or * if a problem occurred while calculating the derivative. @@ -369,12 +369,12 @@ public abstract class AbstractMathTransf * *
Implementation note: see {@link IterationStrategy} javadoc for a method skeleton.
* - * @param srcPts The array containing the source point coordinates. - * @param srcOff The offset to the first point to be transformed in the source array. - * @param dstPts The array into which the transformed point coordinates are returned. - * May be the same than {@code srcPts}. - * @param dstOff The offset to the location of the first transformed point that is stored in the destination array. - * @param numPts The number of point objects to be transformed. + * @param srcPts the array containing the source point coordinates. + * @param srcOff the offset to the first point to be transformed in the source array. + * @param dstPts the array into which the transformed point coordinates are returned. + * May be the same than {@code srcPts}. + * @param dstOff the offset to the location of the first transformed point that is stored in the destination array. + * @param numPts the number of point objects to be transformed. * @throws TransformException if a point can not be transformed. Some implementations will stop at the first failure, * wile some other implementations will fill the untransformable points with {@linkplain Double#NaN} values, * continue and throw the exception only at end. Implementations that fall in the later case should set the @@ -406,7 +406,7 @@ public abstract class AbstractMathTransf dstOff += (numPts-1) * dstInc; dstInc = -dstInc; break; } - default: // Following should alway work even for unknown cases. + default: // Following should alway work even for unknown cases. case BUFFER_SOURCE: { srcPts = Arrays.copyOfRange(srcPts, srcOff, srcOff + numPts*srcInc); srcOff = 0; @@ -425,7 +425,7 @@ public abstract class AbstractMathTransf * and continue with other points, up to some maximal amount of failures. */ TransformException failure = null; - int failureCount = 0; // Count ordinates, not coordinates. + int failureCount = 0; // Count ordinates, not coordinates. int blockStart = 0; do { try { @@ -447,12 +447,12 @@ public abstract class AbstractMathTransf */ Arrays.fill(dstPts, dstOff, dstOff + Math.abs(dstInc), Double.NaN); if (failure == null) { - failure = exception; // Keep only the first failure. + failure = exception; // Keep only the first failure. blockStart = srcOff; } else { failure.addSuppressed(exception); if (Math.abs(srcOff - blockStart) > MAXIMUM_BUFFER_SIZE) { - failureCount = 0; // We started a new block of coordinates. + failureCount = 0; // We started a new block of coordinates. blockStart = srcOff; } } @@ -480,12 +480,12 @@ public abstract class AbstractMathTransf * *
Implementation note: see {@link IterationStrategy} javadoc for a method skeleton.
* - * @param srcPts The array containing the source point coordinates. - * @param srcOff The offset to the first point to be transformed in the source array. - * @param dstPts The array into which the transformed point coordinates are returned. - * May be the same than {@code srcPts}. - * @param dstOff The offset to the location of the first transformed point that is stored in the destination array. - * @param numPts The number of point objects to be transformed. + * @param srcPts the array containing the source point coordinates. + * @param srcOff the offset to the first point to be transformed in the source array. + * @param dstPts the array into which the transformed point coordinates are returned. + * May be the same than {@code srcPts}. + * @param dstOff the offset to the location of the first transformed point that is stored in the destination array. + * @param numPts the number of point objects to be transformed. * @throws TransformException if a point can't be transformed. Some implementations will stop at the first failure, * wile some other implementations will fill the un-transformable points with {@link Float#NaN} values, * continue and throw the exception only at end. Implementations that fall in the later case should set @@ -523,10 +523,10 @@ public abstract class AbstractMathTransf */ int srcInc = dimSource * numBufferedPts; int dstInc = dimTarget * numBufferedPts; - int srcStop = srcInc; // src|dstStop will be used and modified in the do..while loop later. + int srcStop = srcInc; // src|dstStop will be used and modified in the do..while loop later. int dstStop = dstInc; if (srcPts == dstPts) { - final int numPass = (numPts + numBufferedPts-1) / numBufferedPts; // Round toward higher integer. + final int numPass = (numPts + numBufferedPts-1) / numBufferedPts; // Round toward higher integer. switch (IterationStrategy.suggest(srcOff, srcInc, dstOff, dstInc, numPass)) { case ASCENDING: { break; @@ -562,9 +562,11 @@ public abstract class AbstractMathTransf srcStop = numPts * dimSource; dstStop = numPts * dimTarget; if (srcInc < 0) { - // If we were applying IterationStrategy.DESCENDING, then srcOff and dstOff - // may be negative at this point because the last pass may not fill all the - // buffer space. We need to apply the correction below. + /* + * If we were applying IterationStrategy.DESCENDING, then srcOff and dstOff + * may be negative at this point because the last pass may not fill all the + * buffer space. We need to apply the correction below. + */ srcOff -= (srcStop + srcInc); dstOff -= (dstStop + dstInc); } @@ -585,7 +587,7 @@ public abstract class AbstractMathTransf if (exception.getLastCompletedTransform() != this) { throw exception; } else if (failure == null) { - failure = exception; // Keep only the first exception. + failure = exception; // Keep only the first exception. } else { failure.addSuppressed(exception); } @@ -606,11 +608,11 @@ public abstract class AbstractMathTransf * Transforms a list of coordinate point ordinal values. The default implementation delegates * to {@link #transform(double[], int, double[], int, int)} using a temporary array of doubles. * - * @param srcPts The array containing the source point coordinates. - * @param srcOff The offset to the first point to be transformed in the source array. - * @param dstPts The array into which the transformed point coordinates are returned. - * @param dstOff The offset to the location of the first transformed point that is stored in the destination array. - * @param numPts The number of point objects to be transformed. + * @param srcPts the array containing the source point coordinates. + * @param srcOff the offset to the first point to be transformed in the source array. + * @param dstPts the array into which the transformed point coordinates are returned. + * @param dstOff the offset to the location of the first transformed point that is stored in the destination array. + * @param numPts the number of point objects to be transformed. * @throws TransformException if a point can not be transformed. Some implementations will stop at the first failure, * wile some other implementations will fill the untransformable points with {@linkplain Float#NaN} values, * continue and throw the exception only at end. Implementations that fall in the later case should set the @@ -670,11 +672,11 @@ public abstract class AbstractMathTransf * to {@link #transform(double[], int, double[], int, int)} using a temporary array of doubles * if necessary. * - * @param srcPts The array containing the source point coordinates. - * @param srcOff The offset to the first point to be transformed in the source array. - * @param dstPts The array into which the transformed point coordinates are returned. - * @param dstOff The offset to the location of the first transformed point that is stored in the destination array. - * @param numPts The number of point objects to be transformed. + * @param srcPts the array containing the source point coordinates. + * @param srcOff the offset to the first point to be transformed in the source array. + * @param dstPts the array into which the transformed point coordinates are returned. + * @param dstOff the offset to the location of the first transformed point that is stored in the destination array. + * @param numPts the number of point objects to be transformed. * @throws TransformException if a point can not be transformed. Some implementations will stop at the first failure, * wile some other implementations will fill the untransformable points with {@linkplain Double#NaN} values, * continue and throw the exception only at end. Implementations that fall in the later case should set the @@ -751,8 +753,8 @@ public abstract class AbstractMathTransf * Otherwise throws {@link TransformException}. * * - * @param point The coordinate point where to evaluate the derivative. - * @return The derivative at the specified point (never {@code null}). + * @param point the coordinate point where to evaluate the derivative. + * @return the derivative at the specified point (never {@code null}). * @throws NullPointerException if the derivative depends on coordinate and {@code point} is {@code null}. * @throws MismatchedDimensionException if {@code point} does not have the expected dimension. * @throws TransformException if the derivative can not be evaluated at the specified point. @@ -809,11 +811,11 @@ public abstract class AbstractMathTransf * by subclasses capable of concatenating some combination of transforms in a special way. * Examples are {@link ExponentialTransform1D} and {@link LogarithmicTransform1D}.

* - * @param other The math transform to apply. - * @param applyOtherFirst {@code true} if the transformation order is {@code other} followed by {@code this}, - * or {@code false} if the transformation order is {@code this} followed by {@code other}. - * @param factory The factory which is (indirectly) invoking this method, or {@code null} if none. - * @return The combined math transform, or {@code null} if no optimized combined transform is available. + * @param other the math transform to apply. + * @param applyOtherFirst {@code true} if the transformation order is {@code other} followed by {@code this}, or + * {@code false} if the transformation order is {@code this} followed by {@code other}. + * @param factory the factory which is (indirectly) invoking this method, or {@code null} if none. + * @return the combined math transform, or {@code null} if no optimized combined transform is available. */ MathTransform concatenate(MathTransform other, boolean applyOtherFirst, MathTransformFactory factory) throws FactoryException @@ -826,10 +828,10 @@ public abstract class AbstractMathTransf * when first needed and caches the value for future invocations. Subclasses shall override * {@code computeHashCode()} instead than this method. * - * @return The hash code value. This value may change between different execution of the Apache SIS library. + * @return the hash code value. This value may change between different execution of the Apache SIS library. */ @Override - public final int hashCode() { // No need to synchronize; ok if invoked twice. + public final int hashCode() { // No need to synchronize; ok if invoked twice. int hash = hashCode; if (hash == 0) { hash = computeHashCode(); @@ -845,7 +847,7 @@ public abstract class AbstractMathTransf /** * Computes a hash value for this transform. This method is invoked by {@link #hashCode()} when first needed. * - * @return The hash code value. This value may change between different execution of the Apache SIS library. + * @return the hash code value. This value may change between different execution of the Apache SIS library. */ protected int computeHashCode() { return getClass().hashCode() + getSourceDimensions() + 31 * getTargetDimensions(); @@ -859,7 +861,7 @@ public abstract class AbstractMathTransf * return equals(other, ComparisonMode.STRICT); * } * - * @param object The object to compare with this transform. + * @param object the object to compare with this transform. * @return {@code true} if the given object is a transform of the same class and using the same parameter values. */ @Override @@ -887,14 +889,16 @@ public abstract class AbstractMathTransf * the given comparison mode. * * - * @param object The object to compare with this transform. - * @param mode The strictness level of the comparison. Default to {@link ComparisonMode#STRICT STRICT}. + * @param object the object to compare with this transform. + * @param mode the strictness level of the comparison. Default to {@link ComparisonMode#STRICT STRICT}. * @return {@code true} if the given object is considered equals to this math transform. */ @Override public boolean equals(final Object object, final ComparisonMode mode) { - // Do not check 'object==this' here, since this - // optimization is usually done in subclasses. + /* + * Do not check 'object==this' here, since this + * optimization is usually done in subclasses. + */ if (object != null && getClass() == object.getClass()) { final AbstractMathTransform that = (AbstractMathTransform) object; /* @@ -935,10 +939,10 @@ public abstract class AbstractMathTransf *

This method is invoked only by {@link ConcatenatedTransform#getPseudoSteps()} in order to * get the {@link ParameterValueGroup} of a map projection, or to format a {@code PROJCS} WKT.

* - * @param transforms The full chain of concatenated transforms. - * @param index The index of this transform in the {@code transforms} chain. - * @param inverse Always {@code false}, except if we are formatting the inverse transform. - * @return Index of this transform in the {@code transforms} chain after processing. + * @param transforms the full chain of concatenated transforms. + * @param index the index of this transform in the {@code transforms} chain. + * @param inverse always {@code false}, except if we are formatting the inverse transform. + * @return index of this transform in the {@code transforms} chain after processing. * * @see ConcatenatedTransform#getPseudoSteps() */ @@ -959,8 +963,8 @@ public abstract class AbstractMathTransf * then this method silently uses the WKT 1 convention without raising an error * (unless this {@code MathTransform} can not be formatted as valid WKT 1 neither). * - * @param formatter The formatter to use. - * @return The WKT element name, which is {@code "Param_MT"} in the default implementation. + * @param formatter the formatter to use. + * @return the WKT element name, which is {@code "Param_MT"} in the default implementation. */ @Override protected String formatTo(final Formatter formatter) { @@ -1051,7 +1055,7 @@ public abstract class AbstractMathTransf /** * Returns the inverse of this math transform, which is the enclosing math transform. * - * @return The enclosing math transform. + * @return the enclosing math transform. */ @Override public MathTransform inverse() { @@ -1089,8 +1093,7 @@ public abstract class AbstractMathTransf @Override public boolean equals(final Object object, final ComparisonMode mode) { if (object == this) { - // Slight optimization - return true; + return true; // Slight optimization } if (object != null && object.getClass() == getClass()) { return AbstractMathTransform.this.equals(((Inverse) object).inverse(), mode); @@ -1122,8 +1125,8 @@ public abstract class AbstractMathTransf *
Compatibility note: * {@code Param_MT} and {@code Inverse_MT} are defined in the WKT 1 specification only.
* - * @param formatter The formatter to use. - * @return The WKT element name, which is {@code "Param_MT"} or + * @param formatter the formatter to use. + * @return the WKT element name, which is {@code "Param_MT"} or * {@code "Inverse_MT"} in the default implementation. */ @Override Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform1D.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform1D.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform1D.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform1D.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -82,7 +82,7 @@ public abstract class AbstractMathTransf /** * Transforms the specified value. * - * @param value The value to transform. + * @param value the value to transform. * @return the transformed value. * @throws TransformException if the value can not be transformed. */ @@ -113,8 +113,8 @@ public abstract class AbstractMathTransf * Gets the derivative of this function at a value. The derivative is the 1×1 matrix * of the non-translating portion of the approximate affine map at the value. * - * @param value The value where to evaluate the derivative. - * @return The derivative at the specified point. + * @param value the value where to evaluate the derivative. + * @return the derivative at the specified point. * @throws TransformException if the derivative can not be evaluated at the specified point. */ @Override @@ -124,8 +124,8 @@ public abstract class AbstractMathTransf * Gets the derivative of this transform at a point. The default implementation ensures that * {@code point} is one-dimensional, then delegates to {@link #derivative(double)}. * - * @param point The coordinate point where to evaluate the derivative, or {@code null}. - * @return The derivative at the specified point (never {@code null}). + * @param point the coordinate point where to evaluate the derivative, or {@code null}. + * @return the derivative at the specified point (never {@code null}). * @throws MismatchedDimensionException if {@code point} does not have the expected dimension. * @throws TransformException if the derivative can not be evaluated at the specified point. */ @@ -211,8 +211,8 @@ public abstract class AbstractMathTransf * Gets the derivative of this transform at a point. The default implementation ensures that * {@code point} is one-dimensional, then delegates to {@link #derivative(double)}. * - * @param point The coordinate point where to evaluate the derivative, or {@code null}. - * @return The derivative at the specified point (never {@code null}). + * @param point the coordinate point where to evaluate the derivative, or {@code null}. + * @return the derivative at the specified point (never {@code null}). * @throws MismatchedDimensionException if {@code point} does not have the expected dimension. * @throws TransformException if the derivative can not be evaluated at the specified point. */ Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform2D.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform2D.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform2D.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform2D.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -90,12 +90,12 @@ public abstract class AbstractMathTransf * The default implementation invokes {@link #transform(double[], int, double[], int, boolean)} * using a temporary array of doubles. * - * @param ptSrc The coordinate point to be transformed. - * @param ptDst The coordinate point that stores the result of transforming {@code ptSrc}, - * or {@code null} if a new point shall be created. - * @return The coordinate point after transforming {@code ptSrc} and storing the result in {@code ptDst}, + * @param ptSrc the coordinate point to be transformed. + * @param ptDst the coordinate point that stores the result of transforming {@code ptSrc}, + * or {@code null} if a new point shall be created. + * @return the coordinate point after transforming {@code ptSrc} and storing the result in {@code ptDst}, * or in a new point if {@code ptDst} was null. - * @throws TransformException If the point can not be transformed. + * @throws TransformException if the point can not be transformed. * * @see MathTransform2D#transform(Point2D, Point2D) */ @@ -124,8 +124,8 @@ public abstract class AbstractMathTransf * a {@link Path2D}, but may also be a {@link Line2D} or a {@link QuadCurve2D} if such * simplification is possible. * - * @param shape Shape to transform. - * @return Transformed shape, or {@code shape} if this transform is the identity transform. + * @param shape shape to transform. + * @return transformed shape, or {@code shape} if this transform is the identity transform. * @throws TransformException if a transform failed. */ @Override @@ -138,16 +138,15 @@ public abstract class AbstractMathTransf * The new object is often a {@link Path2D}, but may also be a {@link Line2D} or a {@link QuadCurve2D} * if such simplification is possible. * - * @param mt The math transform to use. - * @param shape The geometric shape to transform. - * @param preTransform An optional affine transform to apply before the - * transformation using {@code this}, or {@code null} if none. - * @param postTransform An optional affine transform to apply after the transformation - * using {@code this}, or {@code null} if none. - * @param horizontal {@code true} for forcing parabolic equation. - * - * @return The transformed geometric shape. - * @throws TransformException If a transformation failed. + * @param mt the math transform to use. + * @param shape the geometric shape to transform. + * @param preTransform an optional affine transform to apply before the + * transformation using {@code this}, or {@code null} if none. + * @param postTransform an optional affine transform to apply after the transformation + * using {@code this}, or {@code null} if none. + * @param horizontal {@code true} for forcing parabolic equation. + * @return the transformed geometric shape. + * @throws TransformException if a transformation failed. */ static Shape createTransformedShape(final MathTransform2D mt, final Shape shape, @@ -160,8 +159,8 @@ public abstract class AbstractMathTransf final Path2D.Double path = new Path2D.Double(it.getWindingRule()); final double[] buffer = new double[6]; - double ax=0, ay=0; // Coordinate of the last point before transform. - double px=0, py=0; // Coordinate of the last point after transform. + double ax=0, ay=0; // Coordinate of the last point before transform. + double px=0, py=0; // Coordinate of the last point after transform. for (; !it.isDone(); it.next()) { switch (it.currentSegment(buffer)) { default: { @@ -284,8 +283,8 @@ public abstract class AbstractMathTransf * Otherwise throws {@link TransformException}. * * - * @param point The coordinate point where to evaluate the derivative. - * @return The derivative at the specified point as a 2×2 matrix. + * @param point the coordinate point where to evaluate the derivative. + * @return the derivative at the specified point as a 2×2 matrix. * @throws TransformException if the derivative can not be evaluated at the specified point. */ @Override @@ -356,12 +355,12 @@ public abstract class AbstractMathTransf * The default implementation invokes {@link #transform(double[], int, double[], int, boolean)} * using a temporary array of doubles. * - * @param ptSrc The coordinate point to be transformed. - * @param ptDst The coordinate point that stores the result of transforming {@code ptSrc}, - * or {@code null} if a new point shall be created. - * @return The coordinate point after transforming {@code ptSrc} and storing the result in {@code ptDst}, + * @param ptSrc the coordinate point to be transformed. + * @param ptDst the coordinate point that stores the result of transforming {@code ptSrc}, + * or {@code null} if a new point shall be created. + * @return the coordinate point after transforming {@code ptSrc} and storing the result in {@code ptDst}, * or in a new point if {@code ptDst} was null. - * @throws TransformException If the point can not be transformed. + * @throws TransformException if the point can not be transformed. * * @see MathTransform2D#transform(Point2D, Point2D) */ @@ -376,8 +375,8 @@ public abstract class AbstractMathTransf * a {@link Path2D}, but may also be a {@link Line2D} or a {@link QuadCurve2D} if such * simplification is possible. * - * @param shape Shape to transform. - * @return Transformed shape, or {@code shape} if this transform is the identity transform. + * @param shape shape to transform. + * @return transformed shape, or {@code shape} if this transform is the identity transform. * @throws TransformException if a transform failed. */ @Override @@ -397,8 +396,8 @@ public abstract class AbstractMathTransf * Otherwise throws {@link TransformException}. * * - * @param point The coordinate point where to evaluate the derivative. - * @return The derivative at the specified point as a 2×2 matrix. + * @param point the coordinate point where to evaluate the derivative. + * @return the derivative at the specified point as a 2×2 matrix. * @throws TransformException if the derivative can not be evaluated at the specified point. */ @Override Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransform.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransform.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransform.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransform.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -589,9 +589,11 @@ class ConcatenatedTransform extends Abst throws TransformException { assert isValid(); - // Note: If we know that the transfer dimension is the same than source - // and target dimension, then we don't need to use an intermediate - // point. This optimization is done in ConcatenatedTransformDirect. + /* + * Note: If we know that the transfer dimension is the same than source + * and target dimension, then we don't need to use an intermediate + * point. This optimization is done in ConcatenatedTransformDirect. + */ return transform2.transform(transform1.transform(ptSrc, null), ptDst); } @@ -829,8 +831,10 @@ class ConcatenatedTransform extends Abst final double[] dstPts, int dstOff, int numPts) throws TransformException { - // Same code than transform(double[], ..., double[], ...) but the method calls - // are actually different because of overloading of the "transform" methods. + /* + * Same code than transform(double[], ..., double[], ...) but the method calls + * are actually different because of overloading of the "transform" methods. + */ assert isValid(); final int bufferDim = transform2.getSourceDimensions(); final int targetDim = transform2.getTargetDimensions(); @@ -942,8 +946,8 @@ class ConcatenatedTransform extends Abst *
Compatibility note: * {@code Concat_MT} is defined in the WKT 1 specification only.
* - * @param formatter The formatter to use. - * @return The WKT element name, which is {@code "Concat_MT"}. + * @param formatter the formatter to use. + * @return the WKT element name, which is {@code "Concat_MT"}. */ @Override protected String formatTo(final Formatter formatter) { Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransform2D.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransform2D.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransform2D.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransform2D.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -77,8 +77,8 @@ final class ConcatenatedTransform2D exte /** * Transforms the specified shape. * - * @param shape Shape to transform. - * @return Transformed shape. + * @param shape shape to transform. + * @return transformed shape. * @throws TransformException if a transform failed. */ @Override @@ -91,8 +91,8 @@ final class ConcatenatedTransform2D exte * {@link #derivative(DirectPosition)} method because the transformation steps * {@link #transform1} and {@link #transform2} may not be instances of {@link MathTransform2D}. * - * @param point The coordinate point where to evaluate the derivative. - * @return The derivative at the specified point as a 2×2 matrix. + * @param point the coordinate point where to evaluate the derivative. + * @return the derivative at the specified point as a 2×2 matrix. * @throws TransformException if the derivative can't be evaluated at the specified point. */ @Override Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransformDirect.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransformDirect.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransformDirect.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransformDirect.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -94,7 +94,9 @@ class ConcatenatedTransformDirect extend transform2.transform(dstPts, dstOff, dstPts, dstOff, numPts); } - // Do NOT override the transform(..., float[]...) version because we really need to use - // an intermediate buffer of type double[] for reducing rounding error. Otherwise some - // map projection degrades image quality in an unacceptable way. + /* + * Do NOT override the transform(..., float[]...) version because we really need to use + * an intermediate buffer of type double[] for reducing rounding error. Otherwise some + * map projection degrades image quality in an unacceptable way. + */ } Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransformDirect2D.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransformDirect2D.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransformDirect2D.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConcatenatedTransformDirect2D.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -71,8 +71,8 @@ final class ConcatenatedTransformDirect2 /** * Transforms the specified shape. * - * @param shape Shape to transform. - * @return Transformed shape. + * @param shape shape to transform. + * @return transformed shape. * @throws TransformException if a transform failed. */ @Override @@ -83,8 +83,8 @@ final class ConcatenatedTransformDirect2 /** * Gets the derivative of this transform at a point. * - * @param point The coordinate point where to evaluate the derivative. - * @return The derivative at the specified point (never {@code null}). + * @param point the coordinate point where to evaluate the derivative. + * @return the derivative at the specified point (never {@code null}). * @throws TransformException if the derivative can't be evaluated at the specified point. */ @Override Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConstantTransform1D.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConstantTransform1D.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConstantTransform1D.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ConstantTransform1D.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -49,7 +49,7 @@ final class ConstantTransform1D extends /** * Constructs a new constant transform. * - * @param offset The {@code offset} term in the linear equation. + * @param offset the {@code offset} term in the linear equation. */ ConstantTransform1D(final double offset) { super(0, offset); Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ContextualParameter.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ContextualParameter.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ContextualParameter.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ContextualParameter.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -42,13 +42,14 @@ import org.apache.sis.parameter.DefaultP * {@code UnmodifiableParameterValue} instances anyway. So no matter which temporary instance we used, we will end * with the same objects in memory anyway. * - * @param The type of the value stored in this parameter. + * @param the type of the value stored in this parameter. * * @author Martin Desruisseaux (Geomatys) * @since 0.7 * @version 0.7 * @module */ +@SuppressWarnings("CloneableClassWithoutClone") // No additional fields compared to parent. final class ContextualParameter extends DefaultParameterValue { /** * For cross-version compatibility. @@ -59,7 +60,7 @@ final class ContextualParameter exten * Creates a parameter value from the specified descriptor. * The value will be initialized to the default value, if any. * - * @param descriptor The abstract definition of this parameter. + * @param descriptor the abstract definition of this parameter. */ ContextualParameter(final ParameterDescriptor descriptor) { super(descriptor); @@ -69,8 +70,8 @@ final class ContextualParameter exten * Sets the parameter value and its associated unit without any verification of parameter validity * (except value type). * - * @param value The parameter value, or {@code null} to restore the default. - * @param unit The unit associated to the new parameter value, or {@code null}. + * @param value the parameter value, or {@code null} to restore the default. + * @param unit the unit associated to the new parameter value, or {@code null}. */ @Override protected void setValue(final Object value, final Unit unit) { Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ContextualParameters.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ContextualParameters.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ContextualParameters.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/ContextualParameters.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -242,7 +242,7 @@ public class ContextualParameters extend * * See class javadoc for more information. * - * @param method The non-linear operation method for which to define the parameter values. + * @param method the non-linear operation method for which to define the parameter values. */ public ContextualParameters(final OperationMethod method) { ensureNonNull("method", method); @@ -255,9 +255,9 @@ public class ContextualParameters extend /** * Equivalent to the public constructor, but avoid the need for an {@link OperationMethod} instance. * - * @param descriptor The parameter descriptor. - * @param srcSize Size of the normalization matrix: source dimensions + 1. - * @param tgtSize Size of the denormalization matrix: target dimensions + 1. + * @param descriptor the parameter descriptor. + * @param srcSize size of the normalization matrix: source dimensions + 1. + * @param tgtSize size of the denormalization matrix: target dimensions + 1. */ ContextualParameters(final ParameterDescriptorGroup descriptor, final int srcSize, final int tgtSize) { this.descriptor = descriptor; @@ -269,8 +269,8 @@ public class ContextualParameters extend /** * Creates a {@code ContextualParameters} for the inverse operation. * - * @param desc Descriptor of the inverse operation. - * @param forward The parameters created for the forward operation. + * @param desc descriptor of the inverse operation. + * @param forward the parameters created for the forward operation. */ private ContextualParameters(final ParameterDescriptorGroup desc, final ContextualParameters forward) { descriptor = desc; @@ -297,8 +297,8 @@ public class ContextualParameters extend /** * Creates a {@code ContextualParameters} for the inverse operation. * - * @param desc Descriptor of the inverse operation. - * @return Parameters for the inverse operation. + * @param desc descriptor of the inverse operation. + * @return parameters for the inverse operation. */ final synchronized ContextualParameters inverse(final ParameterDescriptorGroup desc) { if (inverse == null) { @@ -326,7 +326,7 @@ public class ContextualParameters extend * kernels are instances of {@link org.apache.sis.referencing.operation.projection.NormalizedProjection}. * Other "kernels" in SIS are {@link EllipsoidToCentricTransform} and {@link MolodenskyTransform}. * - * @return The description of the parameters. + * @return the description of the parameters. */ @Override public final ParameterDescriptorGroup getDescriptor() { @@ -387,10 +387,10 @@ public class ContextualParameters extend * * * - * @param role {@code NORMALIZATION} for fetching the normalization transform to apply before the kernel, - * {@code DENORMALIZATION} for the denormalization transform to apply after the kernel, - * or {@code INVERSE_*} for the inverse of the above-cited matrices. - * @return The matrix for the requested normalization or denormalization affine transform. + * @param role {@code NORMALIZATION} for fetching the normalization transform to apply before the kernel, + * {@code DENORMALIZATION} for the denormalization transform to apply after the kernel, or + * {@code INVERSE_*} for the inverse of the above-cited matrices. + * @return the matrix for the requested normalization or denormalization affine transform. * * @since 0.7 */ @@ -432,8 +432,8 @@ public class ContextualParameters extend * *
{@include formulas.html#NormalizeGeographic}
* - * @param λ0 Longitude of the central meridian, in degrees. - * @return The normalization affine transform as a matrix. + * @param λ0 longitude of the central meridian, in degrees. + * @return the normalization affine transform as a matrix. * Callers can change that matrix directly if they want to apply additional normalization operations. * @throws IllegalStateException if this {@code ContextualParameter} has been made unmodifiable. */ @@ -466,8 +466,8 @@ public class ContextualParameters extend * *
{@include formulas.html#DenormalizeGeographic}
* - * @param λ0 Longitude of the central meridian, in degrees. - * @return The denormalization affine transform as a matrix. + * @param λ0 longitude of the central meridian, in degrees. + * @return the denormalization affine transform as a matrix. * Callers can change that matrix directly if they want to apply additional denormalization operations. * @throws IllegalStateException if this {@code ContextualParameter} has been made unmodifiable. */ @@ -492,10 +492,10 @@ public class ContextualParameters extend * outside {@code ContextualParameters}. Efficient concatenation of those steps will happen "under * the hood".

* - * @param factory The factory to use for creating math transform instances. - * @param kernel The (usually non-linear) kernel. - * This is often a {@link org.apache.sis.referencing.operation.projection.NormalizedProjection}. - * @return The concatenation of normalize → the given kernel → denormalize + * @param factory the factory to use for creating math transform instances. + * @param kernel the (usually non-linear) kernel. + * This is often a {@link org.apache.sis.referencing.operation.projection.NormalizedProjection}. + * @return the concatenation of normalize → the given kernel → denormalize * transforms. * @throws FactoryException if an error occurred while creating a math transform instance. * @@ -581,8 +581,8 @@ public class ContextualParameters extend * * After the call to {@code completeTransform(…)}, the returned parameters are read-only. * - * @param name The name of the parameter to search. - * @return The parameter value for the given name. + * @param name the name of the parameter to search. + * @return the parameter value for the given name. * @throws ParameterNotFoundException if there is no parameter of the given name. */ @Override @@ -628,7 +628,7 @@ public class ContextualParameters extend * Returns an unmodifiable list containing all parameters in this group. * Callers should not attempt to modify the parameter values in this list. * - * @return All parameter values. + * @return all parameter values. */ @Override @SuppressWarnings("unchecked") @@ -643,8 +643,8 @@ public class ContextualParameters extend /** * Unsupported operation, since {@code ContextualParameters} groups do not contain sub-groups. * - * @param name Ignored. - * @return Never returned. + * @param name ignored. + * @return never returned. */ @Override public List groups(final String name) { @@ -654,8 +654,8 @@ public class ContextualParameters extend /** * Unsupported operation, since {@code ContextualParameters} groups do not contain sub-groups. * - * @param name Ignored. - * @return Never returned. + * @param name ignored. + * @return never returned. */ @Override public ParameterValueGroup addGroup(final String name) { @@ -673,7 +673,7 @@ public class ContextualParameters extend /** * Returns a modifiable clone of this parameter value group. * - * @return A clone of this parameter value group. + * @return a clone of this parameter value group. */ @Override public synchronized ContextualParameters clone() { @@ -712,7 +712,7 @@ public class ContextualParameters extend /** * Compares the given object with the parameters for equality. * - * @param object The object to compare with the parameters. + * @param object the object to compare with the parameters. * @return {@code true} if the given object is equal to this one. */ @Override @@ -794,10 +794,10 @@ public class ContextualParameters extend *

This method is invoked (indirectly) only by {@link ConcatenatedTransform#getPseudoSteps()} in order * to get the {@link ParameterValueGroup} of a map projection, or to format a {@code ProjectedCRS} WKT.

* - * @param transforms The full chain of concatenated transforms. - * @param index The index of this transform in the {@code transforms} chain. - * @param inverse Always {@code false}, except if we are formatting the inverse transform. - * @return Index of this transform in the {@code transforms} chain after processing. + * @param transforms the full chain of concatenated transforms. + * @param index the index of this transform in the {@code transforms} chain. + * @param inverse always {@code false}, except if we are formatting the inverse transform. + * @return index of this transform in the {@code transforms} chain after processing. * * @see ConcatenatedTransform#getPseudoSteps() * @see AbstractMathTransform#beforeFormat(List, int, boolean) @@ -836,8 +836,10 @@ public class ContextualParameters extend try { userDefined = getMatrix(inverse ? MatrixRole.DENORMALIZATION : MatrixRole.INVERSE_NORMALIZATION); } catch (IllegalStateException e) { - // Should never happen. But if it does, we abandon the attempt to change - // the list elements and will format the objects in their "raw" format. + /* + * Should never happen. But if it does, we abandon the attempt to change + * the list elements and will format the objects in their "raw" format. + */ unexpectedException(e); return index; } Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/CopyTransform.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/CopyTransform.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/CopyTransform.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/CopyTransform.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -61,10 +61,10 @@ final class CopyTransform extends Abstra /** * Creates a new transform. * - * @param srcDim The dimension of source coordinates. - * Must be greater than the highest value in {@code indices}. - * @param indices The indices of ordinates to copy in the source array. - * The length of this array is the target dimension. + * @param srcDim the dimension of source coordinates. + * Must be greater than the highest value in {@code indices}. + * @param indices the indices of ordinates to copy in the source array. + * The length of this array is the target dimension. */ CopyTransform(final int srcDim, final int[] indices) { this.srcDim = srcDim; @@ -314,7 +314,7 @@ final class CopyTransform extends Abstra * Gets the derivative of this transform at a point. * For a matrix transform, the derivative is the same everywhere. * - * @param point Ignored (can be {@code null}). + * @param point ignored (can be {@code null}). */ @Override public Matrix derivative(final DirectPosition point) { Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/DatumShiftTransform.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/DatumShiftTransform.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/DatumShiftTransform.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/DatumShiftTransform.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -16,6 +16,7 @@ */ package org.apache.sis.referencing.operation.transform; +import java.util.Objects; import java.io.Serializable; import javax.measure.Unit; import javax.measure.quantity.Length; @@ -31,9 +32,6 @@ import org.apache.sis.util.resources.Err import org.apache.sis.util.ComparisonMode; import org.apache.sis.util.Debug; -// Branch-specific imports -import java.util.Objects; - /** * Transforms between two CRS (usually geographic) based on different datum. A datum shift may be needed when two CRS @@ -100,8 +98,8 @@ public abstract class DatumShiftTransfor * Creates a datum shift transform for direct interpolations in a grid. * It is caller responsibility to initialize the {@link #context} parameters. * - * @param descriptor The contextual parameter descriptor. - * @param grid Interpolation grid. + * @param descriptor the contextual parameter descriptor. + * @param grid interpolation grid. */ DatumShiftTransform(ParameterDescriptorGroup descriptor, final DatumShiftGrid grid) { final int size = grid.getTranslationDimensions() + 1; @@ -113,8 +111,8 @@ public abstract class DatumShiftTransfor * Creates a datum shift transform for interpolations in geocentric domain. * It is caller responsibility to initialize the {@link #context} parameters. * - * @param descriptor The contextual parameter descriptor. - * @param grid Interpolation grid in geocentric coordinates, or {@code null} if none. + * @param descriptor the contextual parameter descriptor. + * @param grid interpolation grid in geocentric coordinates, or {@code null} if none. * @param isSource3D {@code true} if the source coordinates have a height. * @param isTarget3D {@code true} if the target coordinates have a height. */ @@ -132,8 +130,8 @@ public abstract class DatumShiftTransfor *

This method is defined here in order to ensure a consistent behavior of * {@link InterpolatedGeocentricTransform} with {@link InterpolatedMolodenskyTransform}.

* - * @param grid The grid to validate. - * @param unit The unit of semi-axis length of the source ellipsoid. + * @param grid the grid to validate. + * @param unit the unit of semi-axis length of the source ellipsoid. * @throws IllegalArgumentException if the given grid is not valid. */ static void ensureGeocentricTranslation(final DatumShiftGrid grid, final Unit unit) @@ -153,10 +151,10 @@ public abstract class DatumShiftTransfor * Sets the semi-axis length in the {@link #context} parameters. * This is a helper method for constructors in some (not all) subclasses. * - * @param semiMajor The semi-major axis length of the source ellipsoid. - * @param semiMinor The semi-minor axis length of the source ellipsoid. - * @param unit The unit of measurement of source ellipsoid axes. - * @param target The target ellipsoid. + * @param semiMajor the semi-major axis length of the source ellipsoid. + * @param semiMinor the semi-minor axis length of the source ellipsoid. + * @param unit the unit of measurement of source ellipsoid axes. + * @param target the target ellipsoid. */ final void setContextParameters(final double semiMajor, final double semiMinor, final Unit unit, final Ellipsoid target) { final UnitConverter c = target.getAxisUnit().getConverterTo(unit); @@ -199,7 +197,7 @@ public abstract class DatumShiftTransfor * {@linkplain org.apache.sis.io.wkt.Convention#INTERNAL debugging purposes}. * The parameters that describe the process as a whole are rather given by {@link #getContextualParameters()}. * - * @return The internal parameter values for this transform. + * @return the internal parameter values for this transform. */ @Debug @Override @@ -213,7 +211,7 @@ public abstract class DatumShiftTransfor * including {@linkplain org.apache.sis.referencing.cs.CoordinateSystems#swapAndScaleAxes axis swapping}. * Those parameters are used for formatting Well Known Text (WKT) and error messages. * - * @return The parameters values for the sequence of + * @return the parameters values for the sequence of * normalize → {@code this} → denormalize transforms. */ @Override Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/DefaultMathTransformFactory.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/DefaultMathTransformFactory.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/DefaultMathTransformFactory.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/DefaultMathTransformFactory.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -329,9 +329,9 @@ public class DefaultMathTransformFactory * The returned set may conservatively contain more {@code OperationMethod} elements than requested * if this {@code MathTransformFactory} does not support filtering by the given type. * - * @param type {@linkplain SingleOperation}.class for fetching all operation methods, - * {@linkplain org.opengis.referencing.operation.Projection}.class for fetching - * only map projection methods, etc. + * @param type {@linkplain SingleOperation}.class for fetching all operation methods, + * {@linkplain org.opengis.referencing.operation.Projection}.class for + * fetching only map projection methods, etc. * @return methods available in this factory for coordinate operations of the given type. * * @see #getDefaultParameters(String) @@ -536,8 +536,8 @@ public class DefaultMathTransformFactory * of prime meridian), see {@link org.apache.sis.referencing.operation.DefaultCoordinateOperationFactory}. * This policy helps to enforce a separation of concerns. * - * @param cs the coordinate system to set as the source, or {@code null}. - * @param ellipsoid the ellipsoid associated to the given coordinate system, or {@code null}. + * @param cs the coordinate system to set as the source, or {@code null}. + * @param ellipsoid the ellipsoid associated to the given coordinate system, or {@code null}. */ public void setSource(final EllipsoidalCS cs, final Ellipsoid ellipsoid) { sourceCS = cs; @@ -692,9 +692,9 @@ public class DefaultMathTransformFactory * parameter value validity. This may result in an {@link InvalidParameterNameException} * or {@link InvalidParameterValueException} to be thrown.

* - * @param writable {@code true} if this method should also check that the parameters group is not - * an instance of {@link UnmodifiableParameterValueGroup}. Current implementation assumes - * that modifiable parameters are instances of {@link DefaultParameterValueGroup}. + * @param writable {@code true} if this method should also check that the parameters group is not an + * instance of {@link UnmodifiableParameterValueGroup}. Current implementation assumes + * that modifiable parameters are instances of {@link DefaultParameterValueGroup}. * @throws IllegalArgumentException if the copy can not be performed because a parameter has * a unrecognized name or an illegal value. */ @@ -754,10 +754,10 @@ public class DefaultMathTransformFactory * if available. This method writes semi-major and semi-minor parameter values only if they do not * already exists in the given parameters. * - * @param ellipsoid the ellipsoid from which to get axis lengths of flattening factor, or {@code null}. - * @param semiMajor {@code "semi_major}, {@code "src_semi_major} or {@code "tgt_semi_major} parameter name. - * @param semiMinor {@code "semi_minor}, {@code "src_semi_minor} or {@code "tgt_semi_minor} parameter name. - * @param inverseFlattening {@code true} if this method can try to set the {@code "inverse_flattening"} parameter. + * @param ellipsoid the ellipsoid from which to get axis lengths of flattening factor, or {@code null}. + * @param semiMajor {@code "semi_major}, {@code "src_semi_major} or {@code "tgt_semi_major} parameter name. + * @param semiMinor {@code "semi_minor}, {@code "src_semi_minor} or {@code "tgt_semi_minor} parameter name. + * @param inverseFlattening {@code true} if this method can try to set the {@code "inverse_flattening"} parameter. * @return the exception if the operation failed, or {@code null} if none. This exception is not thrown now * because the caller may succeed in creating the transform anyway, or otherwise may produce a more * informative exception. Modified: sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/EllipsoidToCentricTransform.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/EllipsoidToCentricTransform.java?rev=1779709&r1=1779708&r2=1779709&view=diff ============================================================================== --- sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/EllipsoidToCentricTransform.java [UTF-8] (original) +++ sis/trunk/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/EllipsoidToCentricTransform.java [UTF-8] Sat Jan 21 09:14:56 2017 @@ -256,12 +256,12 @@ public class EllipsoidToCentricTransform * {@linkplain #getContextualParameters()}.{@linkplain ContextualParameters#completeTransform * completeTransform}(factory, this)}. * - * @param semiMajor The semi-major axis length. - * @param semiMinor The semi-minor axis length. - * @param unit The unit of measurement for the semi-axes and the ellipsoidal height. - * @param withHeight {@code true} if source geographic coordinates include an ellipsoidal height - * (i.e. are 3-D), or {@code false} if they are only 2-D. - * @param target Whether the target coordinate shall be Cartesian or Spherical. + * @param semiMajor the semi-major axis length. + * @param semiMinor the semi-minor axis length. + * @param unit the unit of measurement for the semi-axes and the ellipsoidal height. + * @param withHeight {@code true} if source geographic coordinates include an ellipsoidal height + * (i.e. are 3-D), or {@code false} if they are only 2-D. + * @param target whether the target coordinate shall be Cartesian or Spherical. * * @see #createGeodeticConversion(MathTransformFactory, double, double, Unit, boolean, TargetType) */ @@ -305,7 +305,7 @@ public class EllipsoidToCentricTransform /** * Restores transient fields after deserialization. * - * @param in The input stream from which to deserialize the transform. + * @param in the input stream from which to deserialize the transform. * @throws IOException if an I/O error occurred while reading or if the stream contains invalid data. * @throws ClassNotFoundException if the class serialized on the stream is not on the classpath. */ @@ -334,14 +334,14 @@ public class EllipsoidToCentricTransform *
  • distance from Earth center on the Z axis (toward North pole).
    • * * - * @param factory The factory to use for creating and concatenating the affine transforms. - * @param semiMajor The semi-major axis length. - * @param semiMinor The semi-minor axis length. - * @param unit The unit of measurement for the semi-axes and the ellipsoidal height. - * @param withHeight {@code true} if source geographic coordinates include an ellipsoidal height - * (i.e. are 3-D), or {@code false} if they are only 2-D. - * @param target Whether the target coordinate shall be Cartesian or Spherical. - * @return The conversion from geographic to geocentric coordinates. + * @param factory the factory to use for creating and concatenating the affine transforms. + * @param semiMajor the semi-major axis length. + * @param semiMinor the semi-minor axis length. + * @param unit the unit of measurement for the semi-axes and the ellipsoidal height. + * @param withHeight {@code true} if source geographic coordinates include an ellipsoidal height + * (i.e. are 3-D), or {@code false} if they are only 2-D. + * @param target whether the target coordinate shall be Cartesian or Spherical. + * @return the conversion from geographic to geocentric coordinates. * @throws FactoryException if an error occurred while creating a transform. */ public static MathTransform createGeodeticConversion(final MathTransformFactory factory, @@ -379,11 +379,11 @@ public class EllipsoidToCentricTransform * * The target type is assumed Cartesian because this is the most frequently used target. * - * @param factory The factory to use for creating and concatenating the affine transforms. - * @param ellipsoid The semi-major and semi-minor axis lengths with their unit of measurement. - * @param withHeight {@code true} if source geographic coordinates include an ellipsoidal height - * (i.e. are 3-D), or {@code false} if they are only 2-D. - * @return The conversion from geographic to Cartesian geocentric coordinates. + * @param factory the factory to use for creating and concatenating the affine transforms. + * @param ellipsoid the semi-major and semi-minor axis lengths with their unit of measurement. + * @param withHeight {@code true} if source geographic coordinates include an ellipsoidal height + * (i.e. are 3-D), or {@code false} if they are only 2-D. + * @return the conversion from geographic to Cartesian geocentric coordinates. * @throws FactoryException if an error occurred while creating a transform. */ public static MathTransform createGeodeticConversion(final MathTransformFactory factory, @@ -399,7 +399,7 @@ public class EllipsoidToCentricTransform * including {@linkplain org.apache.sis.referencing.cs.CoordinateSystems#swapAndScaleAxes axis swapping}. * Those parameters are used for formatting Well Known Text (WKT) and error messages. * - * @return The parameters values for the sequence of + * @return the parameters values for the sequence of * normalize → {@code this} → denormalize transforms. */ @Override @@ -417,7 +417,7 @@ public class EllipsoidToCentricTransform * Most GIS applications will instead be interested in the {@linkplain #getContextualParameters() * contextual parameters}. * - * @return A copy of the internal parameter values for this transform. + * @return a copy of the internal parameter values for this transform. */ @Debug @Override @@ -433,7 +433,7 @@ public class EllipsoidToCentricTransform * Returns a description of the internal parameters of this {@code EllipsoidToCentricTransform} transform. * The returned group contains parameter descriptors for the number of dimensions and the eccentricity. * - * @return A description of the internal parameters. + * @return a description of the internal parameters. */ @Debug @Override @@ -463,7 +463,7 @@ public class EllipsoidToCentricTransform /** * Gets the dimension of output points, which is 3. * - * @return Always 3. + * @return always 3. */ @Override public final int getTargetDimensions() { @@ -473,7 +473,7 @@ public class EllipsoidToCentricTransform /** * Returns whether the target coordinate system is Cartesian or Spherical. * - * @return Whether the target coordinate system is Cartesian or Spherical. + * @return whether the target coordinate system is Cartesian or Spherical. */ public final TargetType getTargetType() { return TargetType.CARTESIAN; @@ -489,8 +489,8 @@ public class EllipsoidToCentricTransform * transform derivative, because that calculation needs to inverse a square matrix with all terms in it before * to drop the last row in the two-dimensional case. * - * @param point The coordinate point where to evaluate the derivative. - * @return The derivative at the specified point (never {@code null}). + * @param point the coordinate point where to evaluate the derivative. + * @return the derivative at the specified point (never {@code null}). * @throws TransformException if the derivative can not be evaluated at the specified point. */ @Override @@ -528,14 +528,14 @@ public class EllipsoidToCentricTransform * Implementation of {@link #transform(double[], int, double[], int, boolean)} * with possibility to override the {@link #withHeight} value. * - * @param λ Longitude (radians). - * @param φ Latitude (radians). - * @param h Height above the ellipsoid divided by the length of semi-major axis. - * @param dstPts The array into which the transformed coordinate is returned. - * May be {@code null} if only the derivative matrix is desired. - * @param dstOff The offset to the location of the transformed point that is stored in the destination array. - * @param derivate {@code true} for computing the derivative, or {@code false} if not needed. - * @param wh {@code true} for a 3×3 matrix, or {@code false} for a 3×2 matrix excluding the height elements. + * @param λ longitude (radians). + * @param φ latitude (radians). + * @param h height above the ellipsoid divided by the length of semi-major axis. + * @param dstPts the array into which the transformed coordinate is returned. + * May be {@code null} if only the derivative matrix is desired. + * @param dstOff the offset to the location of the transformed point that is stored in the destination array. + * @param derivate {@code true} for computing the derivative, or {@code false} if not needed. + * @param wh {@code true} for a 3×3 matrix, or {@code false} for a 3×2 matrix excluding the height elements. */ private Matrix transform(final double λ, final double φ, final double h, final double[] dstPts, final int dstOff, @@ -639,12 +639,12 @@ public class EllipsoidToCentricTransform * Converts Cartesian coordinates (X,Y,Z) to ellipsoidal coordinates * (λ,φ) or (λ,φ,h). This method is invoked by the transform returned by {@link #inverse()}. * - * @param srcPts The array containing the source point coordinates. - * @param srcOff The offset to the first point to be transformed in the source array. - * @param dstPts The array into which the transformed point coordinates are returned. - * May be the same than {@code srcPts}. - * @param dstOff The offset to the location of the first transformed point that is stored in the destination array. - * @param numPts The number of point objects to be transformed. + * @param srcPts the array containing the source point coordinates. + * @param srcOff the offset to the first point to be transformed in the source array. + * @param dstPts the array into which the transformed point coordinates are returned. + * May be the same than {@code srcPts}. + * @param dstOff the offset to the location of the first transformed point that is stored in the destination array. + * @param numPts the number of point objects to be transformed. * @throws TransformException if the calculation does not converge. */ protected void inverseTransform(final double[] srcPts, int srcOff, double[] dstPts, int dstOff, int numPts) @@ -734,7 +734,7 @@ next: while (--numPts >= 0) { * Returns the inverse of this transform. The default implementation returns a transform * that will delegate its work to {@link #inverseTransform(double[], int, double[], int, int)}. * - * @return The conversion from (geo)centric to ellipsoidal coordinates. + * @return the conversion from (geo)centric to ellipsoidal coordinates. */ @Override public MathTransform inverse() { @@ -761,8 +761,7 @@ next: while (--numPts >= 0) { @Override public boolean equals(final Object object, final ComparisonMode mode) { if (object == this) { - // Slight optimization - return true; + return true; // Slight optimization } if (super.equals(object, mode)) { final EllipsoidToCentricTransform that = (EllipsoidToCentricTransform) object; @@ -945,9 +944,9 @@ next: while (--numPts >= 0) { * Given a transformation chain to format in WKT, inserts a "Geographic 3D to 2D" pseudo-conversion * after this transform (normally {@code transforms.get(index)}) if this conversion computes no height. * - * @param transforms The full chain of concatenated transforms. - * @param index The index of this transform in the {@code transforms} chain. - * @return Index of this transform in the {@code transforms} chain after processing. + * @param transforms the full chain of concatenated transforms. + * @param index the index of this transform in the {@code transforms} chain. + * @return index of this transform in the {@code transforms} chain after processing. */ @Override final int beforeFormat(final List transforms, int index, final boolean inverse) { @@ -963,9 +962,9 @@ next: while (--numPts >= 0) { * Given a transformation chain to format in WKT, inserts a "Geographic 2D to 3D" pseudo-conversion * before this transform (normally {@code transforms.get(index)}) if this conversion expects no height. * - * @param transforms The full chain of concatenated transforms. - * @param index The index of this transform in the {@code transforms} chain. - * @return Index of this transform in the {@code transforms} chain after processing. + * @param transforms the full chain of concatenated transforms. + * @param index the index of this transform in the {@code transforms} chain. + * @return index of this transform in the {@code transforms} chain after processing. */ @Override final int beforeFormat(final List transforms, int index, final boolean inverse) {