sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1600786 - in /sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis: internal/referencing/ referencing/operation/transform/
Date Thu, 05 Jun 2014 22:47:21 GMT
Author: desruisseaux
Date: Thu Jun  5 22:47:21 2014
New Revision: 1600786

URL: http://svn.apache.org/r1600786
Log:
Minor javadoc formatting fixes.

Modified:
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/DirectPositionView.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform1D.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform2D.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/LinearTransform.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/PassThroughTransform.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/package-info.java

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/DirectPositionView.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/DirectPositionView.java?rev=1600786&r1=1600785&r2=1600786&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/DirectPositionView.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/DirectPositionView.java
[UTF-8] Thu Jun  5 22:47:21 2014
@@ -18,9 +18,11 @@ package org.apache.sis.internal.referenc
 
 import java.util.Arrays;
 import org.opengis.geometry.DirectPosition;
-import org.opengis.geometry.UnmodifiableGeometryException;
 import org.opengis.referencing.crs.CoordinateReferenceSystem;
 
+// Branch-dependent imports
+import org.opengis.geometry.UnmodifiableGeometryException;
+
 
 /**
  * A read-only direct position wrapping an array without performing any copy.

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform1D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform1D.java?rev=1600786&r1=1600785&r2=1600786&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform1D.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform1D.java
[UTF-8] Thu Jun  5 22:47:21 2014
@@ -39,6 +39,18 @@ import static org.apache.sis.util.Argume
  *   <li>{@link #derivative(double)}</li>
  * </ul>
  *
+ * {@section Immutability and thread safety}
+ * All Apache SIS implementations of {@code MathTransform1D} are immutable and thread-safe.
+ * It is highly recommended that third-party implementations be immutable and thread-safe
too.
+ * This means that unless otherwise noted in the javadoc, {@code MathTransform1D} instances
can
+ * be shared by many objects and passed between threads without synchronization.
+ *
+ * {@section Serialization}
+ * {@code MathTransform1D} may or may not be serializable, at implementation choices.
+ * Most Apache SIS implementations are serializable, but the serialized objects are not guaranteed
to be compatible
+ * with future SIS versions. Serialization should be used only for short term storage or
RMI between applications
+ * running the same SIS version.
+ *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.5 (derived from geotk-3.17)
  * @version 0.5

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform2D.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform2D.java?rev=1600786&r1=1600785&r2=1600786&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform2D.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform2D.java
[UTF-8] Thu Jun  5 22:47:21 2014
@@ -47,6 +47,18 @@ import org.apache.sis.util.resources.Err
  *
  * However more performance may be gained by overriding the other {@code transform} methods
as well.
  *
+ * {@section Immutability and thread safety}
+ * All Apache SIS implementations of {@code MathTransform2D} are immutable and thread-safe.
+ * It is highly recommended that third-party implementations be immutable and thread-safe
too.
+ * This means that unless otherwise noted in the javadoc, {@code MathTransform2D} instances
can
+ * be shared by many objects and passed between threads without synchronization.
+ *
+ * {@section Serialization}
+ * {@code MathTransform2D} may or may not be serializable, at implementation choices.
+ * Most Apache SIS implementations are serializable, but the serialized objects are not guaranteed
to be compatible
+ * with future SIS versions. Serialization should be used only for short term storage or
RMI between applications
+ * running the same SIS version.
+ *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.5 (derived from geotk-2.0)
  * @version 0.5

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/LinearTransform.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/LinearTransform.java?rev=1600786&r1=1600785&r2=1600786&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/LinearTransform.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/LinearTransform.java
[UTF-8] Thu Jun  5 22:47:21 2014
@@ -54,7 +54,7 @@ import org.opengis.referencing.operation
  * <p>For example a square matrix of size 4×4 is used for transforming three-dimensional
coordinates.
  * The transformed points {@code (x',y',z')} are computed as below:</p>
  *
- * <blockquote>{@include formulas.html#ProjectiveTransform}</blockquote>
+ * <center><p>{@include formulas.html#ProjectiveTransform}</p></center>
  *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @since   0.4 (derived from geotk-2.0)
@@ -68,6 +68,7 @@ public interface LinearTransform extends
      * Returns the coefficients of this linear transform as a matrix.
      * Converting a coordinate with this {@code MathTransform} is equivalent to multiplying
the
      * returned matrix by a vector containing the ordinate values with an additional 1 in
the last row.
+     * See {@link LinearTransform} class Javadoc for more details.
      *
      * @return The coefficients of this linear transform as a matrix.
      *

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/PassThroughTransform.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/PassThroughTransform.java?rev=1600786&r1=1600785&r2=1600786&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/PassThroughTransform.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/PassThroughTransform.java
[UTF-8] Thu Jun  5 22:47:21 2014
@@ -38,9 +38,9 @@ import static org.apache.sis.util.Argume
  * Transform which passes through a subset of ordinates to another transform.
  * This allows transforms to operate on a subset of ordinates.
  *
- * <span class="note"><b>Example:</b> giving (<var>latitude</var>,
<var>longitude</var>, <var>height</var>) coordinates,
+ * <div class="note"><b>Example:</b> giving (<var>latitude</var>,
<var>longitude</var>, <var>height</var>) coordinates,
  * {@code PassThroughTransform} can convert the height values from feet to meters without
affecting the latitude and
- * longitude values.</span>
+ * longitude values.</div>
  *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @since   0.5 (derived from geotk-1.2)

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/package-info.java?rev=1600786&r1=1600785&r2=1600786&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/package-info.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/package-info.java
[UTF-8] Thu Jun  5 22:47:21 2014
@@ -16,9 +16,9 @@
  */
 
 /**
- * {@code MathTransform} implementations for conversions or transformations of multi-dimensional
coordinate points.
- * A {@code MathTransform} usually performs conversions or transformations from points given
in a
- * {@linkplain org.apache.sis.referencing.operation.DefaultCoordinateOperation#getSourceCRS()
+ * Conversions or transformations of multi-dimensional coordinate points.
+ * A {@link org.opengis.referencing.operation.MathTransform} usually performs conversions
or transformations
+ * from points given in a {@linkplain org.apache.sis.referencing.operation.DefaultCoordinateOperation#getSourceCRS()
  * source coordinate reference system} to coordinate values for the same points in the
  * {@linkplain org.apache.sis.referencing.operation.DefaultCoordinateOperation#getTargetCRS()
  * target coordinate reference system}. However the conversions are not necessarily between
CRS;



Mime
View raw message