Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelope2D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelope2D.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelope2D.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Envelope2D.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -16,6 +16,7 @@
*/
package org.apache.sis.geometry;
+import java.util.Objects;
import java.awt.geom.Rectangle2D;
import org.opengis.geometry.Envelope;
import org.opengis.geometry.DirectPosition;
@@ -49,9 +50,6 @@ import static org.apache.sis.geometry.Ab
import static org.apache.sis.geometry.AbstractEnvelope.isWrapAround;
import static org.apache.sis.geometry.AbstractEnvelope.isNegativeUnsafe;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* A two-dimensional envelope on top of Java2D rectangle.
@@ -106,6 +104,7 @@ import java.util.Objects;
* @see GeneralEnvelope
* @see org.apache.sis.metadata.iso.extent.DefaultGeographicBoundingBox
*/
+@SuppressWarnings("CloneableClassWithoutClone") // No additional fields compared to parent.
public class Envelope2D extends Rectangle2D.Double implements Envelope, Emptiable, Cloneable {
/**
* Serial number for inter-operability with different versions.
@@ -175,10 +174,10 @@ public class Envelope2D extends Rectangl
* the minimal and maximal values respectively.
* See the class javadoc about anti-meridian spanning for more details.
*
- * @param lowerCorner The fist position.
- * @param upperCorner The second position.
+ * @param lowerCorner the fist position.
+ * @param upperCorner the second position.
* @throws MismatchedReferenceSystemException if the two positions don't use the same CRS.
- * @throws MismatchedDimensionException If the two positions are not two-dimensional.
+ * @throws MismatchedDimensionException if the two positions are not two-dimensional.
*/
public Envelope2D(final DirectPosition lowerCorner, final DirectPosition upperCorner)
throws MismatchedReferenceSystemException, MismatchedDimensionException
@@ -190,8 +189,8 @@ public class Envelope2D extends Rectangl
/**
* Constructs a two-dimensional envelope defined by an other {@link Envelope}.
*
- * @param envelope The envelope to copy (can not be {@code null}).
- * @throws MismatchedDimensionException If the given envelope is not two-dimensional.
+ * @param envelope the envelope to copy (can not be {@code null}).
+ * @throws MismatchedDimensionException if the given envelope is not two-dimensional.
*/
public Envelope2D(final Envelope envelope) throws MismatchedDimensionException {
this(envelope.getCoordinateReferenceSystem(), envelope.getLowerCorner(), envelope.getUpperCorner());
@@ -226,9 +225,9 @@ public class Envelope2D extends Rectangl
* If the given rectangle has negative width or height, they will be interpreted
* as an envelope spanning the anti-meridian.
*
- * @param crs The coordinate reference system, or {@code null}.
- * @param rect The rectangle to copy (can not be {@code null}).
- * @throws MismatchedDimensionException If the given CRS is not two-dimensional.
+ * @param crs the coordinate reference system, or {@code null}.
+ * @param rect the rectangle to copy (can not be {@code null}).
+ * @throws MismatchedDimensionException if the given CRS is not two-dimensional.
*/
public Envelope2D(final CoordinateReferenceSystem crs, final Rectangle2D rect)
throws MismatchedDimensionException
@@ -246,12 +245,12 @@ public class Envelope2D extends Rectangl
* The actual axis orientations are determined by the specified CRS.
* See the <a href="#skip-navbar_top">class javadoc</a> for details.
*
- * @param crs The coordinate reference system, or {@code null}.
- * @param x The <var>x</var> minimal value.
- * @param y The <var>y</var> minimal value.
- * @param width The envelope width. May be negative for envelope spanning the anti-meridian.
- * @param height The envelope height. May be negative for envelope spanning the anti-meridian.
- * @throws MismatchedDimensionException If the given CRS is not two-dimensional.
+ * @param crs the coordinate reference system, or {@code null}.
+ * @param x the <var>x</var> minimal value.
+ * @param y the <var>y</var> minimal value.
+ * @param width the envelope width. May be negative for envelope spanning the anti-meridian.
+ * @param height the envelope height. May be negative for envelope spanning the anti-meridian.
+ * @throws MismatchedDimensionException if the given CRS is not two-dimensional.
*/
public Envelope2D(final CoordinateReferenceSystem crs, final double x, final double y,
final double width, final double height) throws MismatchedDimensionException
@@ -264,7 +263,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the coordinate reference system in which the coordinates are given.
*
- * @return The coordinate reference system, or {@code null}.
+ * @return the coordinate reference system, or {@code null}.
*/
@Override
public final CoordinateReferenceSystem getCoordinateReferenceSystem() {
@@ -277,7 +276,7 @@ public class Envelope2D extends Rectangl
* If the envelope coordinates need to be transformed to the new CRS, consider using
* {@link Envelopes#transform(Envelope, CoordinateReferenceSystem)} instead.
*
- * @param crs The new coordinate reference system, or {@code null}.
+ * @param crs the new coordinate reference system, or {@code null}.
*/
public void setCoordinateReferenceSystem(final CoordinateReferenceSystem crs) {
ensureDimensionMatches("crs", DIMENSION, crs);
@@ -287,7 +286,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the number of dimensions, which is always 2.
*
- * @return Always 2 for bi-dimensional objects.
+ * @return always 2 for bi-dimensional objects.
*/
@Override
public final int getDimension() {
@@ -310,7 +309,7 @@ public class Envelope2D extends Rectangl
* lower corner longitude greater than the upper corner longitude. Such extended interpretation applies
* mostly to axes having {@code WRAPAROUND} range meaning.</div>
*
- * @return A copy of the lower corner, typically (but not necessarily) containing minimal ordinate values.
+ * @return a copy of the lower corner, typically (but not necessarily) containing minimal ordinate values.
*/
@Override
public DirectPosition2D getLowerCorner() {
@@ -333,7 +332,7 @@ public class Envelope2D extends Rectangl
* upper corner longitude less than the lower corner longitude. Such extended interpretation applies
* mostly to axes having {@code WRAPAROUND} range meaning.</div>
*
- * @return A copy of the upper corner, typically (but not necessarily) containing maximal ordinate values.
+ * @return a copy of the upper corner, typically (but not necessarily) containing maximal ordinate values.
*/
@Override
public DirectPosition2D getUpperCorner() {
@@ -352,9 +351,9 @@ public class Envelope2D extends Rectangl
* anti-meridian spanning as documented in the {@link AbstractEnvelope#getMinimum(int)}
* method.
*
- * @param dimension The dimension to query.
- * @return The minimal ordinate value along the given dimension.
- * @throws IndexOutOfBoundsException If the given index is out of bounds.
+ * @param dimension the dimension to query.
+ * @return the minimal ordinate value along the given dimension.
+ * @throws IndexOutOfBoundsException if the given index is out of bounds.
*/
@Override
public double getMinimum(final int dimension) throws IndexOutOfBoundsException {
@@ -376,9 +375,9 @@ public class Envelope2D extends Rectangl
* anti-meridian spanning as documented in the {@link AbstractEnvelope#getMaximum(int)}
* method.
*
- * @param dimension The dimension to query.
- * @return The maximal ordinate value along the given dimension.
- * @throws IndexOutOfBoundsException If the given index is out of bounds.
+ * @param dimension the dimension to query.
+ * @return the maximal ordinate value along the given dimension.
+ * @throws IndexOutOfBoundsException if the given index is out of bounds.
*/
@Override
public double getMaximum(final int dimension) throws IndexOutOfBoundsException {
@@ -400,9 +399,9 @@ public class Envelope2D extends Rectangl
* anti-meridian spanning as documented in the {@link AbstractEnvelope#getMedian(int)}
* method.
*
- * @param dimension The dimension to query.
- * @return The mid ordinate value along the given dimension.
- * @throws IndexOutOfBoundsException If the given index is out of bounds.
+ * @param dimension the dimension to query.
+ * @return the mid ordinate value along the given dimension.
+ * @throws IndexOutOfBoundsException if the given index is out of bounds.
*/
@Override
public double getMedian(final int dimension) throws IndexOutOfBoundsException {
@@ -423,9 +422,9 @@ public class Envelope2D extends Rectangl
* Returns the envelope span along the specified dimension. This method handles anti-meridian
* spanning as documented in the {@link AbstractEnvelope#getSpan(int)} method.
*
- * @param dimension The dimension to query.
- * @return The rectangle width or height, depending the given dimension.
- * @throws IndexOutOfBoundsException If the given index is out of bounds.
+ * @param dimension the dimension to query.
+ * @return the rectangle width or height, depending the given dimension.
+ * @throws IndexOutOfBoundsException if the given index is out of bounds.
*/
@Override
public double getSpan(final int dimension) throws IndexOutOfBoundsException {
@@ -446,7 +445,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the {@linkplain #getMinimum(int) minimal} ordinate value for dimension 0.
*
- * @return The minimal ordinate value for dimension 0.
+ * @return the minimal ordinate value for dimension 0.
*/
@Override
public double getMinX() {
@@ -456,7 +455,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the {@linkplain #getMinimum(int) minimal} ordinate value for dimension 1.
*
- * @return The minimal ordinate value for dimension 1.
+ * @return the minimal ordinate value for dimension 1.
*/
@Override
public double getMinY() {
@@ -466,7 +465,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the {@linkplain #getMaximum(int) maximal} ordinate value for dimension 0.
*
- * @return The maximal ordinate value for dimension 0.
+ * @return the maximal ordinate value for dimension 0.
*/
@Override
public double getMaxX() {
@@ -476,7 +475,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the {@linkplain #getMaximum(int) maximal} ordinate value for dimension 1.
*
- * @return The maximal ordinate value for dimension 1.
+ * @return the maximal ordinate value for dimension 1.
*/
@Override
public double getMaxY() {
@@ -486,7 +485,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the {@linkplain #getMedian(int) median} ordinate value for dimension 0.
*
- * @return The median ordinate value for dimension 0.
+ * @return the median ordinate value for dimension 0.
*/
@Override
public double getCenterX() {
@@ -496,7 +495,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the {@linkplain #getMedian(int) median} ordinate value for dimension 1.
*
- * @return The median ordinate value for dimension 1.
+ * @return the median ordinate value for dimension 1.
*/
@Override
public double getCenterY() {
@@ -506,7 +505,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the {@linkplain #getSpan(int) span} for dimension 0.
*
- * @return The span for dimension 0.
+ * @return the span for dimension 0.
*/
@Override
public double getWidth() {
@@ -516,7 +515,7 @@ public class Envelope2D extends Rectangl
/**
* Returns the {@linkplain #getSpan(int) span} for dimension 1.
*
- * @return The span for dimension 1.
+ * @return the span for dimension 1.
*/
@Override
public double getHeight() {
@@ -563,7 +562,7 @@ public class Envelope2D extends Rectangl
* The return type is the {@code Rectangle2D.Double} implementation class rather than the {@code Rectangle2D}
* abstract class because the {@code Envelope2D} class hierarchy already exposes this implementation choice.</div>
*
- * @return A representation of this envelope as an array of non-empty Java2D rectangles.
+ * @return a representation of this envelope as an array of non-empty Java2D rectangles.
* The array never contains {@code this}.
*
* @see GeneralEnvelope#toSimpleEnvelopes()
@@ -649,10 +648,10 @@ public class Envelope2D extends Rectangl
* This method supports anti-meridian spanning in the same way than
* {@link AbstractEnvelope#contains(DirectPosition)}.
*
- * @param px The first ordinate value of the point to text.
- * @param py The second ordinate value of the point to text.
- * @return {@code true} if the specified coordinate is inside the boundary
- * of this envelope; {@code false} otherwise.
+ * @param px the first ordinate value of the point to text.
+ * @param py the second ordinate value of the point to text.
+ * @return {@code true} if the specified coordinate is inside the boundary of this envelope;
+ * {@code false} otherwise.
*/
@Override
public boolean contains(final double px, final double py) {
@@ -677,7 +676,7 @@ public class Envelope2D extends Rectangl
* This method supports anti-meridian spanning in the same way than
* {@link AbstractEnvelope#contains(Envelope)}.
*
- * @param rect The rectangle to test for inclusion.
+ * @param rect the rectangle to test for inclusion.
* @return {@code true} if this envelope completely encloses the specified rectangle.
*/
@Override
@@ -699,10 +698,10 @@ public class Envelope2D extends Rectangl
* This method supports anti-meridian spanning in the same way than
* {@link AbstractEnvelope#contains(Envelope)}.
*
- * @param rx The <var>x</var> ordinate of the lower corner of the rectangle to test for inclusion.
- * @param ry The <var>y</var> ordinate of the lower corner of the rectangle to test for inclusion.
- * @param rw The width of the rectangle to test for inclusion. May be negative if the rectangle spans the anti-meridian.
- * @param rh The height of the rectangle to test for inclusion. May be negative.
+ * @param rx the <var>x</var> ordinate of the lower corner of the rectangle to test for inclusion.
+ * @param ry the <var>y</var> ordinate of the lower corner of the rectangle to test for inclusion.
+ * @param rw the width of the rectangle to test for inclusion. May be negative if the rectangle spans the anti-meridian.
+ * @param rh the height of the rectangle to test for inclusion. May be negative.
* @return {@code true} if this envelope completely encloses the specified one.
*/
@Override
@@ -716,8 +715,9 @@ public class Envelope2D extends Rectangl
min0 = y; span0 = height;
min1 = ry; span1 = rh;
}
- // See AbstractEnvelope.contains(Envelope) for an
- // illustration of the algorithm applied here.
+ /*
+ * See AbstractEnvelope.contains(Envelope) for an illustration of the algorithm applied here.
+ */
final boolean minCondition = (min1 >= min0);
final boolean maxCondition = (min1 + span1 <= min0 + span0);
if (minCondition & maxCondition) {
@@ -746,7 +746,7 @@ public class Envelope2D extends Rectangl
* This method supports anti-meridian spanning in the same way than
* {@link AbstractEnvelope#intersects(Envelope)}.
*
- * @param rect The rectangle to test for intersection.
+ * @param rect the rectangle to test for intersection.
* @return {@code true} if this envelope intersects the specified rectangle.
*/
@Override
@@ -768,10 +768,10 @@ public class Envelope2D extends Rectangl
* This method supports anti-meridian spanning in the same way than
* {@link AbstractEnvelope#intersects(Envelope)}.
*
- * @param rx The <var>x</var> ordinate of the lower corner of the rectangle to test for intersection.
- * @param ry The <var>y</var> ordinate of the lower corner of the rectangle to test for intersection.
- * @param rw The width of the rectangle to test for inclusion. May be negative if the rectangle spans the anti-meridian.
- * @param rh The height of the rectangle to test for inclusion. May be negative.
+ * @param rx the <var>x</var> ordinate of the lower corner of the rectangle to test for intersection.
+ * @param ry the <var>y</var> ordinate of the lower corner of the rectangle to test for intersection.
+ * @param rw the width of the rectangle to test for inclusion. May be negative if the rectangle spans the anti-meridian.
+ * @param rh the height of the rectangle to test for inclusion. May be negative.
* @return {@code true} if this envelope intersects the specified rectangle.
*/
@Override
@@ -785,8 +785,9 @@ public class Envelope2D extends Rectangl
min0 = y; span0 = height;
min1 = ry; span1 = rh;
}
- // See AbstractEnvelope.intersects(Envelope) for an
- // illustration of the algorithm applied here.
+ /*
+ * See AbstractEnvelope.intersects(Envelope) for an illustration of the algorithm applied here.
+ */
final boolean minCondition = (min1 <= min0 + span0);
final boolean maxCondition = (min1 + span1 >= min0);
if (maxCondition & minCondition) {
@@ -813,8 +814,8 @@ public class Envelope2D extends Rectangl
* This method supports anti-meridian spanning in the same way than
* {@link GeneralEnvelope#intersect(Envelope)}.
*
- * @param rect The rectangle to be intersected with this envelope.
- * @return The intersection of the given rectangle with this envelope.
+ * @param rect the rectangle to be intersected with this envelope.
+ * @return the intersection of the given rectangle with this envelope.
*/
@Override
public Envelope2D createIntersection(final Rectangle2D rect) {
@@ -879,8 +880,8 @@ public class Envelope2D extends Rectangl
* The default implementation clones this envelope, then delegates
* to {@link #add(Rectangle2D)}.
*
- * @param rect The rectangle to add to this envelope.
- * @return The union of the given rectangle with this envelope.
+ * @param rect the rectangle to add to this envelope.
+ * @return the union of the given rectangle with this envelope.
*/
@Override
public Envelope2D createUnion(final Rectangle2D rect) {
@@ -900,7 +901,7 @@ public class Envelope2D extends Rectangl
* infinities. In the later case, the field values are set to {@code NaN} because infinite
* values are a little bit problematic in {@link Rectangle2D} objects.
*
- * @param rect The rectangle to add to this envelope.
+ * @param rect the rectangle to add to this envelope.
*/
@Override
public void add(final Rectangle2D rect) {
@@ -968,10 +969,10 @@ public class Envelope2D extends Rectangl
/**
* Sets the envelope range along the specified dimension.
*
- * @param dimension The dimension to set.
- * @param minimum The minimum value along the specified dimension.
- * @param maximum The maximum value along the specified dimension.
- * @throws IndexOutOfBoundsException If the given index is out of bounds.
+ * @param dimension the dimension to set.
+ * @param minimum the minimum value along the specified dimension.
+ * @param maximum the maximum value along the specified dimension.
+ * @throws IndexOutOfBoundsException if the given index is out of bounds.
*/
private void setRange(final int dimension, final double minimum, final double maximum)
throws IndexOutOfBoundsException
@@ -996,8 +997,8 @@ public class Envelope2D extends Rectangl
* This method supports anti-meridian spanning in the same way than
* {@link GeneralEnvelope#add(DirectPosition)}.
*
- * @param px The first ordinate of the point to add.
- * @param py The second ordinate of the point to add.
+ * @param px the first ordinate of the point to add.
+ * @param py the second ordinate of the point to add.
*/
@Override
public void add(final double px, final double py) {
@@ -1037,7 +1038,7 @@ public class Envelope2D extends Rectangl
* {@link Rectangle2D#equals(Object)} method, which compare arbitrary {@code Rectangle2D}
* implementations.
*
- * @param object The object to compare with this envelope.
+ * @param object the object to compare with this envelope.
* @return {@code true} if the given object is equal to this envelope.
*/
@Override
@@ -1059,14 +1060,11 @@ public class Envelope2D extends Rectangl
* bounds in two specified dimensions. The coordinate reference system is not compared, since
* it doesn't need to have the same number of dimensions.
*
- * @param that The envelope to compare to.
- * @param xDim The dimension of {@code that} envelope to compare to the <var>x</var> dimension
- * of {@code this} envelope.
- * @param yDim The dimension of {@code that} envelope to compare to the <var>y</var> dimension
- * of {@code this} envelope.
- * @param eps A small tolerance number for floating point number comparisons. This value will
- * be scaled according this envelope {@linkplain #width width} and
- * {@linkplain #height height}.
+ * @param that the envelope to compare to.
+ * @param xDim the dimension of {@code that} envelope to compare to the <var>x</var> dimension of {@code this} envelope.
+ * @param yDim the dimension of {@code that} envelope to compare to the <var>y</var> dimension of {@code this} envelope.
+ * @param eps a small tolerance number for floating point number comparisons. This value will be scaled
+ * according this envelope {@linkplain #width width} and {@linkplain #height height}.
* @return {@code true} if the envelope bounds are the same (up to the specified tolerance
* level) in the specified dimensions, or {@code false} otherwise.
*/
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralDirectPosition.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -22,6 +22,7 @@ package org.apache.sis.geometry;
* to force installation of the Java2D module (e.g. JavaFX/SWT).
*/
import java.util.Arrays;
+import java.util.Objects;
import java.io.Serializable;
import java.lang.reflect.Field;
import java.security.AccessController;
@@ -33,9 +34,6 @@ import org.apache.sis.util.resources.Err
import static org.apache.sis.util.ArgumentChecks.ensureDimensionMatches;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* A mutable {@code DirectPosition} (the coordinates of a position) of arbitrary dimension.
@@ -87,7 +85,7 @@ public class GeneralDirectPosition exten
* Constructs a position using the specified coordinate reference system.
* The number of dimensions is inferred from the coordinate reference system.
*
- * @param crs The coordinate reference system to be given to this position.
+ * @param crs the coordinate reference system to be given to this position.
*/
public GeneralDirectPosition(final CoordinateReferenceSystem crs) {
this(crs.getCoordinateSystem().getDimension());
@@ -97,7 +95,7 @@ public class GeneralDirectPosition exten
/**
* Constructs a position with the specified number of dimensions.
*
- * @param dimension Number of dimensions.
+ * @param dimension number of dimensions.
* @throws NegativeArraySizeException if {@code dimension} is negative.
*/
public GeneralDirectPosition(final int dimension) throws NegativeArraySizeException {
@@ -114,7 +112,7 @@ public class GeneralDirectPosition exten
* argument lengths since the array is often created implicitly. Furthermore the {@link #ordinates}
* field is public, so cloning the array would not protect the state of this object anyway.</div>
*
- * @param ordinates The ordinate values. This array is <strong>not</strong> cloned.
+ * @param ordinates the ordinate values. This array is <strong>not</strong> cloned.
*/
public GeneralDirectPosition(final double... ordinates) {
this.ordinates = ordinates;
@@ -124,7 +122,7 @@ public class GeneralDirectPosition exten
* Constructs a position initialized to the same values than the specified point.
* This is a copy constructor.
*
- * @param point The position to copy.
+ * @param point the position to copy.
*/
public GeneralDirectPosition(final DirectPosition point) {
ordinates = point.getCoordinate(); // Should already be cloned.
@@ -143,8 +141,8 @@ public class GeneralDirectPosition exten
*
* However this constructor is lenient to other types like {@code POINT ZM}.
*
- * @param wkt The {@code POINT} or other kind of element to parse.
- * @throws IllegalArgumentException If the given string can not be parsed.
+ * @param wkt the {@code POINT} or other kind of element to parse.
+ * @throws IllegalArgumentException if the given string can not be parsed.
*
* @see #toString()
* @see org.apache.sis.measure.CoordinateFormat
@@ -160,7 +158,7 @@ public class GeneralDirectPosition exten
* The length of ordinate sequence (the number of entries).
* This is always equals to the length of the {@link #ordinates} array.
*
- * @return The dimensionality of this position.
+ * @return the dimensionality of this position.
*/
@Override
public final int getDimension() {
@@ -172,7 +170,7 @@ public class GeneralDirectPosition exten
* May be {@code null} if this particular {@code DirectPosition} is included
* in a larger object with such a reference to a CRS.
*
- * @return The coordinate reference system, or {@code null}.
+ * @return the coordinate reference system, or {@code null}.
*/
@Override
public final CoordinateReferenceSystem getCoordinateReferenceSystem() {
@@ -182,9 +180,8 @@ public class GeneralDirectPosition exten
/**
* Sets the coordinate reference system in which the coordinate is given.
*
- * @param crs The new coordinate reference system, or {@code null}.
- * @throws MismatchedDimensionException if the specified CRS doesn't have the expected
- * number of dimensions.
+ * @param crs the new coordinate reference system, or {@code null}.
+ * @throws MismatchedDimensionException if the specified CRS does not have the expected number of dimensions.
*/
public void setCoordinateReferenceSystem(final CoordinateReferenceSystem crs)
throws MismatchedDimensionException
@@ -199,7 +196,7 @@ public class GeneralDirectPosition exten
* <div class="note"><b>API note:</b>
* This method is final for ensuring consistency with the {@link #ordinates}, array field, which is public.</div>
*
- * @return A copy of the {@linkplain #ordinates ordinates} array.
+ * @return a copy of the {@linkplain #ordinates ordinates} array.
*/
@Override
public final double[] getCoordinate() {
@@ -209,9 +206,9 @@ public class GeneralDirectPosition exten
/**
* Sets the ordinate values along all dimensions.
*
- * @param ordinates The new ordinates values, or a {@code null} array
- * for setting all ordinate values to {@link Double#NaN NaN}.
- * @throws MismatchedDimensionException If the length of the specified array is not
+ * @param ordinates the new ordinates values, or a {@code null} array for
+ * setting all ordinate values to {@link Double#NaN NaN}.
+ * @throws MismatchedDimensionException if the length of the specified array is not
* equals to the {@linkplain #getDimension() dimension} of this position.
*/
public void setCoordinate(final double... ordinates) throws MismatchedDimensionException {
@@ -229,8 +226,8 @@ public class GeneralDirectPosition exten
* <div class="note"><b>API note:</b>
* This method is final for ensuring consistency with the {@link #ordinates}, array field, which is public.</div>
*
- * @param dimension The dimension in the range 0 to {@linkplain #getDimension() dimension}-1.
- * @return The ordinate at the specified dimension.
+ * @param dimension the dimension in the range 0 to {@linkplain #getDimension() dimension}-1.
+ * @return the ordinate at the specified dimension.
* @throws IndexOutOfBoundsException if the specified dimension is out of bounds.
*/
@Override
@@ -241,8 +238,8 @@ public class GeneralDirectPosition exten
/**
* Sets the ordinate value along the specified dimension.
*
- * @param dimension The dimension for the ordinate of interest.
- * @param value The ordinate value of interest.
+ * @param dimension the dimension for the ordinate of interest.
+ * @param value the ordinate value of interest.
* @throws IndexOutOfBoundsException if the specified dimension is out of bounds.
*/
@Override
@@ -255,9 +252,9 @@ public class GeneralDirectPosition exten
* contains a coordinate reference system (CRS), then the CRS for this position will
* be set to the CRS of the specified position.
*
- * @param position The new position for this point, or {@code null} for setting all ordinate
- * values to {@link Double#NaN NaN}.
- * @throws MismatchedDimensionException if the given position doesn't have the expected dimension.
+ * @param position the new position for this point,
+ * or {@code null} for setting all ordinate values to {@link Double#NaN NaN}.
+ * @throws MismatchedDimensionException if the given position does not have the expected dimension.
*/
@Override
public void setLocation(final DirectPosition position) throws MismatchedDimensionException {
@@ -298,7 +295,7 @@ public class GeneralDirectPosition exten
/**
* Returns a deep copy of this position.
*
- * @return A copy of this direct position.
+ * @return a copy of this direct position.
*/
@Override
public GeneralDirectPosition clone() {
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/GeneralEnvelope.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -135,7 +135,7 @@ public class GeneralEnvelope extends Arr
* the given reference directly; it does <strong>not</strong> clone the given array. This is
* the desired behavior for proper working of {@link SubEnvelope}.
*
- * @param ordinates The array of ordinate values to store directly (not cloned).
+ * @param ordinates the array of ordinate values to store directly (not cloned).
*/
GeneralEnvelope(final double[] ordinates) {
super(ordinates);
@@ -146,10 +146,10 @@ public class GeneralEnvelope extends Arr
* If at least one corner is associated to a CRS, then the new envelope will also
* be associated to that CRS.
*
- * @param lowerCorner The limits in the direction of decreasing ordinate values for each dimension.
- * @param upperCorner The limits in the direction of increasing ordinate values for each dimension.
- * @throws MismatchedDimensionException If the two positions do not have the same dimension.
- * @throws MismatchedReferenceSystemException If the CRS of the two position are not equal.
+ * @param lowerCorner the limits in the direction of decreasing ordinate values for each dimension.
+ * @param upperCorner the limits in the direction of increasing ordinate values for each dimension.
+ * @throws MismatchedDimensionException if the two positions do not have the same dimension.
+ * @throws MismatchedReferenceSystemException if the CRS of the two position are not equal.
*/
public GeneralEnvelope(final DirectPosition lowerCorner, final DirectPosition upperCorner)
throws MismatchedDimensionException, MismatchedReferenceSystemException
@@ -161,9 +161,9 @@ public class GeneralEnvelope extends Arr
* Constructs an envelope defined by two corners given as sequences of ordinate values.
* The Coordinate Reference System is initially {@code null}.
*
- * @param lowerCorner The limits in the direction of decreasing ordinate values for each dimension.
- * @param upperCorner The limits in the direction of increasing ordinate values for each dimension.
- * @throws MismatchedDimensionException If the two sequences do not have the same length.
+ * @param lowerCorner the limits in the direction of decreasing ordinate values for each dimension.
+ * @param upperCorner the limits in the direction of increasing ordinate values for each dimension.
+ * @throws MismatchedDimensionException if the two sequences do not have the same length.
*/
public GeneralEnvelope(final double[] lowerCorner, final double[] upperCorner) throws MismatchedDimensionException {
super(lowerCorner, upperCorner);
@@ -173,7 +173,7 @@ public class GeneralEnvelope extends Arr
* Constructs an empty envelope of the specified dimension. All ordinates
* are initialized to 0 and the coordinate reference system is undefined.
*
- * @param dimension The envelope dimension.
+ * @param dimension the envelope dimension.
*/
public GeneralEnvelope(final int dimension) {
super(dimension);
@@ -183,7 +183,7 @@ public class GeneralEnvelope extends Arr
* Constructs an empty envelope with the specified coordinate reference system.
* All ordinate values are initialized to 0.
*
- * @param crs The coordinate reference system.
+ * @param crs the coordinate reference system.
*/
public GeneralEnvelope(final CoordinateReferenceSystem crs) {
super(crs);
@@ -192,7 +192,7 @@ public class GeneralEnvelope extends Arr
/**
* Constructs a new envelope with the same data than the specified envelope.
*
- * @param envelope The envelope to copy.
+ * @param envelope the envelope to copy.
*
* @see #castOrCopy(Envelope)
*/
@@ -206,7 +206,7 @@ public class GeneralEnvelope extends Arr
* {@linkplain org.apache.sis.referencing.CommonCRS#defaultGeographic() default geographic CRS}.
* Axis order is (<var>longitude</var>, <var>latitude</var>).
*
- * @param box The bounding box to copy.
+ * @param box the bounding box to copy.
*/
public GeneralEnvelope(final GeographicBoundingBox box) {
super(box);
@@ -247,8 +247,8 @@ public class GeneralEnvelope extends Arr
* <li>{@code GEOMETRYCOLLECTION(POINT(4 6),LINESTRING(3 8,7 10))}</li>
* </ul></div>
*
- * @param wkt The {@code BOX}, {@code POLYGON} or other kind of element to parse.
- * @throws IllegalArgumentException If the given string can not be parsed.
+ * @param wkt the {@code BOX}, {@code POLYGON} or other kind of element to parse.
+ * @throws IllegalArgumentException if the given string can not be parsed.
*
* @see Envelopes#fromWKT(CharSequence)
* @see Envelopes#toString(Envelope)
@@ -263,8 +263,8 @@ public class GeneralEnvelope extends Arr
* Otherwise the coordinate values and the CRS of the given envelope are
* {@linkplain #GeneralEnvelope(Envelope) copied} in a new {@code GeneralEnvelope}.
*
- * @param envelope The envelope to cast, or {@code null}.
- * @return The values of the given envelope as a {@code GeneralEnvelope} instance.
+ * @param envelope the envelope to cast, or {@code null}.
+ * @return the values of the given envelope as a {@code GeneralEnvelope} instance.
*
* @see AbstractEnvelope#castOrCopy(Envelope)
* @see ImmutableEnvelope#castOrCopy(Envelope)
@@ -284,7 +284,7 @@ public class GeneralEnvelope extends Arr
* <p>If the envelope coordinates need to be transformed to the new CRS, consider
* using {@link Envelopes#transform(Envelope, CoordinateReferenceSystem)} instead.</p>
*
- * @param crs The new coordinate reference system, or {@code null}.
+ * @param crs the new coordinate reference system, or {@code null}.
* @throws MismatchedDimensionException if the specified CRS doesn't have the expected number of dimensions.
* @throws IllegalStateException if a range of ordinate values in this envelope is compatible with the given CRS.
* See <cite>Envelope validation</cite> in class javadoc for more details.
@@ -319,11 +319,11 @@ public class GeneralEnvelope extends Arr
/**
* Sets the envelope range along the specified dimension.
*
- * @param dimension The dimension to set.
- * @param lower The limit in the direction of decreasing ordinate values.
- * @param upper The limit in the direction of increasing ordinate values.
- * @throws IndexOutOfBoundsException If the given index is out of bounds.
- * @throws IllegalArgumentException If {@code lower > upper} and the axis range meaning at the given dimension
+ * @param dimension the dimension to set.
+ * @param lower the limit in the direction of decreasing ordinate values.
+ * @param upper the limit in the direction of increasing ordinate values.
+ * @throws IndexOutOfBoundsException if the given index is out of bounds.
+ * @throws IllegalArgumentException if {@code lower > upper} and the axis range meaning at the given dimension
* is not "wraparound". See <cite>Envelope validation</cite> in class javadoc for more details.
*/
@Override // Must also be overridden in SubEnvelope
@@ -354,7 +354,7 @@ public class GeneralEnvelope extends Arr
* <var>x</var><sub>max</sub>, <var>y</var><sub>max</sub>, <var>z</var><sub>max</sub>)
* </div>
*
- * @param corners Ordinates of the new lower corner followed by the new upper corner.
+ * @param corners ordinates of the new lower corner followed by the new upper corner.
*/
public void setEnvelope(final double... corners) {
verifyArrayLength(ordinates.length >>> 1, corners);
@@ -366,8 +366,8 @@ public class GeneralEnvelope extends Arr
* Verifies that the given array of ordinate values has the expected length
* for the given number of dimensions.
*
- * @param dimension The dimension of the envelope.
- * @param corners The user-provided array of ordinate values.
+ * @param dimension the dimension of the envelope.
+ * @param corners the user-provided array of ordinate values.
*/
static void verifyArrayLength(final int dimension, final double[] corners) {
if ((corners.length & 1) != 0) {
@@ -386,7 +386,7 @@ public class GeneralEnvelope extends Arr
* If the given envelope has a non-null Coordinate Reference System (CRS), then
* the CRS of this envelope will be set to the CRS of the given envelope.
*
- * @param envelope The envelope to copy coordinates from.
+ * @param envelope the envelope to copy coordinates from.
* @throws MismatchedDimensionException if the specified envelope doesn't have
* the expected number of dimensions.
*/
@@ -447,8 +447,8 @@ public class GeneralEnvelope extends Arr
* (e.g. [-180 … +180]° of longitude). Callers can normalize the envelope when desired by call to
* the {@link #normalize()} method.</p>
*
- * @param vector The translation vector. The length of this array shall be equal to this envelope
- * {@linkplain #getDimension() dimension}.
+ * @param vector the translation vector. The length of this array shall be equal to this envelope
+ * {@linkplain #getDimension() dimension}.
*
* @since 0.5
*/
@@ -469,8 +469,8 @@ public class GeneralEnvelope extends Arr
* This method does not check for anti-meridian spanning. It is invoked only
* by the {@link Envelopes} transform methods, which build "normal" envelopes.
*
- * @param array The array which contains the ordinate values.
- * @param offset Index of the first valid ordinate value in the given array.
+ * @param array the array which contains the ordinate values.
+ * @param offset index of the first valid ordinate value in the given array.
*/
final void addSimple(final double[] array, final int offset) {
final int d = ordinates.length >>> 1;
@@ -505,9 +505,9 @@ public class GeneralEnvelope extends Arr
*
* The default implementation moves only the border which is closest to the given point.
*
- * @param position The point to add.
- * @throws MismatchedDimensionException If the given point does not have the expected number of dimensions.
- * @throws AssertionError If assertions are enabled and the envelopes have mismatched CRS.
+ * @param position the point to add.
+ * @throws MismatchedDimensionException if the given point does not have the expected number of dimensions.
+ * @throws AssertionError if assertions are enabled and the envelopes have mismatched CRS.
*/
public void add(final DirectPosition position) throws MismatchedDimensionException {
ensureNonNull("position", position);
@@ -547,10 +547,10 @@ public class GeneralEnvelope extends Arr
* ─────┘ └─────
* }
*
- * @param i The dimension of the ordinate
- * @param value The ordinate value to add to this envelope.
- * @param left The border on the left side, which is the <em>max</em> value (yes, this is confusing!)
- * @param right The border on the right side, which is the <em>min</em> value (yes, this is confusing!)
+ * @param i the dimension of the ordinate
+ * @param value the ordinate value to add to this envelope.
+ * @param left the border on the left side, which is the <em>max</em> value (yes, this is confusing!)
+ * @param right the border on the right side, which is the <em>min</em> value (yes, this is confusing!)
*/
private void addToClosest(int i, final double value, double left, double right) {
left = value - left;
@@ -579,9 +579,9 @@ public class GeneralEnvelope extends Arr
* to infinities. In such case, the ordinate range will be either [−∞…∞] or [0…−0] depending on
* whatever the original range span the anti-meridian or not.
*
- * @param envelope the {@code Envelope} to add to this envelope.
- * @throws MismatchedDimensionException If the given envelope does not have the expected number of dimensions.
- * @throws AssertionError If assertions are enabled and the envelopes have mismatched CRS.
+ * @param envelope the {@code Envelope} to add to this envelope.
+ * @throws MismatchedDimensionException if the given envelope does not have the expected number of dimensions.
+ * @throws AssertionError if assertions are enabled and the envelopes have mismatched CRS.
*
* @see org.apache.sis.metadata.iso.extent.DefaultGeographicBoundingBox#add(GeographicBoundingBox)
*/
@@ -704,9 +704,9 @@ public class GeneralEnvelope extends Arr
* <div class="section">Spanning the anti-meridian of a Geographic CRS</div>
* This method supports envelopes spanning the anti-meridian.
*
- * @param envelope the {@code Envelope} to intersect to this envelope.
- * @throws MismatchedDimensionException If the given envelope does not have the expected number of dimensions.
- * @throws AssertionError If assertions are enabled and the envelopes have mismatched CRS.
+ * @param envelope the {@code Envelope} to intersect to this envelope.
+ * @throws MismatchedDimensionException if the given envelope does not have the expected number of dimensions.
+ * @throws AssertionError if assertions are enabled and the envelopes have mismatched CRS.
*
* @see org.apache.sis.metadata.iso.extent.DefaultGeographicBoundingBox#intersect(GeographicBoundingBox)
*/
@@ -797,9 +797,10 @@ public class GeneralEnvelope extends Arr
case 2: if (min1 > min0) ordinates[iLower] = min1; break;
case 3: // Fall through
case 0: {
- // Before to declare the intersection as invalid, verify if the envelope
- // actually span the whole Earth. In such case, the intersection is a no-
- // operation (or a copy operation).
+ /*
+ * Before to declare the intersection as invalid, verify if the envelope actually spans
+ * the whole Earth. In such case, the intersection is a no-operation (or a copy operation).
+ */
final double min, max;
final double csSpan = getSpan(getAxis(crs, i));
if (span1 >= csSpan) {
@@ -956,7 +957,7 @@ public class GeneralEnvelope extends Arr
*
* @return {@code true} if this envelope has been modified as a result of this method call,
* or {@code false} if no change has been done.
- * @throws IllegalStateException If a upper ordinate value is less than a lower ordinate
+ * @throws IllegalStateException if a upper ordinate value is less than a lower ordinate
* value on an axis which does not have the {@code WRAPAROUND} range meaning.
*
* @see #toSimpleEnvelopes()
@@ -1008,10 +1009,10 @@ public class GeneralEnvelope extends Arr
* This method does not compute a sub-CRS because it may not be needed, or the sub-CRS may be already
* known by the caller.
*
- * @param beginIndex The index of the first valid ordinate value of the corners.
- * @param endIndex The index after the last valid ordinate value of the corners.
- * @return The sub-envelope of dimension {@code endIndex - beginIndex}.
- * @throws IndexOutOfBoundsException If an index is out of bounds.
+ * @param beginIndex the index of the first valid ordinate value of the corners.
+ * @param endIndex the index after the last valid ordinate value of the corners.
+ * @return the sub-envelope of dimension {@code endIndex - beginIndex}.
+ * @throws IndexOutOfBoundsException if an index is out of bounds.
*
* @see org.apache.sis.referencing.CRS#getComponentAt(CoordinateReferenceSystem, int, int)
*/
@@ -1019,14 +1020,16 @@ public class GeneralEnvelope extends Arr
public GeneralEnvelope subEnvelope(final int beginIndex, final int endIndex) throws IndexOutOfBoundsException {
ensureValidIndexRange(ordinates.length >>> 1, beginIndex, endIndex);
return new SubEnvelope(ordinates, beginIndex, endIndex);
- // Do check if we could return "this" as an optimization, in order to keep the
- // method contract simpler (i.e. the returned envelope CRS is always null).
+ /*
+ * Do not check if we could return "this" as an optimization, in order to keep
+ * the method contract simpler (i.e. the returned envelope CRS is always null).
+ */
}
/**
* Returns a deep copy of this envelope.
*
- * @return A clone of this envelope.
+ * @return a clone of this envelope.
*/
@Override
public GeneralEnvelope clone() {
@@ -1039,8 +1042,10 @@ public class GeneralEnvelope extends Arr
field.set(e, ordinates.clone());
return e;
} catch (CloneNotSupportedException | ReflectiveOperationException exception) {
- // Should not happen, since we are cloneable, the
- // field is known to exist and we made it accessible.
+ /*
+ * Should not happen, since we are cloneable, the
+ * field is known to exist and we made it accessible.
+ */
throw new AssertionError(exception);
}
}
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/ImmutableEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/ImmutableEnvelope.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/ImmutableEnvelope.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/ImmutableEnvelope.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -57,10 +57,10 @@ public final class ImmutableEnvelope ext
* Constructs an envelope defined by two corners given as direct positions.
* The envelope CRS will be the CRS of the given positions.
*
- * @param lowerCorner The limits in the direction of decreasing ordinate values for each dimension.
- * @param upperCorner The limits in the direction of increasing ordinate values for each dimension.
- * @throws MismatchedDimensionException If the two positions do not have the same dimension.
- * @throws MismatchedReferenceSystemException If the CRS of the two position are not equal.
+ * @param lowerCorner the limits in the direction of decreasing ordinate values for each dimension.
+ * @param upperCorner the limits in the direction of increasing ordinate values for each dimension.
+ * @throws MismatchedDimensionException if the two positions do not have the same dimension.
+ * @throws MismatchedReferenceSystemException if the CRS of the two position are not equal.
*/
public ImmutableEnvelope(final DirectPosition lowerCorner, final DirectPosition upperCorner)
throws MismatchedDimensionException, MismatchedReferenceSystemException
@@ -71,10 +71,10 @@ public final class ImmutableEnvelope ext
/**
* Constructs an envelope defined by two corners given as sequences of ordinate values.
*
- * @param lowerCorner The limits in the direction of decreasing ordinate values for each dimension.
- * @param upperCorner The limits in the direction of increasing ordinate values for each dimension.
- * @param crs The CRS to assign to this envelope, or {@code null}.
- * @throws MismatchedDimensionException If the two sequences do not have the same length, or
+ * @param lowerCorner the limits in the direction of decreasing ordinate values for each dimension.
+ * @param upperCorner the limits in the direction of increasing ordinate values for each dimension.
+ * @param crs the CRS to assign to this envelope, or {@code null}.
+ * @throws MismatchedDimensionException if the two sequences do not have the same length, or
* if the dimension of the given CRS is not equals to the dimension of the given corners.
*/
public ImmutableEnvelope(final double[] lowerCorner, final double[] upperCorner,
@@ -91,7 +91,7 @@ public final class ImmutableEnvelope ext
* {@linkplain org.apache.sis.referencing.CommonCRS#defaultGeographic() default geographic CRS}.
* Axis order is (<var>longitude</var>, <var>latitude</var>).
*
- * @param box The bounding box to copy.
+ * @param box the bounding box to copy.
*/
public ImmutableEnvelope(final GeographicBoundingBox box) {
super(box);
@@ -103,7 +103,7 @@ public final class ImmutableEnvelope ext
* be an instance of {@code ImmutableEnvelope}. In case of doubt,
* consider using {@link #castOrCopy(Envelope)} instead.
*
- * @param envelope The envelope to copy.
+ * @param envelope the envelope to copy.
*
* @see #castOrCopy(Envelope)
*/
@@ -120,9 +120,9 @@ public final class ImmutableEnvelope ext
* <p>The main purpose of this method is to assign a non-null CRS when the envelope to
* copy has a null CRS.</p>
*
- * @param crs The CRS to assign to this envelope, or {@code null}.
- * @param envelope The envelope from which to copy ordinate values.
- * @throws MismatchedDimensionException If the dimension of the given CRS is not equals
+ * @param crs the CRS to assign to this envelope, or {@code null}.
+ * @param envelope the envelope from which to copy ordinate values.
+ * @throws MismatchedDimensionException if the dimension of the given CRS is not equals
* to the dimension of the given envelope.
*/
public ImmutableEnvelope(final CoordinateReferenceSystem crs, final Envelope envelope)
@@ -146,10 +146,10 @@ public final class ImmutableEnvelope ext
* See the javadoc of the {@link GeneralEnvelope#GeneralEnvelope(CharSequence) GeneralEnvelope}
* constructor for more information.
*
- * @param crs The coordinate reference system, or {@code null} if none.
- * @param wkt The {@code BOX}, {@code POLYGON} or other kind of element to parse.
- * @throws IllegalArgumentException If the given string can not be parsed.
- * @throws MismatchedDimensionException If the dimension of the given CRS is not equals
+ * @param crs the coordinate reference system, or {@code null} if none.
+ * @param wkt the {@code BOX}, {@code POLYGON} or other kind of element to parse.
+ * @throws IllegalArgumentException if the given string can not be parsed.
+ * @throws MismatchedDimensionException if the dimension of the given CRS is not equals
* to the dimension of the parsed envelope.
*/
public ImmutableEnvelope(final CoordinateReferenceSystem crs, final CharSequence wkt)
@@ -166,8 +166,8 @@ public final class ImmutableEnvelope ext
* Otherwise the coordinate values and the CRS of the given envelope are copied in a
* new envelope.
*
- * @param envelope The envelope to cast, or {@code null}.
- * @return The values of the given envelope as an {@code ImmutableEnvelope} instance.
+ * @param envelope the envelope to cast, or {@code null}.
+ * @return the values of the given envelope as an {@code ImmutableEnvelope} instance.
*
* @see AbstractEnvelope#castOrCopy(Envelope)
* @see GeneralEnvelope#castOrCopy(Envelope)
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Shapes2D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Shapes2D.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Shapes2D.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/Shapes2D.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -62,8 +62,8 @@ public final class Shapes2D extends Stat
* if the intersection does not occur between the ending points {@linkplain Line2D#getP1() P1} and
* {@linkplain Line2D#getP2() P2} of the two line segments, then this method returns {@code null}.
*
- * @param a the first line segment.
- * @param b the second line segment.
+ * @param a the first line segment.
+ * @param b the second line segment.
* @return the intersection point, or {@code null} if none.
*/
public static Point2D intersectionPoint(final Line2D a, final Line2D b) {
@@ -130,9 +130,9 @@ public final class Shapes2D extends Stat
/**
* Returns a circle passing by the 3 given points.
*
- * @param P1 the first point.
- * @param P2 the second point.
- * @param P3 the third point.
+ * @param P1 the first point.
+ * @param P2 the second point.
+ * @param P3 the third point.
* @return a circle passing by the given points.
*/
public static Ellipse2D circle(final Point2D P1, final Point2D P2, final Point2D P3) {
@@ -155,9 +155,9 @@ public final class Shapes2D extends Stat
* For a more robust rectangle transformation, use {@link #transform(CoordinateOperation, Rectangle2D, Rectangle2D)}
* instead.</p>
*
- * @param transform the transform to use. Source and target dimension must be 2.
- * @param envelope the rectangle to transform (may be {@code null}).
- * @param destination the destination rectangle (may be {@code envelope}).
+ * @param transform the transform to use. Source and target dimension must be 2.
+ * @param envelope the rectangle to transform (may be {@code null}).
+ * @param destination the destination rectangle (may be {@code envelope}).
* If {@code null}, a new rectangle will be created and returned.
* @return {@code destination}, or a new rectangle if {@code destination} was non-null and {@code envelope} was null.
* @throws TransformException if a transform failed.
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/SubEnvelope.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/SubEnvelope.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/SubEnvelope.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/geometry/SubEnvelope.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -62,9 +62,9 @@ final class SubEnvelope extends GeneralE
* reference directly; it does <strong>not</strong> clone the given array. This is the desired
* behavior for allowing the {@code SubEnvelope} view to be "live".
*
- * @param ordinates The array of ordinate values to store directly (not cloned).
- * @param beginIndex The index of the first valid ordinate value of the lower corner in the ordinates array.
- * @param endIndex The index after the last valid ordinate value of the lower corner in the ordinates array.
+ * @param ordinates the array of ordinate values to store directly (not cloned).
+ * @param beginIndex the index of the first valid ordinate value of the lower corner in the ordinates array.
+ * @param endIndex the index after the last valid ordinate value of the lower corner in the ordinates array.
*/
SubEnvelope(final double[] ordinates, final int beginIndex, final int endIndex) {
super(ordinates);
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_Conversion.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_Conversion.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_Conversion.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_Conversion.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -72,8 +72,8 @@ public final class CC_Conversion extends
* Invoked by {@link PropertyType} at marshalling time for wrapping the given value
* in a {@code <gml:Conversion>} XML element.
*
- * @param conversion The element to marshall.
- * @return A {@code PropertyType} wrapping the given the element.
+ * @param conversion the element to marshall.
+ * @return a {@code PropertyType} wrapping the given the element.
*/
@Override
protected CC_Conversion wrap(final Conversion conversion) {
@@ -85,7 +85,7 @@ public final class CC_Conversion extends
* inside the {@code <gml:Conversion>} XML element.
* This is the value or a copy of the value given in argument to the {@code wrap} method.
*
- * @return The element to be marshalled.
+ * @return the element to be marshalled.
*/
@XmlElement(name = "Conversion")
public DefaultConversion getElement() {
@@ -95,7 +95,7 @@ public final class CC_Conversion extends
/**
* Invoked by JAXB at unmarshalling time for storing the result temporarily.
*
- * @param conversion The unmarshalled element.
+ * @param conversion the unmarshalled element.
*/
public void setElement(final DefaultConversion conversion) {
metadata = conversion;
@@ -111,9 +111,9 @@ public final class CC_Conversion extends
*
* See {@code AbstractDerivedCRS.afterUnmarshal(Unmarshaller, Object parent)} for more information.
*
- * @param conversion The conversion to which to associate a base CRS.
- * @param crs The base CRS to associate to the given conversion.
- * @return The previous base CRS, or {@code null} if none.
+ * @param conversion the conversion to which to associate a base CRS.
+ * @param crs the base CRS to associate to the given conversion.
+ * @return the previous base CRS, or {@code null} if none.
*/
public static SingleCRS setBaseCRS(final Conversion conversion, final SingleCRS crs) {
/*
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_CoordinateOperation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_CoordinateOperation.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_CoordinateOperation.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_CoordinateOperation.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -63,8 +63,8 @@ public final class CC_CoordinateOperatio
* Invoked by {@link PropertyType} at marshalling time for wrapping the given value
* in a {@code <gml:CoordinateOperation>} XML element.
*
- * @param conversion The element to marshall.
- * @return A {@code PropertyType} wrapping the given the element.
+ * @param conversion the element to marshall.
+ * @return a {@code PropertyType} wrapping the given the element.
*/
@Override
protected CC_CoordinateOperation wrap(final CoordinateOperation conversion) {
@@ -76,7 +76,7 @@ public final class CC_CoordinateOperatio
* inside the {@code <gml:CoordinateOperation>} XML element.
* This is the value or a copy of the value given in argument to the {@code wrap} method.
*
- * @return The element to be marshalled.
+ * @return the element to be marshalled.
*/
@XmlElementRef
public AbstractCoordinateOperation getElement() {
@@ -86,7 +86,7 @@ public final class CC_CoordinateOperatio
/**
* Invoked by JAXB at unmarshalling time for storing the result temporarily.
*
- * @param operation The unmarshalled element.
+ * @param operation the unmarshalled element.
*/
public void setElement(final AbstractCoordinateOperation operation) {
metadata = operation;
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_GeneralOperationParameter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_GeneralOperationParameter.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_GeneralOperationParameter.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_GeneralOperationParameter.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -117,8 +117,8 @@ public final class CC_GeneralOperationPa
* Invoked by {@link PropertyType} at marshalling time for wrapping the given value in a
* {@code <gml:OperationParameter>} or {@code <gml:OperationParameterGroup>} XML element.
*
- * @param parameter The element to marshall.
- * @return A {@code PropertyType} wrapping the given the element.
+ * @param parameter the element to marshall.
+ * @return a {@code PropertyType} wrapping the given the element.
*/
@Override
protected CC_GeneralOperationParameter wrap(final GeneralParameterDescriptor parameter) {
@@ -130,7 +130,7 @@ public final class CC_GeneralOperationPa
* inside the {@code <gml:parameter>} XML element.
* This is the value or a copy of the value given in argument to the {@code wrap} method.
*
- * @return The element to be marshalled.
+ * @return the element to be marshalled.
*
* @see CC_GeneralParameterValue#getElement()
*/
@@ -152,7 +152,7 @@ public final class CC_GeneralOperationPa
/**
* Invoked by JAXB at unmarshalling time for storing the result temporarily.
*
- * @param parameter The unmarshalled element.
+ * @param parameter the unmarshalled element.
*/
public void setElement(final AbstractParameterDescriptor parameter) {
metadata = parameter;
@@ -205,9 +205,9 @@ public final class CC_GeneralOperationPa
* <li>A pre-defined parameter descriptor from the {@link org.apache.sis.internal.referencing.provider} package.</li>
* </ul>
*
- * @param provided The descriptor unmarshalled from the GML document.
- * @param complete The descriptor to use for completing missing information.
- * @return The descriptor to use. May be one of the arguments given to this method, or a new instance.
+ * @param provided the descriptor unmarshalled from the GML document.
+ * @param complete the descriptor to use for completing missing information.
+ * @return the descriptor to use. May be one of the arguments given to this method, or a new instance.
*
* @see <a href="http://issues.apache.org/jira/browse/SIS-290">SIS-290</a>
*/
@@ -276,15 +276,15 @@ public final class CC_GeneralOperationPa
* Returns a descriptor with the given properties, completed with information not found in GML.
* Those extra information are given by the {@code complete} descriptor.
*
- * @param caller The public source class to report if a log message need to be emitted.
- * @param properties Properties as declared in the GML document, to be used if {@code complete} is incompatible.
- * @param merged More complete properties, to be used if {@code complete} is compatible.
- * @param minimumOccurs Value to assign to {@link DefaultParameterDescriptorGroup#getMinimumOccurs()}.
- * @param maximumOccurs Value to assign to {@link DefaultParameterDescriptorGroup#getMaximumOccurs()}.
- * @param provided Parameter descriptors declared in the GML document. This array will be overwritten.
- * @param complete More complete parameter descriptors.
- * @param canSubstitute {@code true} if this method is allowed to return {@code complete}.
- * @return The parameter descriptor group to use (may be the {@code complete} instance).
+ * @param caller the public source class to report if a log message need to be emitted.
+ * @param properties properties as declared in the GML document, to be used if {@code complete} is incompatible.
+ * @param merged more complete properties, to be used if {@code complete} is compatible.
+ * @param minimumOccurs value to assign to {@link DefaultParameterDescriptorGroup#getMinimumOccurs()}.
+ * @param maximumOccurs value to assign to {@link DefaultParameterDescriptorGroup#getMaximumOccurs()}.
+ * @param provided parameter descriptors declared in the GML document. This array will be overwritten.
+ * @param complete more complete parameter descriptors.
+ * @param canSubstitute {@code true} if this method is allowed to return {@code complete}.
+ * @return the parameter descriptor group to use (may be the {@code complete} instance).
*
* @see <a href="http://issues.apache.org/jira/browse/SIS-290">SIS-290</a>
*/
@@ -385,9 +385,9 @@ public final class CC_GeneralOperationPa
* collection, where each element have been converted to the canonical {@link NamedIdentifier} implementation
* for comparison purpose.
*
- * @param <T> The type of elements in the collection.
- * @param complete The collection which is expected to contains all elements.
- * @param provided The collection which may be a subset of {@code complete}.
+ * @param <T> the type of elements in the collection.
+ * @param complete the collection which is expected to contains all elements.
+ * @param provided the collection which may be a subset of {@code complete}.
* @return {@code true} if {@code complete} contains all {@code provided} elements.
*/
private static <T> boolean containsAll(final Collection<T> complete, final Collection<T> provided) {
@@ -413,11 +413,11 @@ public final class CC_GeneralOperationPa
* Merges the property of type {@code Collection} identified by the given key.
* This is used when we can not just substitute one collection by the other.
*
- * @param <T> The type of elements in the array or collection.
- * @param key The key where to fetch or store the array in the {@code merged} map.
- * @param componentType The type of elements in the array or collection.
- * @param provided The elements unmarshalled from the XML document.
- * @param merged The map used for completing missing information.
+ * @param <T> the type of elements in the array or collection.
+ * @param key the key where to fetch or store the array in the {@code merged} map.
+ * @param componentType the type of elements in the array or collection.
+ * @param provided the elements unmarshalled from the XML document.
+ * @param merged the map used for completing missing information.
*/
@SuppressWarnings("unchecked")
private static <T> void mergeArrays(final String key, final Class<T> componentType,
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_GeneralParameterValue.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_GeneralParameterValue.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_GeneralParameterValue.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_GeneralParameterValue.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -66,8 +66,8 @@ public final class CC_GeneralParameterVa
* Invoked by {@link PropertyType} at marshalling time for wrapping the given value
* in a {@code <gml:ParameterValue>} or {@code <gml:ParameterValueGroup>} XML element.
*
- * @param parameter The element to marshall.
- * @return A {@code PropertyType} wrapping the given the element.
+ * @param parameter the element to marshall.
+ * @return a {@code PropertyType} wrapping the given the element.
*/
@Override
protected CC_GeneralParameterValue wrap(final GeneralParameterValue parameter) {
@@ -79,7 +79,7 @@ public final class CC_GeneralParameterVa
* inside the {@code <gml:parameterValue>} XML element.
* This is the value or a copy of the value given in argument to the {@code wrap} method.
*
- * @return The element to be marshalled.
+ * @return the element to be marshalled.
*
* @see CC_GeneralOperationParameter#getElement()
*/
@@ -107,7 +107,7 @@ public final class CC_GeneralParameterVa
/**
* Invoked by JAXB at unmarshalling time for storing the result temporarily.
*
- * @param parameter The unmarshalled element.
+ * @param parameter the unmarshalled element.
*/
public void setElement(final GeneralParameterValue parameter) {
if (!CC_GeneralOperationParameter.isValid(parameter.getDescriptor())) {
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationMethod.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationMethod.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationMethod.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationMethod.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -83,7 +83,7 @@ public final class CC_OperationMethod ex
* in a {@code <gml:OperationMethod>} XML element.
*
* @param method The element to marshall.
- * @return A {@code PropertyType} wrapping the given the element.
+ * @return a {@code PropertyType} wrapping the given the element.
*/
@Override
protected CC_OperationMethod wrap(final OperationMethod method) {
@@ -95,7 +95,7 @@ public final class CC_OperationMethod ex
* inside the {@code <gml:OperationMethod>} XML element.
* This is the value or a copy of the value given in argument to the {@code wrap} method.
*
- * @return The element to be marshalled.
+ * @return the element to be marshalled.
*/
@XmlElement(name = "OperationMethod")
public DefaultOperationMethod getElement() {
@@ -105,7 +105,7 @@ public final class CC_OperationMethod ex
/**
* Invoked by JAXB at unmarshalling time for storing the result temporarily.
*
- * @param method The unmarshalled element.
+ * @param method the unmarshalled element.
*/
public void setElement(final DefaultOperationMethod method) {
if (!CC_GeneralOperationParameter.isValid(method.getParameters())) {
@@ -121,8 +121,8 @@ public final class CC_OperationMethod ex
/**
* Returns the given descriptors, excluding the implicit {@link MapProjection} parameters.
*
- * @param array The parameters to filter.
- * @return The filtered parameters.
+ * @param array the parameters to filter.
+ * @return the filtered parameters.
*/
public static GeneralParameterValue[] filterImplicit(final GeneralParameterValue[] array) {
int n = 0;
@@ -137,8 +137,8 @@ public final class CC_OperationMethod ex
/**
* Returns the given descriptors, excluding the implicit {@link MapProjection} parameters.
*
- * @param array The parameters to filter.
- * @return The filtered parameters.
+ * @param array the parameters to filter.
+ * @return the filtered parameters.
*/
public static GeneralParameterDescriptor[] filterImplicit(final GeneralParameterDescriptor[] array) {
int n = 0;
@@ -153,7 +153,7 @@ public final class CC_OperationMethod ex
/**
* Returns {@code true} if the given descriptor is for an implicit parameter which should be excluded from GML.
*
- * @param descriptor The parameter descriptor to test.
+ * @param descriptor the parameter descriptor to test.
* @return {@code true} if the given parameter should be omitted in the GML document.
*/
static boolean isImplicitParameter(final GeneralParameterDescriptor descriptor) {
@@ -174,9 +174,9 @@ public final class CC_OperationMethod ex
* {@link DefaultOperationMethod} class in the hope to reduce the amount of code processed
* by the JVM in the common case where JAXB (un)marshalling is not needed.</div>
*
- * @param name The operation method name, to be also given to the descriptor group.
- * @param descriptors The parameter descriptors to wrap in a group. This array will be modified in-place.
- * @return A parameter group containing at least the given descriptors, or equivalent descriptors.
+ * @param name the operation method name, to be also given to the descriptor group.
+ * @param descriptors the parameter descriptors to wrap in a group. This array will be modified in-place.
+ * @return a parameter group containing at least the given descriptors, or equivalent descriptors.
*/
public static ParameterDescriptorGroup group(final Identifier name, final GeneralParameterDescriptor[] descriptors) {
OperationMethod method;
@@ -212,9 +212,9 @@ public final class CC_OperationMethod ex
* {@link DefaultOperationMethod} class in the hope to reduce the amount of code processed
* by the JVM in the common case where JAXB (un)marshalling is not needed.</div>
*
- * @param parameters The parameters to add to the {@code addTo} collection.
- * @param addTo Where to store the {@code parameters}.
- * @param replacements The replacements to apply in the {@code GeneralParameterValue} instances.
+ * @param parameters the parameters to add to the {@code addTo} collection.
+ * @param addTo where to store the {@code parameters}.
+ * @param replacements the replacements to apply in the {@code GeneralParameterValue} instances.
*/
public static void store(final GeneralParameterValue[] parameters,
final Collection<GeneralParameterValue> addTo,
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationParameter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationParameter.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationParameter.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationParameter.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -89,8 +89,8 @@ public final class CC_OperationParameter
* Invoked by {@link PropertyType} at marshalling time for wrapping the given value
* in a {@code <gml:OperationParameter>} XML element.
*
- * @param parameter The element to marshall.
- * @return A {@code PropertyType} wrapping the given the element.
+ * @param parameter the element to marshall.
+ * @return a {@code PropertyType} wrapping the given the element.
*/
@Override
protected CC_OperationParameter wrap(final ParameterDescriptor<?> parameter) {
@@ -102,7 +102,7 @@ public final class CC_OperationParameter
* inside the {@code <gml:OperationParameter>} XML element.
* This is the value or a copy of the value given in argument to the {@code wrap} method.
*
- * @return The element to be marshalled.
+ * @return the element to be marshalled.
*/
@XmlElement(name = "OperationParameter")
public DefaultParameterDescriptor<?> getElement() {
@@ -112,7 +112,7 @@ public final class CC_OperationParameter
/**
* Invoked by JAXB at unmarshalling time for storing the result temporarily.
*
- * @param parameter The unmarshalled element.
+ * @param parameter the unmarshalled element.
*/
public void setElement(final DefaultParameterDescriptor<?> parameter) {
metadata = parameter;
@@ -124,8 +124,8 @@ public final class CC_OperationParameter
* the unit of measurement of the parameter descriptor to create. Those information will
* be used by the {@link DefaultParameterDescriptor} private constructor.
*
- * @param unmarshaller The unmarshaller.
- * @param parent The enclosing {@link ParameterValue} instance being unmarshalled.
+ * @param unmarshaller the unmarshaller.
+ * @param parent the enclosing {@link ParameterValue} instance being unmarshalled.
*/
private void beforeUnmarshal(final Unmarshaller unmarshaller, final Object parent) {
if (parent instanceof ParameterValue<?>) {
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationParameterGroup.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationParameterGroup.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationParameterGroup.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationParameterGroup.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -69,8 +69,8 @@ public final class CC_OperationParameter
* Invoked by {@link PropertyType} at marshalling time for wrapping the given value
* in a {@code <gml:OperationParameterGroup>} XML element.
*
- * @param parameter The element to marshall.
- * @return A {@code PropertyType} wrapping the given the element.
+ * @param parameter the element to marshall.
+ * @return a {@code PropertyType} wrapping the given the element.
*/
@Override
protected CC_OperationParameterGroup wrap(final ParameterDescriptorGroup parameter) {
@@ -82,7 +82,7 @@ public final class CC_OperationParameter
* inside the {@code <gml:OperationParameter>} XML element.
* This is the value or a copy of the value given in argument to the {@code wrap} method.
*
- * @return The element to be marshalled.
+ * @return the element to be marshalled.
*/
@XmlElement(name = "OperationParameterGroup")
public DefaultParameterDescriptorGroup getElement() {
@@ -92,7 +92,7 @@ public final class CC_OperationParameter
/**
* Invoked by JAXB at unmarshalling time for storing the result temporarily.
*
- * @param parameter The unmarshalled element.
+ * @param parameter the unmarshalled element.
*/
public void setElement(final DefaultParameterDescriptorGroup parameter) {
metadata = parameter;
@@ -127,12 +127,12 @@ public final class CC_OperationParameter
* {@link DefaultParameterDescriptorGroup} class in the hope to reduce the amount of code
* processed by the JVM in the common case where JAXB (un)marshalling is not needed.</div>
*
- * @param descriptors The descriptors declared in the {@code ParameterDescriptorGroup}.
- * @param fromValues The descriptors declared in the {@code ParameterValue} instances.
- * They are said "valid" because they contain the mandatory {@code valueClass} property.
- * @param replacements An {@code IdentityHashMap} where to store the replacements that the caller needs
- * to apply in the {@code GeneralParameterValue} instances.
- * @return A sequence containing the merged set of parameter descriptors.
+ * @param descriptors the descriptors declared in the {@code ParameterDescriptorGroup}.
+ * @param fromValues the descriptors declared in the {@code ParameterValue} instances.
+ * They are said "valid" because they contain the mandatory {@code valueClass} property.
+ * @param replacements an {@code IdentityHashMap} where to store the replacements that the caller needs to
+ * apply in the {@code GeneralParameterValue} instances.
+ * @return a sequence containing the merged set of parameter descriptors.
*
* @see <a href="http://issues.apache.org/jira/browse/SIS-290">SIS-290</a>
*/
Modified: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CD_Ellipsoid.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CD_Ellipsoid.java?rev=1779706&r1=1779705&r2=1779706&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CD_Ellipsoid.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CD_Ellipsoid.java [UTF-8] Sat Jan 21 09:00:40 2017
@@ -62,8 +62,8 @@ public final class CD_Ellipsoid extends
* Invoked by {@link PropertyType} at marshalling time for wrapping the given value
* in a {@code <gml:Ellipsoid>} XML element.
*
- * @param ellipsoid The element to marshall.
- * @return A {@code PropertyType} wrapping the given the element.
+ * @param ellipsoid the element to marshall.
+ * @return a {@code PropertyType} wrapping the given the element.
*/
@Override
protected CD_Ellipsoid wrap(final Ellipsoid ellipsoid) {
@@ -75,7 +75,7 @@ public final class CD_Ellipsoid extends
* inside the {@code <gml:Ellipsoid>} XML element.
* This is the value or a copy of the value given in argument to the {@code wrap} method.
*
- * @return The element to be marshalled.
+ * @return the element to be marshalled.
*/
@XmlElement(name = "Ellipsoid")
public DefaultEllipsoid getElement() {
@@ -85,7 +85,7 @@ public final class CD_Ellipsoid extends
/**
* Invoked by JAXB at unmarshalling time for storing the result temporarily.
*
- * @param ellipsoid The unmarshalled element.
+ * @param ellipsoid the unmarshalled element.
*/
public void setElement(final DefaultEllipsoid ellipsoid) {
metadata = ellipsoid;
|