You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2016/12/03 00:15:17 UTC
svn commit: r1772420 - in /sis/branches/JDK8/core:
sis-referencing/src/main/java/org/apache/sis/referencing/factory/
sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/
sis-referencing/src/main/java/org/apache/sis/referencing/operatio...
Author: desruisseaux
Date: Sat Dec 3 00:15:17 2016
New Revision: 1772420
URL: http://svn.apache.org/viewvc?rev=1772420&view=rev
Log:
Javadoc (no significant code change).
Modified:
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/ConcurrentAuthorityFactory.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/IdentifiedObjectFinder.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConcatenatedOperation.java
sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConversion.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/ConcurrentAuthorityFactory.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/ConcurrentAuthorityFactory.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/ConcurrentAuthorityFactory.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/ConcurrentAuthorityFactory.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -1890,7 +1890,7 @@ public abstract class ConcurrentAuthorit
* All access to this object must be done in a block synchronized on {@link #findPool}.
*/
private static final class FindEntry {
- /** Result of the search with our without ignoring axes. */
+ /** Result of the search with or without ignoring axes. */
private Set<IdentifiedObject> strict, lenient;
/** Whether the cache is the result of an explicit request instead than a dependency search. */
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/IdentifiedObjectFinder.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/IdentifiedObjectFinder.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/IdentifiedObjectFinder.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/IdentifiedObjectFinder.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -443,7 +443,7 @@ public class IdentifiedObjectFinder {
candidate = create(code);
} catch (FactoryException e) {
/*
- * The identifier was not recognized. We will continue later will aliases.
+ * The identifier was not recognized. We will continue later with aliases.
* Note: we catch a more generic exception than NoSuchAuthorityCodeException because
* this attempt may fail for various reasons (character string not supported
* by the underlying database for primary key, duplicated name found, etc.).
@@ -509,12 +509,23 @@ public class IdentifiedObjectFinder {
}
/**
- * Creates an object for the given code. This method is invoked by the default {@link #find(IdentifiedObject)}
- * method implementation of for each code returned by the {@link #getCodeCandidates(IdentifiedObject)} method,
- * in iteration order.
+ * Creates an object for the given identifier, name or alias. This method is invoked by the default
+ * {@link #find(IdentifiedObject)} method implementation with the following argument values, in order
+ * (from less expensive to most expensive search operation):
+ *
+ * <ol>
+ * <li>All {@linkplain AbstractIdentifiedObject#getIdentifier() identifiers} of the object to search,
+ * formatted in an {@linkplain IdentifiedObjects#toString(Identifier) "AUTHORITY:CODE"} pattern.</li>
+ * <li>The {@linkplain AbstractIdentifiedObject#getName() name} of the object to search,
+ * {@linkplain org.apache.sis.referencing.NamedIdentifier#getCode() without authority}.</li>
+ * <li>All {@linkplain AbstractIdentifiedObject#getAlias() aliases} of the object to search.</li>
+ * <li>Each code returned by the {@link #getCodeCandidates(IdentifiedObject)} method, in iteration order.</li>
+ * </ol>
*
* @param code the authority code for which to create an object.
* @return the identified object for the given code, or {@code null} to stop attempts.
+ * @throws NoSuchAuthorityCodeException if no object is found for the given code. It may happen if {@code code}
+ * was a name or alias instead than an identifier and the factory supports only search by identifier.
* @throws FactoryException if an error occurred while creating the object.
*/
private IdentifiedObject create(final String code) throws FactoryException {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/sql/EPSGDataAccess.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -66,6 +66,7 @@ import org.opengis.referencing.datum.*;
import org.opengis.referencing.operation.*;
import org.opengis.referencing.IdentifiedObject;
import org.opengis.referencing.NoSuchAuthorityCodeException;
+
import org.apache.sis.internal.metadata.ReferencingServices;
import org.apache.sis.internal.metadata.TransformationAccuracy;
import org.apache.sis.internal.metadata.WKTKeywords;
@@ -3062,7 +3063,8 @@ next: while (r.next()) {
}
/**
- * Searches for the given object with warnings for deprecations temporarily disabled.
+ * Lookups objects which are approximatively equal to the specified object.
+ * This method temporarily disables warnings about deprecated objects.
*/
@Override
public Set<IdentifiedObject> find(final IdentifiedObject object) throws FactoryException {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -776,7 +776,7 @@ check: for (int isTarget=0; ; isTar
deepEquals(getInterpolationCRS(), getInterpolationCRS(that), mode))
{
/*
- * At this point all metdata match or can be ignored. First, compare the targetCRS.
+ * At this point all metadata match or can be ignored. First, compare the targetCRS.
* We need to perform this comparison only if this 'equals(\u2026)' method is not invoked
* from AbstractDerivedCRS, otherwise we would fall in an infinite recursive loop
* (because targetCRS is the DerivedCRS, which in turn wants to compare this operation).
@@ -786,7 +786,7 @@ check: for (int isTarget=0; ; isTar
* its "from base" conversion. The flag should never be set in any other circumstance,
* since this is an internal Apache SIS mechanism. If we know that we are comparing the
* AbstractDerivedCRS.fromBase conversion, then (in the way Apache SIS is implemented)
- * this.sourceCRS == AbstractDerivedCRS.baseCRS. Consequently we can relax the check
+ * this.sourceCRS == AbstractDerivedCRS.baseCRS. Consequently we can relax the check of
* sourceCRS axis order if the mode is ComparisonMode.IGNORE_METADATA.
*/
if (Semaphores.queryAndSet(Semaphores.CONVERSION_AND_CRS)) {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -112,7 +112,9 @@ class AbstractSingleOperation extends Ab
/**
* Creates a coordinate operation from the given properties.
+ * This constructor would be public if {@code AbstractSingleOperation} was public.
*/
+ @SuppressWarnings("PublicConstructorInNonPublicClass")
public AbstractSingleOperation(final Map<String,?> properties,
final CoordinateReferenceSystem sourceCRS,
final CoordinateReferenceSystem targetCRS,
@@ -364,8 +366,8 @@ class AbstractSingleOperation extends Ab
/*
* We consider the operation method as metadata. One could argue that OperationMethod's 'sourceDimension' and
* 'targetDimension' are not metadata, but their values should be identical to the 'sourceCRS' and 'targetCRS'
- * dimensions, already checked below. We could also argue that 'OperationMethod.parameters' are not metadata,
- * but their values should have been taken in account for the MathTransform creation, compared below.
+ * dimensions, already checked above. We could also argue that 'OperationMethod.parameters' are not metadata,
+ * but their values should have been taken in account for the MathTransform creation, compared above.
*
* Comparing the MathTransforms instead of parameters avoid the problem of implicit parameters. For example in
* a ProjectedCRS, the "semiMajor" and "semiMinor" axis lengths are sometime provided as explicit parameters,
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConcatenatedOperation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConcatenatedOperation.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConcatenatedOperation.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConcatenatedOperation.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -100,11 +100,12 @@ final class DefaultConcatenatedOperation
* </tr>
* </table>
*
- * @param properties The properties to be given to the identified object.
- * @param operations The sequence of operations. Shall contains at least two operations.
- * @param mtFactory The math transform factory to use for math transforms concatenation.
+ * @param properties the properties to be given to the identified object.
+ * @param operations the sequence of operations. Shall contains at least two operations.
+ * @param mtFactory the math transform factory to use for math transforms concatenation.
* @throws FactoryException if the factory can not concatenate the math transforms.
*/
+ @SuppressWarnings("PublicConstructorInNonPublicClass")
public DefaultConcatenatedOperation(final Map<String,?> properties, CoordinateOperation[] operations,
final MathTransformFactory mtFactory) throws FactoryException
{
@@ -155,10 +156,10 @@ final class DefaultConcatenatedOperation
* since we are adding accuracy informations to a concatenated operation. This departure should be considered
* as a convenience feature only; accuracies are really relevant in transformations only.</div>
*
- * @param properties The properties specified at construction time, or {@code null} if unknown.
- * @param operations The operations to concatenate.
- * @param flattened The destination list in which to add the {@code SingleOperation} instances.
- * @param mtFactory The math transform factory to use, or {@code null} for not performing concatenation.
+ * @param properties the properties specified at construction time, or {@code null} if unknown.
+ * @param operations the operations to concatenate.
+ * @param flattened the destination list in which to add the {@code SingleOperation} instances.
+ * @param mtFactory the math transform factory to use, or {@code null} for not performing concatenation.
* @param setAccuracy {@code true} for setting the {@link #coordinateOperationAccuracy} field.
* @param setDomain {@code true} for setting the {@link #domainOfValidity} field.
* @throws FactoryException if the factory can not concatenate the math transforms.
@@ -254,7 +255,7 @@ final class DefaultConcatenatedOperation
*
* <p>This constructor performs a shallow copy, i.e. the properties are not cloned.</p>
*
- * @param operation The coordinate operation to copy.
+ * @param operation the coordinate operation to copy.
*
* @see #castOrCopy(ConcatenatedOperation)
*/
@@ -271,8 +272,8 @@ final class DefaultConcatenatedOperation
* Note that this is a <cite>shallow</cite> copy operation, since the other properties contained in the given
* object are not recursively copied.
*
- * @param object The object to get as a SIS implementation, or {@code null} if none.
- * @return A SIS implementation containing the values of the given object (may be the
+ * @param object the object to get as a SIS implementation, or {@code null} if none.
+ * @return a SIS implementation containing the values of the given object (may be the
* given object itself), or {@code null} if the argument was null.
*/
public static DefaultConcatenatedOperation castOrCopy(final ConcatenatedOperation object) {
@@ -299,7 +300,7 @@ final class DefaultConcatenatedOperation
/**
* Returns the sequence of operations.
*
- * @return The sequence of operations.
+ * @return the sequence of operations.
*/
@Override
@SuppressWarnings("ReturnOfCollectionOrArrayField")
@@ -318,7 +319,7 @@ final class DefaultConcatenatedOperation
@Override
public boolean equals(final Object object, final ComparisonMode mode) {
if (object == this) {
- return true; // Slight optimization.
+ return true; // Slight optimization.
}
if (super.equals(object, mode)) {
if (mode == ComparisonMode.STRICT) {
@@ -344,7 +345,7 @@ final class DefaultConcatenatedOperation
* Formats this coordinate operation in pseudo-WKT. This is specific to Apache SIS since
* there is no concatenated operation in the Well Known Text (WKT) version 2 format.
*
- * @param formatter The formatter to use.
+ * @param formatter the formatter to use.
* @return {@code "ConcatenatedOperation"}.
*/
@Override
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConversion.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConversion.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConversion.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConversion.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -144,13 +144,13 @@ public class DefaultConversion extends A
* with different source and target datum, it does not accept to use such instances for
* {@linkplain org.apache.sis.referencing.crs.DefaultDerivedCRS derived CRS} construction.
*
- * @param properties The properties to be given to the identified object.
- * @param sourceCRS The source CRS.
- * @param targetCRS The target CRS, which shall use a datum
- * {@linkplain Utilities#equalsIgnoreMetadata equals (ignoring metadata)} to the source CRS datum.
- * @param interpolationCRS The CRS of additional coordinates needed for the operation, or {@code null} if none.
- * @param method The coordinate operation method (mandatory in all cases).
- * @param transform Transform from positions in the source CRS to positions in the target CRS.
+ * @param properties the properties to be given to the identified object.
+ * @param sourceCRS the source CRS.
+ * @param targetCRS the target CRS, which shall use a datum
+ * {@linkplain Utilities#equalsIgnoreMetadata equals (ignoring metadata)} to the source CRS datum.
+ * @param interpolationCRS the CRS of additional coordinates needed for the operation, or {@code null} if none.
+ * @param method the coordinate operation method (mandatory in all cases).
+ * @param transform transform from positions in the source CRS to positions in the target CRS.
*/
public DefaultConversion(final Map<String,?> properties,
final CoordinateReferenceSystem sourceCRS,
@@ -193,10 +193,10 @@ public class DefaultConversion extends A
* the parameters used for creating the transform. Those parameters will be stored for information purpose and can
* be given back by the {@link #getParameterValues()} method.</p>
*
- * @param properties The properties to be given to the identified object.
- * @param method The operation method.
- * @param transform Transform from positions in the source CRS to positions in the target CRS, or {@code null}.
- * @param parameters The {@code transform} parameter values, or {@code null}.
+ * @param properties the properties to be given to the identified object.
+ * @param method the operation method.
+ * @param transform transform from positions in the source CRS to positions in the target CRS, or {@code null}.
+ * @param parameters the {@code transform} parameter values, or {@code null}.
*
* @see DefaultMathTransformFactory#swapAndScaleAxes(MathTransform, DefaultMathTransformFactory.Context)
*/
@@ -224,11 +224,11 @@ public class DefaultConversion extends A
* specified source and target CRS. While the source conversion can be an arbitrary one, it is
* typically a defining conversion.
*
- * @param definition The defining conversion.
- * @param source The new source CRS.
- * @param target The new target CRS.
- * @param factory The factory to use for creating a transform from the parameters or for performing axis changes.
- * @param actual An array of length 1 where to store the actual operation method used by the math transform factory.
+ * @param definition the defining conversion.
+ * @param source the new source CRS.
+ * @param target the new target CRS.
+ * @param factory the factory to use for creating a transform from the parameters or for performing axis changes.
+ * @param actual an array of length 1 where to store the actual operation method used by the math transform factory.
*/
DefaultConversion(final Conversion definition,
final CoordinateReferenceSystem source,
@@ -311,7 +311,7 @@ public class DefaultConversion extends A
*
* <p>This constructor performs a shallow copy, i.e. the properties are not cloned.</p>
*
- * @param operation The coordinate operation to copy.
+ * @param operation the coordinate operation to copy.
*
* @see #castOrCopy(Conversion)
*/
@@ -342,8 +342,8 @@ public class DefaultConversion extends A
* properties contained in the given object are not recursively copied.</li>
* </ul>
*
- * @param object The object to get as a SIS implementation, or {@code null} if none.
- * @return A SIS implementation containing the values of the given object (may be the
+ * @param object the object to get as a SIS implementation, or {@code null} if none.
+ * @return a SIS implementation containing the values of the given object (may be the
* given object itself), or {@code null} if the argument was null.
*/
public static DefaultConversion castOrCopy(final Conversion object) {
@@ -355,7 +355,7 @@ public class DefaultConversion extends A
* The default implementation returns {@code Conversion.class}.
* Subclasses implementing a more specific GeoAPI interface shall override this method.
*
- * @return The conversion interface implemented by this class.
+ * @return the conversion interface implemented by this class.
*/
@Override
public Class<? extends Conversion> getInterface() {
@@ -381,12 +381,12 @@ public class DefaultConversion extends A
* interface, but may also implement a more specific GeoAPI interface if {@code specialize(\u2026)} has been able
* to infer the type from this operation {@linkplain #getMethod() method}.
*
- * @param <T> Compile-time type of the {@code baseType} argument.
- * @param baseType The base GeoAPI interface to be implemented by the conversion to return.
- * @param sourceCRS The source CRS.
- * @param targetCRS The target CRS.
- * @param factory The factory to use for creating a transform from the parameters or for performing axis changes.
- * @return The conversion of the given type between the given CRS.
+ * @param <T> compile-time type of the {@code baseType} argument.
+ * @param baseType the base GeoAPI interface to be implemented by the conversion to return.
+ * @param sourceCRS the source CRS.
+ * @param targetCRS the target CRS.
+ * @param factory the factory to use for creating a transform from the parameters or for performing axis changes.
+ * @return the conversion of the given type between the given CRS.
* @throws ClassCastException if a contradiction is found between the given {@code baseType},
* the defining {@linkplain DefaultConversion#getInterface() conversion type} and
* the {@linkplain DefaultOperationMethod#getOperationType() method operation type}.
@@ -435,9 +435,9 @@ public class DefaultConversion extends A
* Ensures that the {@code actual} CRS uses a datum which is equals, ignoring metadata,
* to the datum of the {@code expected} CRS.
*
- * @param param The parameter name, used only in case of error.
- * @param expected The CRS containing the expected datum, or {@code null}.
- * @param actual The CRS for which to check the datum, or {@code null}.
+ * @param param the parameter name, used only in case of error.
+ * @param expected the CRS containing the expected datum, or {@code null}.
+ * @param actual the CRS for which to check the datum, or {@code null}.
* @throws MismatchedDatumException if the two CRS use different datum.
*/
private static void ensureCompatibleDatum(final String param,
@@ -459,12 +459,12 @@ public class DefaultConversion extends A
* For example if {@code sourceCRS} uses a {@code CartesianCS}, then {@code targetCRS} must use
* a {@code CartesianCS} too.
*
- * @param transform The transform to which to concatenate axis changes.
- * @param sourceCRS The first CRS of the pair for which to check for axes changes.
- * @param targetCRS The second CRS of the pair for which to check for axes changes.
- * @param interpDim The number of dimensions of the interpolation CRS, or 0 if none.
- * @param isSource {@code true} for pre-concatenating the changes, or {@code false} for post-concatenating.
- * @param factory The factory to use for performing axis changes.
+ * @param transform the transform to which to concatenate axis changes.
+ * @param sourceCRS the first CRS of the pair for which to check for axes changes.
+ * @param targetCRS the second CRS of the pair for which to check for axes changes.
+ * @param interpDim the number of dimensions of the interpolation CRS, or 0 if none.
+ * @param isSource {@code true} for pre-concatenating the changes, or {@code false} for post-concatenating.
+ * @param factory the factory to use for performing axis changes.
*/
private static MathTransform swapAndScaleAxes(MathTransform transform,
final CoordinateReferenceSystem sourceCRS,
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -190,7 +190,7 @@ public class SimpleIdentifiedObject impl
* If name is a critical component of this object, then it shall be compared by the subclass.
* This behavior is consistent with {@link org.apache.sis.referencing.AbstractIdentifiedObject}.
*
- * @param object the object to compare with this reference system.
+ * @param object the object to compare with this identified object.
* @param mode the strictness level of the comparison.
* @return {@code true} if both objects are equal.
*/
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -84,7 +84,7 @@ public final class Semaphores {
/**
* Returns {@code true} if the given flag is set.
*
- * @param flag One of {@link #CONVERSION_AND_CRS}, {@link #ENCLOSED_IN_OPERATION} or other constants.
+ * @param flag one of {@link #CONVERSION_AND_CRS}, {@link #ENCLOSED_IN_OPERATION} or other constants.
* @return {@code true} if the given flag is set.
*/
public static boolean query(final byte flag) {
@@ -95,7 +95,7 @@ public final class Semaphores {
/**
* Sets the given flag.
*
- * @param flag One of {@link #CONVERSION_AND_CRS}, {@link #ENCLOSED_IN_OPERATION} or other constants.
+ * @param flag one of {@link #CONVERSION_AND_CRS}, {@link #ENCLOSED_IN_OPERATION} or other constants.
* @return {@code true} if the given flag was already set.
*/
public static boolean queryAndSet(final byte flag) {
@@ -112,7 +112,7 @@ public final class Semaphores {
/**
* Clears the given flag.
*
- * @param flag One of {@link #CONVERSION_AND_CRS}, {@link #ENCLOSED_IN_OPERATION} or other constants.
+ * @param flag one of {@link #CONVERSION_AND_CRS}, {@link #ENCLOSED_IN_OPERATION} or other constants.
*/
public static void clear(final byte flag) {
final Semaphores s = FLAGS.get();
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java?rev=1772420&r1=1772419&r2=1772420&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java [UTF-8] Sat Dec 3 00:15:17 2016
@@ -22,10 +22,8 @@ import java.util.Collection;
import java.util.LinkedList;
import java.util.Map;
import java.util.Set;
-import org.apache.sis.util.collection.CheckedContainer;
-
-// Branch-dependent imports
import java.util.Objects;
+import org.apache.sis.util.collection.CheckedContainer;
/**
@@ -69,8 +67,8 @@ public final class Utilities extends Sta
* return deepEquals(object1, object2, ComparisonMode.IGNORE_METADATA);
* }
*
- * @param object1 The first object to compare (may be null).
- * @param object2 The second object to compare (may be null).
+ * @param object1 the first object to compare (may be null).
+ * @param object2 the second object to compare (may be null).
* @return {@code true} if both objects are equal, ignoring metadata.
*
* @see #deepEquals(Object, Object, ComparisonMode)
@@ -103,8 +101,8 @@ public final class Utilities extends Sta
* return deepEquals(object1, object2, ComparisonMode.APPROXIMATIVE);
* }
*
- * @param object1 The first object to compare (may be null).
- * @param object2 The second object to compare (may be null).
+ * @param object1 the first object to compare (may be null).
+ * @param object2 the second object to compare (may be null).
* @return {@code true} if both objects are approximatively equal.
*
* @see #deepEquals(Object, Object, ComparisonMode)
@@ -123,9 +121,9 @@ public final class Utilities extends Sta
*
* <p>If both arguments are arrays or collections, then the elements are compared recursively.</p>
*
- * @param object1 The first object to compare, or {@code null}.
- * @param object2 The second object to compare, or {@code null}.
- * @param mode The strictness level of the comparison.
+ * @param object1 the first object to compare, or {@code null}.
+ * @param object2 the second object to compare, or {@code null}.
+ * @param mode the strictness level of the comparison.
* @return {@code true} if both objects are equal for the given level of strictness.
*
* @see #equalsIgnoreMetadata(Object, Object)
@@ -285,9 +283,9 @@ public final class Utilities extends Sta
/**
* Returns an assertion error message for mismatched types.
*
- * @param expected The expected type.
- * @param actual The actual object (not its type).
- * @return The error message to use in assertions.
+ * @param expected the expected type.
+ * @param actual the actual object (not its type).
+ * @return the error message to use in assertions.
*/
private static String mismatchedType(final Class<?> expected, final Object actual) {
return "Expected " + expected + " but got " + actual.getClass();
@@ -324,8 +322,8 @@ public final class Utilities extends Sta
* exactly as {@code Object}, not as some subtype like {@code Object[]}, {@code String} or
* {@code float[]}. In the later cases, use the appropriate {@link Arrays} method instead.
*
- * @param object The object to compute hash code. May be {@code null}.
- * @return The hash code of the given object.
+ * @param object the object to compute hash code. May be {@code null}.
+ * @return the hash code of the given object.
*/
public static int deepHashCode(final Object object) {
if (object == null) {
@@ -359,8 +357,8 @@ public final class Utilities extends Sta
* exactly as {@code Object}, not as some subtype like {@code Object[]}, {@code Number} or
* {@code float[]}. In the later cases, use the appropriate {@link Arrays} method instead.
*
- * @param object The object to format as a string. May be {@code null}.
- * @return A string representation of the given object.
+ * @param object the object to format as a string. May be {@code null}.
+ * @return a string representation of the given object.
*/
public static String deepToString(final Object object) {
if (object instanceof Object[]) return Arrays.deepToString((Object[]) object);