Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/Parameters.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/Parameters.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/Parameters.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/Parameters.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -127,8 +127,8 @@ public abstract class Parameters impleme
* then it is returned as-is. Otherwise this method copies all parameter values in a new,
* unmodifiable, parameter group instance.
*
- * @param parameters The parameters to make unmodifiable, or {@code null}.
- * @return An unmodifiable group with the same parameters than the given group,
+ * @param parameters the parameters to make unmodifiable, or {@code null}.
+ * @return an unmodifiable group with the same parameters than the given group,
* or {@code null} if the given argument was null.
*
* @since 0.7
@@ -147,8 +147,8 @@ public abstract class Parameters impleme
*
This method provides a way to get access to the non-static {@code Parameters} methods, like
* {@link #getValue(ParameterDescriptor)}, for an arbitrary {@code ParameterValueGroup} instance.
*
- * @param parameters The object to cast or wrap, or {@code null}.
- * @return The given argument as an instance of {@code Parameters} (may be the same reference),
+ * @param parameters the object to cast or wrap, or {@code null}.
+ * @return the given argument as an instance of {@code Parameters} (may be the same reference),
* or {@code null} if the given argument was null.
*/
public static Parameters castOrWrap(final ParameterValueGroup parameters) {
@@ -179,10 +179,10 @@ public abstract class Parameters impleme
* An exception is thrown immediately if the parameter does not have the expected
* {@linkplain DefaultParameterDescriptor#getValueClass() value class}.
*
- * @param The expected value class.
- * @param descriptor The descriptor to cast, or {@code null}.
- * @param valueClass The expected value class.
- * @return The descriptor casted to the given value class, or {@code null} if the given descriptor was null.
+ * @param the expected value class.
+ * @param descriptor the descriptor to cast, or {@code null}.
+ * @param valueClass the expected value class.
+ * @return the descriptor casted to the given value class, or {@code null} if the given descriptor was null.
* @throws ClassCastException if the given descriptor does not have the expected value class.
*
* @see Class#cast(Object)
@@ -196,8 +196,10 @@ public abstract class Parameters impleme
ArgumentChecks.ensureNonNull("valueClass", valueClass);
if (descriptor != null) {
final Class> actual = descriptor.getValueClass();
- // We require a strict equality - not type.isAssignableFrom(actual) - because in
- // the later case we could have (to be strict) to return a extends T> type.
+ /*
+ * We require a strict equality - not type.isAssignableFrom(actual) - because in
+ * the later case we could have (to be strict) to return a extends T> type.
+ */
if (!valueClass.equals(actual)) {
throw new ClassCastException(Resources.format(Resources.Keys.IllegalParameterType_2,
Verifier.getDisplayName(descriptor), actual));
@@ -210,10 +212,10 @@ public abstract class Parameters impleme
* Casts the given parameter value to the given type.
* An exception is thrown immediately if the parameter does not have the expected value class.
*
- * @param The expected value class.
- * @param parameter The parameter to cast, or {@code null}.
- * @param valueClass The expected value class.
- * @return The value casted to the given type, or {@code null} if the given value was null.
+ * @param the expected value class.
+ * @param parameter the parameter to cast, or {@code null}.
+ * @param valueClass the expected value class.
+ * @return the value casted to the given type, or {@code null} if the given value was null.
* @throws ClassCastException if the given value doesn't have the expected value class.
*
* @see Class#cast(Object)
@@ -246,8 +248,8 @@ public abstract class Parameters impleme
* element of the returned array is also {@code null}.
*
*
- * @param parameters The parameter values from which to get the descriptors, or {@code null}.
- * @return The descriptors of the given parameter values, or {@code null} if the {@code parameters} argument was null.
+ * @param parameters the parameter values from which to get the descriptors, or {@code null}.
+ * @return the descriptors of the given parameter values, or {@code null} if the {@code parameters} argument was null.
*
* @since 0.6
*/
@@ -283,8 +285,8 @@ public abstract class Parameters impleme
* defined by ISO 19111 (namely {@code CC_OperationParameter}) and the one
* defined by ISO 19115 (namely {@code SV_Parameter}).
*
- * @param parameter The parameter from which to get the name (may be {@code null}).
- * @return The member name, or {@code null} if none.
+ * @param parameter the parameter from which to get the name (may be {@code null}).
+ * @return the member name, or {@code null} if none.
*
* @see org.apache.sis.util.iso.Names#createMemberName(CharSequence, String, CharSequence, Class)
*
@@ -306,8 +308,8 @@ public abstract class Parameters impleme
* the {@linkplain DefaultParameterDescriptor#getUnit() unit}.
*
*
- * @param descriptor The parameter descriptor, or {@code null}.
- * @return The domain of valid values, or {@code null} if none.
+ * @param descriptor the parameter descriptor, or {@code null}.
+ * @return the domain of valid values, or {@code null} if none.
*
* @see DefaultParameterDescriptor#getValueDomain()
*/
@@ -344,8 +346,8 @@ public abstract class Parameters impleme
* Returns the name or alias of the given parameter for the authority code space expected by this group.
* If no name or alias for this group's authority can be found, then the primary name will be returned.
*
- * @param source The parameter for which the name is wanted.
- * @return The name of the given parameter.
+ * @param source the parameter for which the name is wanted.
+ * @return the name of the given parameter.
*/
private String getName(final GeneralParameterDescriptor source) {
final ParameterDescriptorGroup descriptor = getDescriptor();
@@ -401,8 +403,8 @@ public abstract class Parameters impleme
* This method tries to do the same work than {@link #parameter(String)} but without
* instantiating optional parameters if that parameter was not already instantiated.
*
- * @param parameter The parameter to search.
- * @return The requested parameter value, or {@code null} if none.
+ * @param parameter the parameter to search.
+ * @return the requested parameter value, or {@code null} if none.
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
*/
private ParameterValue> getParameter(final ParameterDescriptor> parameter) throws ParameterNotFoundException {
@@ -466,9 +468,9 @@ public abstract class Parameters impleme
* operation method}. If the caller has no such {@code ParameterDescriptor} at hand, then the
* {@link DefaultParameterValueGroup#parameter(String) parameter(String)} method is probably more convenient.
*
- * @param The type of the parameter value.
- * @param parameter The name or alias of the parameter to look for, together with the desired type and unit of value.
- * @return The requested parameter value if it exists, or the {@linkplain DefaultParameterDescriptor#getDefaultValue()
+ * @param the type of the parameter value.
+ * @param parameter the name or alias of the parameter to look for, together with the desired type and unit of value.
+ * @return the requested parameter value if it exists, or the {@linkplain DefaultParameterDescriptor#getDefaultValue()
* default value} otherwise (which may be {@code null}).
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
*
@@ -502,9 +504,9 @@ public abstract class Parameters impleme
* The default implementation invokes {@link #getValue(ParameterDescriptor)} and verifies that the returned
* value is non-null.
*
- * @param The type of the parameter value.
- * @param parameter The name or alias of the parameter to look for, together with the desired type and unit of value.
- * @return The requested parameter value if it exists, or the {@linkplain DefaultParameterDescriptor#getDefaultValue()
+ * @param the type of the parameter value.
+ * @param parameter the name or alias of the parameter to look for, together with the desired type and unit of value.
+ * @return the requested parameter value if it exists, or the {@linkplain DefaultParameterDescriptor#getDefaultValue()
* default value} otherwise provided that it is not {@code null}.
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
* @throws IllegalStateException if the value is not defined and there is no default value.
@@ -541,8 +543,8 @@ public abstract class Parameters impleme
* See {@link #getValue(ParameterDescriptor)} for more information about how this
* method uses the given {@code parameter} argument.
*
- * @param parameter The name or alias of the parameter to look for.
- * @return The requested parameter value if it exists, or the non-null
+ * @param parameter the name or alias of the parameter to look for.
+ * @return the requested parameter value if it exists, or the non-null
* {@linkplain DefaultParameterDescriptor#getDefaultValue() default value} otherwise.
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
* @throws IllegalStateException if the value is not defined and there is no default value.
@@ -561,8 +563,8 @@ public abstract class Parameters impleme
* See {@link #getValue(ParameterDescriptor)} for more information about how this
* method uses the given {@code parameter} argument.
*
- * @param parameter The name or alias of the parameter to look for.
- * @return The requested parameter value if it exists, or the non-null
+ * @param parameter the name or alias of the parameter to look for.
+ * @return the requested parameter value if it exists, or the non-null
* {@linkplain DefaultParameterDescriptor#getDefaultValue() default value} otherwise.
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
* @throws IllegalStateException if the value is not defined and there is no default value.
@@ -581,8 +583,8 @@ public abstract class Parameters impleme
* See {@link #getValue(ParameterDescriptor)} for more information about how this
* method uses the given {@code parameter} argument.
*
- * @param parameter The name or alias of the parameter to look for.
- * @return The requested parameter values if they exist, or the non-null
+ * @param parameter the name or alias of the parameter to look for.
+ * @return the requested parameter values if they exist, or the non-null
* {@linkplain DefaultParameterDescriptor#getDefaultValue() default value} otherwise.
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
* @throws IllegalStateException if the value is not defined and there is no default value.
@@ -604,8 +606,8 @@ public abstract class Parameters impleme
* If the given descriptor supplies a {@linkplain DefaultParameterDescriptor#getUnit()
* unit of measurement}, then the returned value will be converted into that unit.
*
- * @param parameter The name or alias of the parameter to look for.
- * @return The requested parameter value if it exists, or the non-null
+ * @param parameter the name or alias of the parameter to look for.
+ * @return the requested parameter value if it exists, or the non-null
* {@linkplain DefaultParameterDescriptor#getDefaultValue() default value} otherwise.
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
* @throws IllegalStateException if the value is not defined and there is no default value.
@@ -632,8 +634,8 @@ public abstract class Parameters impleme
* If the given descriptor supplies a {@linkplain DefaultParameterDescriptor#getUnit()
* unit of measurement}, then the returned values will be converted into that unit.
*
- * @param parameter The name or alias of the parameter to look for.
- * @return The requested parameter values if they exists, or the non-null
+ * @param parameter the name or alias of the parameter to look for.
+ * @return the requested parameter values if they exists, or the non-null
* {@linkplain DefaultParameterDescriptor#getDefaultValue() default value} otherwise.
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
* @throws IllegalStateException if the value is not defined and there is no default value.
@@ -657,8 +659,8 @@ public abstract class Parameters impleme
* See {@link #getValue(ParameterDescriptor)} for more information about how this
* method uses the given {@code parameter} argument.
*
- * @param parameter The name or alias of the parameter to look for.
- * @return The requested parameter value if it exists, or the non-null
+ * @param parameter the name or alias of the parameter to look for.
+ * @return the requested parameter value if it exists, or the non-null
* {@linkplain DefaultParameterDescriptor#getDefaultValue() default value} otherwise.
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
* @throws IllegalStateException if the value is not defined and there is no default value.
@@ -686,9 +688,9 @@ public abstract class Parameters impleme
* or {@linkplain DefaultParameterDescriptor#getAlias() alias} chosen by the same algorithm than
* {@link #getValue(ParameterDescriptor)}.
*
- * @param The type of the parameter value.
- * @param parameter The parameter to look for.
- * @return The requested parameter instance.
+ * @param the type of the parameter value.
+ * @param parameter the parameter to look for.
+ * @return the requested parameter instance.
* @throws ParameterNotFoundException if the given {@code parameter} name or alias is not legal for this group.
*
* @see DefaultParameterValueGroup#parameter(String)
@@ -704,7 +706,7 @@ public abstract class Parameters impleme
* The default implementation performs a shallow copy,
* but subclasses are encouraged to perform a deep copy.
*
- * @return A copy of this group of parameter values.
+ * @return a copy of this group of parameter values.
*
* @see #copy(ParameterValueGroup, ParameterValueGroup)
*/
@@ -713,7 +715,7 @@ public abstract class Parameters impleme
try {
return (Parameters) super.clone();
} catch (CloneNotSupportedException e) {
- throw new AssertionError(e); // Should never happen since we are Cloneable
+ throw new AssertionError(e); // Should never happen since we are Cloneable.
}
}
@@ -727,8 +729,8 @@ public abstract class Parameters impleme
* to some specific implementation, or to a parameter group using a different but compatible
* {@linkplain DefaultParameterValueGroup#getDescriptor() descriptor}.
*
- * @param values The parameters values to copy.
- * @param destination Where to copy the values.
+ * @param values the parameters values to copy.
+ * @param destination where to copy the values.
* @throws InvalidParameterNameException if a {@code source} parameter name is unknown to the {@code destination}.
* @throws InvalidParameterValueException if the value of a {@code source} parameter is invalid for the {@code destination}.
*
@@ -793,10 +795,10 @@ public abstract class Parameters impleme
* (this is a SIS-specific flexibility). Current implementation is not very efficient, but it should
* not be an issue if this method is rarely invoked.
*
- * @param values The group from which to get or create a value
- * @param name The name of the parameter to fetch. An exact match will be required.
- * @param n Number of occurrences to skip before to return or create the parameter.
- * @return The nth occurrence (zero-based) of the parameter of the given name.
+ * @param values the group from which to get or create a value
+ * @param name the name of the parameter to fetch. An exact match will be required.
+ * @param n number of occurrences to skip before to return or create the parameter.
+ * @return the nth occurrence (zero-based) of the parameter of the given name.
* @throws IndexOutOfBoundsException if {@code n} is greater than the current number of
* parameters of the given name.
*/
@@ -813,8 +815,10 @@ public abstract class Parameters impleme
values.values().add(value);
return value;
} else {
- // We do not botter formatting a good error message for now, because
- // this method is currently invoked only with increasing index values.
+ /*
+ * We do not botter formatting a good error message for now, because
+ * this method is currently invoked only with increasing index values.
+ */
throw new IndexOutOfBoundsException(name);
}
}
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -21,6 +21,7 @@ import java.util.HashMap;
import java.util.List;
import java.util.Arrays;
import java.util.Collections;
+import java.util.Objects;
import java.io.IOException;
import java.io.Serializable;
import java.io.ObjectInputStream;
@@ -47,9 +48,6 @@ import org.apache.sis.util.Numbers;
import org.apache.sis.util.ArgumentChecks;
import org.apache.sis.util.resources.Errors;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* Creates parameter groups for tensors (usually matrices).
@@ -309,11 +307,11 @@ public class TensorParameters impleme
/**
* Constructs a descriptors provider.
*
- * @param elementType The type of tensor element values.
- * @param prefix The prefix to insert in front of parameter name for each tensor elements.
- * @param separator The separator between dimension (row, column, …) indices in parameter names.
- * @param dimensions The parameter for the size of each dimension, usually in an array of length 2.
- * Length may be different if the caller wants to generalize usage of this class to tensors.
+ * @param elementType the type of tensor element values.
+ * @param prefix the prefix to insert in front of parameter name for each tensor elements.
+ * @param separator the separator between dimension (row, column, …) indices in parameter names.
+ * @param dimensions the parameter for the size of each dimension, usually in an array of length 2.
+ * Length may be different if the caller wants to generalize usage of this class to tensors.
*/
@SafeVarargs
@SuppressWarnings({"unchecked", "rawtypes"})
@@ -362,7 +360,7 @@ public class TensorParameters impleme
/**
* Returns the type of tensor element values.
*
- * @return The type of tensor element values.
+ * @return the type of tensor element values.
*/
public final Class getElementType() {
return elementType;
@@ -381,7 +379,7 @@ public class TensorParameters impleme
* k | rank k tensor |
*
*
- * @return The rank of the tensors for which to create parameters.
+ * @return the rank of the tensors for which to create parameters.
*/
public final int rank() {
return dimensions.length;
@@ -400,8 +398,8 @@ public class TensorParameters impleme
/**
* Returns the parameter descriptor for the dimension at the given index.
*
- * @param i The dimension index, from 0 inclusive to {@link #rank()} exclusive.
- * @return The parameter descriptor for the dimension at the given index.
+ * @param i the dimension index, from 0 inclusive to {@link #rank()} exclusive.
+ * @return the parameter descriptor for the dimension at the given index.
*
* @see #getElementDescriptor(int...)
* @see #getAllDescriptors(int...)
@@ -416,9 +414,9 @@ public class TensorParameters impleme
* That length is usually 2, where {@code indices[0]} is the row index and {@code indices[1]}
* is the column index.
*
- * @param indices The indices of the tensor element for which to get the descriptor.
- * @return The parameter descriptor for the given tensor element.
- * @throws IllegalArgumentException If the given array does not have the expected length or have illegal value.
+ * @param indices the indices of the tensor element for which to get the descriptor.
+ * @return the parameter descriptor for the given tensor element.
+ * @throws IllegalArgumentException if the given array does not have the expected length or have illegal value.
*
* @see #getDimensionDescriptor(int)
* @see #getAllDescriptors(int...)
@@ -488,9 +486,9 @@ public class TensorParameters impleme
* Subclasses can override this method if they want more control on descriptor properties
* like identification information, aliases or value domain.
*
- * @param indices The indices of the tensor element for which to create a parameter.
- * @return The parameter descriptor for the given tensor element.
- * @throws IllegalArgumentException If the given array does not have the expected length or have illegal value.
+ * @param indices the indices of the tensor element for which to create a parameter.
+ * @return the parameter descriptor for the given tensor element.
+ * @throws IllegalArgumentException if the given array does not have the expected length or have illegal value.
*
* @see #indicesToName(int[])
* @see #getDefaultValue(int[])
@@ -517,9 +515,9 @@ public class TensorParameters impleme
* If a subclass overrides this method for creating different names, then that subclass shall
* also override {@link #nameToIndices(String)} for parsing those names.
*
- * @param indices The indices of the tensor element for which to create a parameter name.
- * @return The parameter descriptor name for the tensor element at the given indices.
- * @throws IllegalArgumentException If the given array does not have the expected length or have illegal value.
+ * @param indices the indices of the tensor element for which to create a parameter name.
+ * @return the parameter descriptor name for the tensor element at the given indices.
+ * @throws IllegalArgumentException if the given array does not have the expected length or have illegal value.
*/
protected String indicesToName(final int[] indices) throws IllegalArgumentException {
verifyRank(indices);
@@ -541,9 +539,9 @@ public class TensorParameters impleme
* column + …” pattern and returns an array containing the row, column and other
* indices, in that order.
*
- * @param name The parameter name to parse.
- * @return Indices of the tensor element of the given name, or {@code null} if the name is not recognized.
- * @throws IllegalArgumentException If the name has been recognized but an error occurred while parsing it
+ * @param name the parameter name to parse.
+ * @return indices of the tensor element of the given name, or {@code null} if the name is not recognized.
+ * @throws IllegalArgumentException if the name has been recognized but an error occurred while parsing it
* (e.g. an {@link NumberFormatException}, which is an {@code IllegalArgumentException} subclass).
*/
protected int[] nameToIndices(final String name) throws IllegalArgumentException {
@@ -569,8 +567,8 @@ public class TensorParameters impleme
* Returns the default value for the parameter descriptor at the given indices.
* The default implementation returns 1 if all indices are equals, or 0 otherwise.
*
- * @param indices The indices of the tensor element for which to get the default value.
- * @return The default value for the tensor element at the given indices, or {@code null} if none.
+ * @param indices the indices of the tensor element for which to get the default value.
+ * @return the default value for the tensor element at the given indices, or {@code null} if none.
*
* @see DefaultParameterDescriptor#getDefaultValue()
*
@@ -588,10 +586,10 @@ public class TensorParameters impleme
/**
* Returns the descriptor in this group for the specified name.
*
- * @param caller The {@link TensorValues} instance invoking this method, used only in case of errors.
- * @param name The case insensitive name of the parameter to search for.
- * @param actualSize The current values of parameters that define the matrix (or tensor) dimensions.
- * @return The parameter for the given name.
+ * @param caller the {@link TensorValues} instance invoking this method, used only in case of errors.
+ * @param name the case insensitive name of the parameter to search for.
+ * @param actualSize the current values of parameters that define the matrix (or tensor) dimensions.
+ * @return the parameter for the given name.
* @throws ParameterNotFoundException if there is no parameter for the given name.
*/
final ParameterDescriptor> descriptor(final ParameterDescriptorGroup caller,
@@ -624,8 +622,8 @@ public class TensorParameters impleme
/**
* Returns {@code true} if the given indices are not out-of-bounds.
*
- * @param indices The indices parsed from a parameter name.
- * @param actualSize The current values of parameters that define the matrix (or tensor) dimensions.
+ * @param indices the indices parsed from a parameter name.
+ * @param actualSize the current values of parameters that define the matrix (or tensor) dimensions.
*/
static boolean isInBounds(final int[] indices, final int[] actualSize) {
for (int i=0; i impleme
* The returned array contains all descriptors returned by {@link #getDimensionDescriptor(int)}
* and {@link #getElementDescriptor(int...)}.
*
- * @param actualSize The matrix (or tensor) dimensions for which to get the parameters.
- * @return The tensor parameters, including all elements.
+ * @param actualSize the matrix (or tensor) dimensions for which to get the parameters.
+ * @return the tensor parameters, including all elements.
*
* @see #getDimensionDescriptor(int)
* @see #getElementDescriptor(int...)
@@ -724,8 +722,8 @@ public class TensorParameters impleme
*
*
*
- * @param properties The properties to be given to the identified object.
- * @return A new parameter group initialized to the default values.
+ * @param properties the properties to be given to the identified object.
+ * @return a new parameter group initialized to the default values.
*/
public ParameterValueGroup createValueGroup(final Map properties) {
return new TensorValues<>(properties, this);
@@ -735,9 +733,9 @@ public class TensorParameters impleme
* Creates a new instance of parameter group initialized to the given matrix.
* This operation is allowed only for tensors of {@linkplain #rank() rank} 2.
*
- * @param properties The properties to be given to the identified object.
- * @param matrix The matrix to copy in the new parameter group.
- * @return A new parameter group initialized to the given matrix.
+ * @param properties the properties to be given to the identified object.
+ * @param matrix the matrix to copy in the new parameter group.
+ * @return a new parameter group initialized to the given matrix.
*
* @see #toMatrix(ParameterValueGroup)
*/
@@ -755,8 +753,8 @@ public class TensorParameters impleme
* Constructs a matrix from a group of parameters.
* This operation is allowed only for tensors of {@linkplain #rank() rank} 2.
*
- * @param parameters The group of parameters.
- * @return A matrix constructed from the specified group of parameters.
+ * @param parameters the group of parameters.
+ * @return a matrix constructed from the specified group of parameters.
* @throws InvalidParameterNameException if a parameter name was not recognized.
*
* @see #createValueGroup(Map, Matrix)
@@ -800,7 +798,7 @@ public class TensorParameters impleme
/**
* Returns a hash code value for this object.
*
- * @return A hash code value.
+ * @return a hash code value.
*/
@Override
public int hashCode() {
@@ -810,7 +808,7 @@ public class TensorParameters impleme
/**
* Compares this object with the given object for equality.
*
- * @param other The other object to compare with this object.
+ * @param other the other object to compare with this object.
* @return {@code true} if both object are equal.
*/
@Override
@@ -831,9 +829,9 @@ public class TensorParameters impleme
/**
* Invoked on deserialization for restoring the {@link #parameters} array.
*
- * @param in The input stream from which to deserialize a group of tensor parameters.
- * @throws IOException If an I/O error occurred while reading or if the stream contains invalid data.
- * @throws ClassNotFoundException If the class serialized on the stream is not on the classpath.
+ * @param in the input stream from which to deserialize a group of tensor parameters.
+ * @throws IOException if an I/O error occurred while reading or if the stream contains invalid data.
+ * @throws ClassNotFoundException if the class serialized on the stream is not on the classpath.
*/
private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
in.defaultReadObject();
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorValues.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorValues.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorValues.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorValues.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -192,8 +192,8 @@ final class TensorValues extends Abst
/**
* Returns the parameter descriptor in this group for the specified name.
*
- * @param name The name of the parameter to search for.
- * @return The parameter descriptor for the given name.
+ * @param name the name of the parameter to search for.
+ * @return the parameter descriptor for the given name.
* @throws ParameterNotFoundException if there is no parameter for the given name.
*/
@Override
@@ -206,8 +206,8 @@ final class TensorValues extends Abst
/**
* Returns the parameter value in this group for the specified name.
*
- * @param name The name of the parameter to search for.
- * @return The parameter value for the given name.
+ * @param name the name of the parameter to search for.
+ * @return the parameter value for the given name.
* @throws ParameterNotFoundException if there is no parameter for the given name.
*/
@Override
@@ -347,7 +347,7 @@ final class TensorValues extends Abst
*/
private static boolean isOmitted(final ParameterValue> parameter) {
final Object value = parameter.getValue();
- if (value == null) { // Implies that the default value is also null.
+ if (value == null) { // Implies that the default value is also null.
return true;
}
final ParameterDescriptor> descriptor = parameter.getDescriptor();
@@ -374,7 +374,7 @@ final class TensorValues extends Abst
* Creates a matrix from this group of parameters.
* This operation is allowed only for tensors of {@linkplain #rank() rank} 2.
*
- * @return A matrix created from this group of parameters.
+ * @return a matrix created from this group of parameters.
*/
final Matrix toMatrix() {
final int numRow = dimensions[0].intValue();
@@ -401,7 +401,7 @@ final class TensorValues extends Abst
* After this method call, {@link #values} will returns only the elements
* different from the default value.
*
- * @param matrix The matrix to copy in this group of parameters.
+ * @param matrix the matrix to copy in this group of parameters.
*/
final void setMatrix(final Matrix matrix) {
final int numRow = matrix.getNumRow();
@@ -440,7 +440,7 @@ final class TensorValues extends Abst
@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)) {
final TensorValues> that = (TensorValues>) object;
@@ -464,7 +464,7 @@ final class TensorValues extends Abst
/**
* Formats this group as a pseudo-Well Known Text element.
*
- * @param formatter The formatter where to format the inner content of this WKT element.
+ * @param formatter the formatter where to format the inner content of this WKT element.
* @return {@code "ParameterGroup"}.
*/
@Override
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UninitializedParameter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UninitializedParameter.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UninitializedParameter.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UninitializedParameter.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -34,7 +34,7 @@ import org.apache.sis.referencing.Identi
* @module
*/
@SuppressWarnings("CloneInNonCloneableClass")
-final class UninitializedParameter implements GeneralParameterValue, Serializable { // Intentionally non-Cloneable.
+final class UninitializedParameter implements GeneralParameterValue, Serializable { // Intentionally non-Cloneable.
/**
* For cross-version serialization compatibility.
*/
@@ -64,6 +64,7 @@ final class UninitializedParameter imple
* Returns {@code this} since there is no need to clone this object.
*/
@Override
+ @SuppressWarnings("CloneDoesntCallSuperClone")
public GeneralParameterValue clone() {
return this;
}
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValue.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValue.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValue.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValue.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -81,9 +81,9 @@ final class UnmodifiableParameterValue The type of the value stored in the given parameter.
- * @param parameter The parameter to make unmodifiable, or {@code null}.
- * @return An unmodifiable implementation of the given parameter, or {@code null} if the given parameter was null.
+ * @param the type of the value stored in the given parameter.
+ * @param parameter the parameter to make unmodifiable, or {@code null}.
+ * @return an unmodifiable implementation of the given parameter, or {@code null} if the given parameter was null.
*/
static UnmodifiableParameterValue create(final ParameterValue parameter) {
if (parameter == null || parameter instanceof UnmodifiableParameterValue>) {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValueGroup.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValueGroup.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValueGroup.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValueGroup.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -20,6 +20,7 @@ import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.IdentityHashMap;
+import java.util.Objects;
import java.io.Serializable;
import org.opengis.parameter.ParameterValue;
import org.opengis.parameter.ParameterValueGroup;
@@ -34,9 +35,6 @@ import org.apache.sis.util.resources.Err
import org.apache.sis.internal.referencing.Resources;
import org.apache.sis.internal.util.UnmodifiableArrayList;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* A parameter value group which can not be modified. This is especially important for parameters of
@@ -73,8 +71,8 @@ final class UnmodifiableParameterValueGr
/**
* Creates a new unmodifiable parameter group.
*
- * @param group The group of values to copy.
- * @param done An initially empty map used for protection against circular references.
+ * @param group the group of values to copy.
+ * @param done an initially empty map used for protection against circular references.
*
* @see #create(ParameterValueGroup)
*/
@@ -101,8 +99,8 @@ final class UnmodifiableParameterValueGr
/**
* Creates a new unmodifiable parameter group.
*
- * @param group The group of values to copy, or {@code null}.
- * @return The unmodifiable parameter group, or {@code null} if the given argument was null.
+ * @param group the group of values to copy, or {@code null}.
+ * @return the unmodifiable parameter group, or {@code null} if the given argument was null.
*/
static UnmodifiableParameterValueGroup create(final ParameterValueGroup group) {
if (group == null || group instanceof UnmodifiableParameterValueGroup) {
@@ -204,15 +202,14 @@ final class UnmodifiableParameterValueGr
* ignore the order of parameter values (but not necessarily the order of parameter descriptors).
*
*
- * @param object The object to compare to {@code this}.
- * @param mode The strictness level of the comparison.
+ * @param object the object to compare to {@code this}.
+ * @param mode the strictness level of the comparison.
* @return {@code true} if both objects are equal according the given comparison mode.
*/
@Override
public boolean equals(final Object object, final ComparisonMode mode) {
if (object == this) {
- // Slight optimization
- return true;
+ return true; // Slight optimization
}
if (object != null) {
if (mode == ComparisonMode.STRICT) {
@@ -231,7 +228,7 @@ final class UnmodifiableParameterValueGr
/**
* Compares the specified object with this parameter for equality.
*
- * @param object The object to compare to {@code this}.
+ * @param object the object to compare to {@code this}.
* @return {@code true} if both objects are equal.
*/
@Override
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractIdentifiedObject.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractIdentifiedObject.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractIdentifiedObject.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractIdentifiedObject.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -23,6 +23,7 @@ import java.util.Collections;
import java.util.AbstractCollection;
import java.util.Iterator;
import java.util.Locale;
+import java.util.Objects;
import java.io.Serializable;
import javax.xml.bind.annotation.XmlID;
import javax.xml.bind.annotation.XmlType;
@@ -66,9 +67,6 @@ import static org.apache.sis.internal.ut
import static org.apache.sis.internal.util.CollectionsExt.nonEmpty;
import static org.apache.sis.internal.util.CollectionsExt.immutableSet;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* Base class for objects identified by a name or a code. Those objects are typically
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractReferenceSystem.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractReferenceSystem.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractReferenceSystem.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/AbstractReferenceSystem.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -145,7 +145,7 @@ public class AbstractReferenceSystem ext
*
*
*
- * @param properties The properties to be given to this object.
+ * @param properties the properties to be given to this object.
*/
public AbstractReferenceSystem(final Map properties) {
super(properties);
@@ -160,7 +160,7 @@ public class AbstractReferenceSystem ext
*
* This constructor performs a shallow copy, i.e. the properties are not cloned.
*
- * @param object The reference system to copy.
+ * @param object the reference system to copy.
*/
protected AbstractReferenceSystem(final ReferenceSystem object) {
super(object);
@@ -173,7 +173,7 @@ public class AbstractReferenceSystem ext
* The default implementation returns {@code ReferenceSystem.class}.
* Subclasses implementing a more specific GeoAPI interface shall override this method.
*
- * @return The GeoAPI interface implemented by this class.
+ * @return the GeoAPI interface implemented by this class.
*/
@Override
public Class extends ReferenceSystem> getInterface() {
@@ -183,7 +183,7 @@ public class AbstractReferenceSystem ext
/**
* Returns the region or timeframe in which this reference system is valid, or {@code null} if unspecified.
*
- * @return Area or region or timeframe in which this (coordinate) reference system is valid, or {@code null}.
+ * @return area or region or timeframe in which this (coordinate) reference system is valid, or {@code null}.
*
* @see org.apache.sis.metadata.iso.extent.DefaultExtent
*/
@@ -199,7 +199,7 @@ public class AbstractReferenceSystem ext
/**
* Returns the domain or limitations of usage, or {@code null} if unspecified.
*
- * @return Description of domain of usage, or limitations of usage, for which this
+ * @return description of domain of usage, or limitations of usage, for which this
* (coordinate) reference system object is valid, or {@code null}.
*/
@Override
@@ -215,10 +215,10 @@ public class AbstractReferenceSystem ext
* compared including the {@linkplain #getDomainOfValidity() domain of validity} and
* the {@linkplain #getScope() scope}.
*
- * @param object The object to compare to {@code this}.
- * @param mode {@link ComparisonMode#STRICT STRICT} for performing a strict comparison, or
- * {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for comparing only properties
- * relevant to coordinate transformations.
+ * @param object the object to compare to {@code this}.
+ * @param mode {@link ComparisonMode#STRICT STRICT} for performing a strict comparison, or
+ * {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for comparing only
+ * properties relevant to coordinate transformations.
* @return {@code true} if both objects are equal.
*/
@Override
@@ -249,7 +249,7 @@ public class AbstractReferenceSystem ext
* See {@link org.apache.sis.referencing.AbstractIdentifiedObject#computeHashCode()}
* for more information.
*
- * @return The hash code value. This value may change in any future Apache SIS version.
+ * @return the hash code value. This value may change in any future Apache SIS version.
*/
@Override
protected long computeHashCode() {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/EPSGFactoryFallback.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/EPSGFactoryFallback.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/EPSGFactoryFallback.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/EPSGFactoryFallback.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -110,7 +110,7 @@ final class EPSGFactoryFallback extends
/**
* Returns the namespace of EPSG codes.
*
- * @return The {@code "EPSG"} string in a singleton map.
+ * @return the {@code "EPSG"} string in a singleton map.
*/
@Override
public Set getCodeSpaces() {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NameIterator.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NameIterator.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NameIterator.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NameIterator.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -137,12 +137,12 @@ final class NameIterator implements Iter
* Consecutive invocations of this method do not need to return the same value,
* since it may depends on the marshalling context.
*
- * @param context The (un)marshalling context.
- * @param object The object for which to get a {@code gml:id}.
- * @param name The identified object name, or {@code null} if none.
- * @param alias The identified object aliases, or {@code null} if none.
- * @param identifiers The identifiers, or {@code null} if none.
- * @return Proposed value for {@code gml:id} attribute, or {@code null} if none.
+ * @param context the (un)marshalling context.
+ * @param object the object for which to get a {@code gml:id}.
+ * @param name the identified object name, or {@code null} if none.
+ * @param alias the identified object aliases, or {@code null} if none.
+ * @param identifiers the identifiers, or {@code null} if none.
+ * @return proposed value for {@code gml:id} attribute, or {@code null} if none.
*/
static String getID(final Context context, final IdentifiedObject object, final Identifier name,
final Collection extends GenericName> alias, final Collection extends Identifier> identifiers)
@@ -169,7 +169,7 @@ final class NameIterator implements Iter
return candidate;
}
}
- id.setLength(0); // Clear the buffer for another try.
+ id.setLength(0); // Clear the buffer for another try.
}
}
/*
@@ -191,7 +191,7 @@ final class NameIterator implements Iter
final int s = id.append('-').length();
int n = 0;
do {
- if (++n == 100) return null; // Arbitrary limit.
+ if (++n == 100) return null; // Arbitrary limit.
candidate = id.append(n).toString();
id.setLength(s);
} while (!Context.setObjectForID(context, object, candidate));
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NamedIdentifier.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NamedIdentifier.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NamedIdentifier.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NamedIdentifier.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -395,7 +395,7 @@ public class NamedIdentifier extends Imm
* as a concatenation of the specified {@code name} with {@code this}.
*
* @param scope The name to use as prefix.
- * @return A concatenation of the given scope with this name.
+ * @return a concatenation of the given scope with this name.
*/
@Override
public ScopedName push(final GenericName scope) {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/Properties.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/Properties.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/Properties.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/Properties.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -117,7 +117,7 @@ final class Properties extends AbstractM
* Returns the value to which this map maps the specified index.
* Returns null if the map contains no mapping for the given index.
*
- * @param key The property index, as one of the values in the {@link #INDICES} map.
+ * @param key the property index, as one of the values in the {@link #INDICES} map.
*/
final Object getAt(final int key) {
if ((excludeMask & (1 << key)) == 0) {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/PropertiesConverter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/PropertiesConverter.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/PropertiesConverter.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/PropertiesConverter.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -102,7 +102,7 @@ final class PropertiesConverter extends
return rename ? CODE_KEY : null;
}
if (key.startsWith(REMARKS_KEY)) {
- return null; // Instructs the map to exclude all remarks.
+ return null; // Instructs the map to exclude all remarks.
}
}
return key;
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/AbstractCRS.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/AbstractCRS.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/AbstractCRS.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/AbstractCRS.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -18,6 +18,7 @@ package org.apache.sis.referencing.crs;
import java.util.Map;
import java.util.EnumMap;
+import java.util.Objects;
import java.util.ConcurrentModificationException;
import javax.measure.Unit;
import javax.xml.bind.annotation.XmlType;
@@ -44,9 +45,6 @@ import static org.apache.sis.util.Utilit
import static org.apache.sis.util.ArgumentChecks.ensureNonNull;
import static org.apache.sis.internal.referencing.WKTUtilities.toFormattable;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* Coordinate reference system, defined by a {@linkplain AbstractCS coordinate system}
@@ -171,8 +169,8 @@ public class AbstractCRS extends Abstrac
*
*
*
- * @param properties The properties to be given to the coordinate reference system.
- * @param cs The coordinate system.
+ * @param properties The properties to be given to the coordinate reference system.
+ * @param cs the coordinate system.
*/
public AbstractCRS(final Map properties, final CoordinateSystem cs) {
super(properties);
@@ -187,7 +185,7 @@ public class AbstractCRS extends Abstrac
*
* This constructor performs a shallow copy, i.e. the properties are not cloned.
*
- * @param crs The coordinate reference system to copy.
+ * @param crs the coordinate reference system to copy.
*
* @see #castOrCopy(CoordinateReferenceSystem)
*/
@@ -222,8 +220,8 @@ public class AbstractCRS extends Abstrac
* 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 AbstractCRS castOrCopy(final CoordinateReferenceSystem object) {
@@ -235,7 +233,7 @@ public class AbstractCRS extends Abstrac
* The default implementation returns {@code CoordinateReferenceSystem.class}.
* Subclasses implementing a more specific GeoAPI interface shall override this method.
*
- * @return The coordinate reference system interface implemented by this class.
+ * @return the coordinate reference system interface implemented by this class.
*/
@Override
public Class extends CoordinateReferenceSystem> getInterface() {
@@ -251,18 +249,20 @@ public class AbstractCRS extends Abstrac
* Subclasses implementing {@code SingleCRS} (basically all SIS subclasses except {@link DefaultCompoundCRS})
* will override this method with public access and more specific return type.
*
- * @return The datum, or {@code null} if none.
+ * @return the datum, or {@code null} if none.
*/
Datum getDatum() {
- // User could provide his own CRS implementation outside this SIS package, so we have
- // to check for SingleCRS interface. But all SIS classes override this implementation.
+ /*
+ * User could provide his own CRS implementation outside this SIS package, so we have
+ * to check for SingleCRS interface. But all SIS classes override this implementation.
+ */
return (this instanceof SingleCRS) ? ((SingleCRS) this).getDatum() : null;
}
/**
* Returns the coordinate system.
*
- * @return The coordinate system.
+ * @return the coordinate system.
*/
@Override
public CoordinateSystem getCoordinateSystem() {
@@ -296,8 +296,8 @@ public class AbstractCRS extends Abstrac
/**
* Sets the CRS for the given axes convention.
*
- * @param crs The CRS to cache.
- * @return The cached CRS. May be different than the given {@code crs} if an existing instance has been found.
+ * @param crs the CRS to cache.
+ * @return the cached CRS. May be different than the given {@code crs} if an existing instance has been found.
*/
final AbstractCRS setCached(final AxesConvention convention, AbstractCRS crs) {
assert Thread.holdsLock(this);
@@ -312,7 +312,7 @@ public class AbstractCRS extends Abstrac
}
}
if (forConvention.put(convention, crs) != null) {
- throw new ConcurrentModificationException(); // Should never happen, unless we have a synchronization bug.
+ throw new ConcurrentModificationException(); // Should never happen, unless we have a synchronization bug.
}
return crs;
}
@@ -321,8 +321,8 @@ public class AbstractCRS extends Abstrac
* Returns a coordinate reference system equivalent to this one but with axes rearranged according the given
* convention. If this CRS is already compatible with the given convention, then this method returns {@code this}.
*
- * @param convention The axes convention for which a coordinate reference system is desired.
- * @return A coordinate reference system compatible with the given convention (may be {@code this}).
+ * @param convention the axes convention for which a coordinate reference system is desired.
+ * @return a coordinate reference system compatible with the given convention (may be {@code this}).
*
* @see AbstractCS#forConvention(AxesConvention)
*/
@@ -357,10 +357,10 @@ public class AbstractCRS extends Abstrac
* compared including the {@linkplain #getDomainOfValidity() domain of validity} and
* the {@linkplain #getScope() scope}.
*
- * @param object The object to compare to {@code this}.
- * @param mode {@link ComparisonMode#STRICT STRICT} for performing a strict comparison, or
- * {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for comparing only properties
- * relevant to coordinate transformations.
+ * @param object the object to compare to {@code this}.
+ * @param mode {@link ComparisonMode#STRICT STRICT} for performing a strict comparison, or
+ * {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for comparing only
+ * properties relevant to coordinate transformations.
* @return {@code true} if both objects are equal.
*/
@Override
@@ -387,7 +387,7 @@ public class AbstractCRS extends Abstrac
* See {@link org.apache.sis.referencing.AbstractIdentifiedObject#computeHashCode()}
* for more information.
*
- * @return The hash code value. This value may change in any future Apache SIS version.
+ * @return the hash code value. This value may change in any future Apache SIS version.
*/
@Override
protected long computeHashCode() {
@@ -457,10 +457,10 @@ public class AbstractCRS extends Abstrac
* Note: the {@code unit} and {@code isWKT1} arguments could be computed by this method,
* but are requested in order to avoid computing them twice, because the caller usually have them anyway.
*
- * @param formatter The formatter where to append the coordinate system.
- * @param cs The coordinate system to append.
- * @param unit The value of {@code ReferencingUtilities.getUnit(cs)}.
- * @param isWKT1 {@code true} if formatting WKT 1, or {@code false} for WKT 2.
+ * @param formatter the formatter where to append the coordinate system.
+ * @param cs the coordinate system to append.
+ * @param unit the value of {@code ReferencingUtilities.getUnit(cs)}.
+ * @param isWKT1 { @code true} if formatting WKT 1, or {@code false} for WKT 2.
*/
final void formatCS(final Formatter formatter, final CoordinateSystem cs, final Unit> unit, final boolean isWKT1) {
assert unit == ReferencingUtilities.getUnit(cs) : unit;
@@ -468,17 +468,17 @@ public class AbstractCRS extends Abstrac
assert isWKT1 || !isBaseCRS(formatter) || formatter.getConvention() == Convention.INTERNAL; // Condition documented in javadoc.
final Unit> oldUnit = formatter.addContextualUnit(unit);
- if (isWKT1) { // WKT 1 writes unit before axes, while WKT 2 writes them after axes.
+ if (isWKT1) { // WKT 1 writes unit before axes, while WKT 2 writes them after axes.
formatter.append(unit);
if (unit == null) {
formatter.setInvalidWKT(this, null);
}
} else {
- formatter.append(toFormattable(cs)); // WKT2 only, since the concept of CoordinateSystem was not explicit in WKT 1.
+ formatter.append(toFormattable(cs)); // WKT2 only, since the concept of CoordinateSystem was not explicit in WKT 1.
formatter.indent(+1);
}
if (!isWKT1 || formatter.getConvention() != Convention.WKT1_IGNORE_AXES) {
- if (cs != null) { // Should never be null, except sometime temporarily during construction.
+ if (cs != null) { // Should never be null, except sometime temporarily during construction.
final int dimension = cs.getDimension();
for (int i=0; i The conversion type, either {@code Conversion} or {@code Projection}.
+ * @param the conversion type, either {@code Conversion} or {@code Projection}.
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @since 0.6
@@ -87,11 +87,11 @@ abstract class AbstractDerivedCRSThis constructor performs a shallow copy, i.e. the properties are not cloned.
*
- * @param crs The coordinate reference system to copy.
+ * @param crs the coordinate reference system to copy.
*/
AbstractDerivedCRS(final GeneralDerivedCRS crs) {
super(crs);
@@ -190,7 +190,7 @@ abstract class AbstractDerivedCRS
*
- * @param name The property name, used only in case of error message to format.
- * @throws IllegalStateException If the base CRS can not be set.
+ * @param name the property name, used only in case of error message to format.
+ * @throws IllegalStateException if the base CRS can not be set.
*/
@SuppressWarnings("unchecked")
final void setBaseCRS(final String name, final SingleCRS baseCRS) {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/ConversionKeys.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/ConversionKeys.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/ConversionKeys.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/ConversionKeys.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -59,8 +59,8 @@ final class ConversionKeys implements Ob
/**
* Provides a map without the {@code "conversion."} prefix in the keys.
*
- * @param Type of values in the map.
- * @param properties The user-supplied properties.
+ * @param type of values in the map.
+ * @param properties the user-supplied properties.
*/
@SuppressWarnings("unchecked")
static Map unprefix(final Map properties) {
@@ -101,8 +101,8 @@ final class ConversionKeys implements Ob
* Adds or removes the prefix from the specified key.
* In the removal case if the key does not begin with the prefix, then this method returns {@code null}.
*
- * @param key A key from the user-supplied properties map.
- * @return The key to show in the derived map.
+ * @param key a key from the user-supplied properties map.
+ * @return the key to show in the derived map.
*/
@Override
public String apply(final String key) {
Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultCompoundCRS.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultCompoundCRS.java?rev=1779702&r1=1779701&r2=1779702&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultCompoundCRS.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultCompoundCRS.java [UTF-8] Sat Jan 21 08:49:49 2017
@@ -181,8 +181,8 @@ public class DefaultCompoundCRS extends
*
*
*
- * @param properties The properties to be given to the coordinate reference system.
- * @param components The sequence of coordinate reference systems making this compound CRS.
+ * @param properties the properties to be given to the coordinate reference system.
+ * @param components the sequence of coordinate reference systems making this compound CRS.
*
* @see org.apache.sis.referencing.factory.GeodeticObjectFactory#createCompoundCRS(Map, CoordinateReferenceSystem...)
*/
@@ -195,9 +195,9 @@ public class DefaultCompoundCRS extends
/**
* Returns a compound coordinate system for the specified array of CRS objects.
*
- * @param properties The properties given to the constructor, or {@code null} if unknown.
- * @param components The CRS components, usually singles but not necessarily.
- * @return The coordinate system for the given components.
+ * @param properties the properties given to the constructor, or {@code null} if unknown.
+ * @param components the CRS components, usually singles but not necessarily.
+ * @return the coordinate system for the given components.
*/
private static CoordinateSystem createCoordinateSystem(final Map properties,
final CoordinateReferenceSystem[] components)
@@ -223,7 +223,7 @@ public class DefaultCompoundCRS extends
*
* This constructor performs a shallow copy, i.e. the properties are not cloned.
*
- * @param crs The coordinate reference system to copy.
+ * @param crs the coordinate reference system to copy.
*/
protected DefaultCompoundCRS(final CompoundCRS crs) {
super(crs);
@@ -242,8 +242,8 @@ public class DefaultCompoundCRS extends
* Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged.
* Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.
*
- * @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 DefaultCompoundCRS castOrCopy(final CompoundCRS object) {
@@ -281,10 +281,10 @@ public class DefaultCompoundCRS extends
* This list may contains other {@code CompoundCRS} instances, as described in class Javadoc.
* For a flattened list of {@link SingleCRS} instances, see {@link #getSingleComponents()}.
*
- * @return The coordinate reference systems as an unmodifiable list.
+ * @return the coordinate reference systems as an unmodifiable list.
*/
@Override
- @SuppressWarnings("unchecked") // We are safe if the list is read-only.
+ @SuppressWarnings("unchecked") // We are safe if the list is read-only.
public List getComponents() {
return (List) components;
}
@@ -298,7 +298,7 @@ public class DefaultCompoundCRS extends
@SuppressWarnings("SuspiciousToArrayCall")
private void setComponents(final List extends CoordinateReferenceSystem> crs) {
if (setSingleComponents(crs)) {
- components = singles; // Shares the same list.
+ components = singles; // Shares the same list.
} else {
components = UnmodifiableArrayList.wrap(crs.toArray(new CoordinateReferenceSystem[crs.size()]));
}
@@ -309,7 +309,7 @@ public class DefaultCompoundCRS extends
* other compound CRS, then all of them are flattened in a sequence of {@code SingleCRS} objects.
* See class Javadoc for more information.
*
- * @return The single coordinate reference systems as an unmodifiable list.
+ * @return the single coordinate reference systems as an unmodifiable list.
*
* @see org.apache.sis.referencing.CRS#getSingleComponents(CoordinateReferenceSystem)
*/
@@ -337,9 +337,9 @@ public class DefaultCompoundCRS extends
/**
* Computes the single CRS list on deserialization.
*
- * @param in The input stream from which to deserialize a compound CRS.
- * @throws IOException If an I/O error occurred while reading or if the stream contains invalid data.
- * @throws ClassNotFoundException If the class serialized on the stream is not on the classpath.
+ * @param in the input stream from which to deserialize a compound CRS.
+ * @throws IOException if an I/O error occurred while reading or if the stream contains invalid data.
+ * @throws ClassNotFoundException if the class serialized on the stream is not on the classpath.
*/
@SuppressWarnings("unchecked")
private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
@@ -455,7 +455,7 @@ public class DefaultCompoundCRS extends
}
if (changed) {
if (reorderCRS) {
- Arrays.sort(newComponents, SubTypes.BY_TYPE); // This array typically has less than 4 elements.
+ Arrays.sort(newComponents, SubTypes.BY_TYPE); // This array typically has less than 4 elements.
}
crs = new DefaultCompoundCRS(IdentifiedObjects.getProperties(this, IDENTIFIERS_KEY), newComponents);
}
@@ -475,16 +475,16 @@ public class DefaultCompoundCRS extends
/**
* Compares this coordinate reference system with the specified object for equality.
*
- * @param object The object to compare to {@code this}.
- * @param mode {@link ComparisonMode#STRICT STRICT} for performing a strict comparison, or
- * {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for comparing only properties
- * relevant to transformations.
+ * @param object the object to compare to {@code this}.
+ * @param mode {@link ComparisonMode#STRICT STRICT} for performing a strict comparison, or
+ * {@link ComparisonMode#IGNORE_METADATA IGNORE_METADATA} for comparing only
+ * properties relevant to transformations.
* @return {@code true} if both objects are equal.
*/
@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)) {
switch (mode) {