This is an automated email from the ASF dual-hosted git repository. desruisseaux pushed a commit to branch geoapi-4.0 in repository https://gitbox.apache.org/repos/asf/sis.git
commit 525142f364fc07f086e2b48f41a32dbe6b216a98 Author: Martin Desruisseaux <martin.desruisse...@geomatys.com> AuthorDate: Sun Sep 4 12:30:46 2022 +0200 Add a few `SuppressWarnings("serial")` annotations for fields that are not statically typed as Serializable. Documentation fixes. --- .../apache/sis/internal/jaxb/referencing/CC_OperationMethod.java | 2 +- .../java/org/apache/sis/parameter/DefaultParameterDescriptor.java | 6 +++++- .../org/apache/sis/parameter/DefaultParameterDescriptorGroup.java | 1 + .../main/java/org/apache/sis/parameter/DefaultParameterValue.java | 3 +++ .../src/main/java/org/apache/sis/parameter/ParameterFormat.java | 1 + .../src/main/java/org/apache/sis/parameter/ParameterValueList.java | 2 ++ .../src/main/java/org/apache/sis/parameter/TensorParameters.java | 1 + .../src/main/java/org/apache/sis/parameter/TensorValues.java | 2 ++ .../main/java/org/apache/sis/parameter/UninitializedParameter.java | 1 + .../org/apache/sis/parameter/UnmodifiableParameterValueGroup.java | 2 ++ .../sis/referencing/operation/AbstractCoordinateOperation.java | 7 +++++++ .../apache/sis/referencing/operation/AbstractSingleOperation.java | 4 ++++ .../sis/referencing/operation/CoordinateOperationContext.java | 1 + .../sis/referencing/operation/DefaultConcatenatedOperation.java | 1 + .../java/org/apache/sis/referencing/operation/DefaultFormula.java | 2 ++ .../apache/sis/referencing/operation/DefaultOperationMethod.java | 2 ++ .../sis/referencing/operation/DefaultPassThroughOperation.java | 1 + .../apache/sis/referencing/operation/InverseOperationMethod.java | 1 + 18 files changed, 38 insertions(+), 2 deletions(-) diff --git a/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationMethod.java b/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationMethod.java index 5ec514fad8..d1e7624a34 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationMethod.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/internal/jaxb/referencing/CC_OperationMethod.java @@ -204,7 +204,7 @@ public final class CC_OperationMethod extends PropertyType<CC_OperationMethod, O /** * Stores the given {@code parameters} into the given {@code addTo} collection. - * This method copies only the <em>references</em> if possible. However is some + * This method copies only the <em>references</em> if possible. However in some * cases the values may need to be copied in new parameter instances. * * <div class="note"><b>Note:</b> diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptor.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptor.java index 2d65a27033..da4b0e09fa 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptor.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptor.java @@ -96,6 +96,7 @@ public class DefaultParameterDescriptor<T> extends AbstractParameterDescriptor i * * @see #getValidValues() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final Set<T> validValues; /** @@ -118,6 +119,7 @@ public class DefaultParameterDescriptor<T> extends AbstractParameterDescriptor i * * @see #getDefaultValue() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final T defaultValue; /** @@ -451,7 +453,9 @@ public class DefaultParameterDescriptor<T> extends AbstractParameterDescriptor i * All other properties (minimum and maximum occurrences, minimum, maximum and valid values) * are compared only for modes stricter than {@link ComparisonMode#IGNORE_METADATA}. * - * @return {@inheritDoc} + * @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) { diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptorGroup.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptorGroup.java index e56aaad424..99b5fe7bec 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptorGroup.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterDescriptorGroup.java @@ -109,6 +109,7 @@ public class DefaultParameterDescriptorGroup extends AbstractParameterDescriptor * * @see #descriptors() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private List<GeneralParameterDescriptor> descriptors; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValue.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValue.java index ed8282e550..3317063778 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValue.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValue.java @@ -149,6 +149,7 @@ public class DefaultParameterValue<T> extends FormattableObject implements Param * * @see #getDescriptor() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private ParameterDescriptor<T> descriptor; /** @@ -158,6 +159,7 @@ public class DefaultParameterValue<T> extends FormattableObject implements Param * * @since 0.7 */ + @SuppressWarnings("serial") // Not statically typed as Serializable. protected T value; /** @@ -167,6 +169,7 @@ public class DefaultParameterValue<T> extends FormattableObject implements Param * * @since 0.7 */ + @SuppressWarnings("serial") // Not statically typed as Serializable. protected Unit<?> unit; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java index 1f5b3b8b2d..b6193e11b5 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterFormat.java @@ -252,6 +252,7 @@ public class ParameterFormat extends TabularFormat<Object> { * * @see #getPreferredCodespaces() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private Set<String> preferredCodespaces; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java index 04b2a40ec9..e003cdb909 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/ParameterValueList.java @@ -66,12 +66,14 @@ final class ParameterValueList extends AbstractList<GeneralParameterValue> imple * <p>This descriptor shall not be used in {@link #equals(Object)} and {@link #hashCode()} * implementations in order to stay consistent with the {@link List} contract.</p> */ + @SuppressWarnings("serial") // Not statically typed as Serializable. final ParameterDescriptorGroup descriptor; /** * The parameter values in the group. The length of this array is the list capacity. * This array will growth as needed. */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private GeneralParameterValue[] values; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java index 761c47afa3..8c7ffdae49 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorParameters.java @@ -279,6 +279,7 @@ public class TensorParameters<E> implements Serializable { * * <p>The length of this array determine the tensor {@linkplain #rank() rank}.</p> */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final ParameterDescriptor<Integer>[] dimensions; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorValues.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorValues.java index d94a77df98..11b1e2eb86 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorValues.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/TensorValues.java @@ -82,6 +82,7 @@ final class TensorValues<E> extends AbstractParameterDescriptor /** * The parameter for the number of row, columns and other dimensions in the tensor. */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final ParameterValue<Integer>[] dimensions; /** @@ -91,6 +92,7 @@ final class TensorValues<E> extends AbstractParameterDescriptor * <p>Will be constructed only when first requested. * May be resized at any moment if a {@link #dimensions} parameter value change.</p> */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private Object[] values; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/UninitializedParameter.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/UninitializedParameter.java index 5426e33e6b..19fa9c349d 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/UninitializedParameter.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/UninitializedParameter.java @@ -43,6 +43,7 @@ final class UninitializedParameter implements GeneralParameterValue, Serializabl /** * The descriptor of the parameter to initialize. */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final GeneralParameterDescriptor descriptor; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValueGroup.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValueGroup.java index 155060f93c..f3e7b7c0f0 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValueGroup.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/UnmodifiableParameterValueGroup.java @@ -59,6 +59,7 @@ final class UnmodifiableParameterValueGroup extends Parameters implements Lenien * * @see #getDescriptor() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final ParameterDescriptorGroup descriptor; /** @@ -66,6 +67,7 @@ final class UnmodifiableParameterValueGroup extends Parameters implements Lenien * * @see #values() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final List<GeneralParameterValue> values; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java index dd552661ae..b93fb86c0b 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractCoordinateOperation.java @@ -139,6 +139,7 @@ public class AbstractCoordinateOperation extends AbstractIdentifiedObject implem * * @see #getSourceCRS() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. CoordinateReferenceSystem sourceCRS; /** @@ -150,6 +151,7 @@ public class AbstractCoordinateOperation extends AbstractIdentifiedObject implem * * @see #getTargetCRS() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. CoordinateReferenceSystem targetCRS; /** @@ -161,6 +163,7 @@ public class AbstractCoordinateOperation extends AbstractIdentifiedObject implem * * @see #getInterpolationCRS() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private CoordinateReferenceSystem interpolationCRS; /** @@ -183,6 +186,7 @@ public class AbstractCoordinateOperation extends AbstractIdentifiedObject implem * * @see #getCoordinateOperationAccuracy() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. Collection<PositionalAccuracy> coordinateOperationAccuracy; /** @@ -194,6 +198,7 @@ public class AbstractCoordinateOperation extends AbstractIdentifiedObject implem * * @see #getDomainOfValidity() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. Extent domainOfValidity; /** @@ -204,6 +209,7 @@ public class AbstractCoordinateOperation extends AbstractIdentifiedObject implem * * @see #getScope() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private InternationalString scope; /** @@ -214,6 +220,7 @@ public class AbstractCoordinateOperation extends AbstractIdentifiedObject implem * This field is non-final only for the convenience of constructors and for initialization * at XML unmarshalling time by {@link AbstractSingleOperation#afterUnmarshal(Unmarshaller, Object)}.</p> */ + @SuppressWarnings("serial") // Not statically typed as Serializable. MathTransform transform; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java index cd6eacb495..d9f95c1eda 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/AbstractSingleOperation.java @@ -91,6 +91,7 @@ class AbstractSingleOperation extends AbstractCoordinateOperation implements Sin * * @see #getMethod() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private OperationMethod method; /** @@ -99,7 +100,10 @@ class AbstractSingleOperation extends AbstractCoordinateOperation implements Sin * <p><b>Consider this field as final!</b> * This field is non-final only for the convenience of constructors and for initialization * at XML unmarshalling time by {@link #setParameters(GeneralParameterValue[])}.</p> + * + * @see #getParameterValues() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. ParameterValueGroup parameters; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/CoordinateOperationContext.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/CoordinateOperationContext.java index becdf84900..c30a9b6a91 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/CoordinateOperationContext.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/CoordinateOperationContext.java @@ -75,6 +75,7 @@ public class CoordinateOperationContext implements Serializable { * The spatiotemporal area of interest, or {@code null} if none. This instance may be updated or * replaced by other methods in this class, or (indirectly) by {@link CoordinateOperationFinder}. */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private Extent areaOfInterest; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConcatenatedOperation.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConcatenatedOperation.java index 3899107050..ea8e168769 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConcatenatedOperation.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultConcatenatedOperation.java @@ -72,6 +72,7 @@ final class DefaultConcatenatedOperation extends AbstractCoordinateOperation imp * <p><b>Consider this field as final!</b> * This field is modified only at unmarshalling time by {@link #setSteps(CoordinateOperation[])}</p> */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private List<? extends CoordinateOperation> operations; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultFormula.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultFormula.java index c1b2b0dbbc..d97fa95598 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultFormula.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultFormula.java @@ -58,11 +58,13 @@ public class DefaultFormula extends FormattableObject implements Formula, Serial /** * Formula(s) or procedure used by the operation method. */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final InternationalString formula; /** * Reference to a publication giving the formula(s) or procedure used by the coordinate operation method. */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final Citation citation; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultOperationMethod.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultOperationMethod.java index 91cd41bcbd..c3ff5bc8a5 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultOperationMethod.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultOperationMethod.java @@ -155,6 +155,7 @@ public class DefaultOperationMethod extends AbstractIdentifiedObject implements * This field is modified only at unmarshalling time by {@link #setFormulaCitation(Citation)} * or {@link #setFormulaDescription(String)}.</p> */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private Formula formula; /** @@ -193,6 +194,7 @@ public class DefaultOperationMethod extends AbstractIdentifiedObject implements * <p><b>Consider this field as final!</b> * This field is modified only at unmarshalling time by {@link #setDescriptors(GeneralParameterDescriptor[])}</p> */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private ParameterDescriptorGroup parameters; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultPassThroughOperation.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultPassThroughOperation.java index 717129ada8..06ace2ca1f 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultPassThroughOperation.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/DefaultPassThroughOperation.java @@ -68,6 +68,7 @@ public class DefaultPassThroughOperation extends AbstractCoordinateOperation imp * * @see #getOperation() */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private CoordinateOperation operation; /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/InverseOperationMethod.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/InverseOperationMethod.java index be5d015204..a0ec4a94bb 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/InverseOperationMethod.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/InverseOperationMethod.java @@ -60,6 +60,7 @@ final class InverseOperationMethod extends DefaultOperationMethod { /** * The original operation method for which this {@code InverseOperationMethod} is the inverse. */ + @SuppressWarnings("serial") // Not statically typed as Serializable. private final OperationMethod inverse; /**