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
The following commit(s) were added to refs/heads/geoapi-4.0 by this push: new 3c40a1f Javadoc fix: "condition is meet" -> "condition is met" and varia. 3c40a1f is described below commit 3c40a1f87d86fbed2044e2d5f3a813efc3ea580a Author: Martin Desruisseaux <martin.desruisse...@geomatys.com> AuthorDate: Wed Oct 10 15:14:49 2018 +0200 Javadoc fix: "condition is meet" -> "condition is met" and varia. --- .../main/java/org/apache/sis/util/iso/Names.java | 2 ++ .../org/apache/sis/geometry/ArrayEnvelope.java | 2 +- .../org/apache/sis/geometry/DirectPosition2D.java | 2 +- .../java/org/apache/sis/geometry/Shapes2D.java | 2 +- .../internal/referencing/j2d/ShapeUtilities.java | 2 +- .../sis/parameter/DefaultParameterValueGroup.java | 2 +- .../java/org/apache/sis/referencing/Builder.java | 4 +-- .../sis/referencing/StandardDefinitions.java | 2 +- .../sis/referencing/crs/DefaultDerivedCRS.java | 2 +- .../sis/referencing/datum/BursaWolfParameters.java | 2 +- .../factory/LazySynchronizedIterator.java | 2 +- .../factory/MultiAuthoritiesFactory.java | 4 +-- .../sis/referencing/operation/matrix/Matrices.java | 2 +- .../referencing/operation/matrix/MatrixSIS.java | 2 +- .../sis/referencing/operation/matrix/Solver.java | 2 +- .../transform/AbstractLinearTransform.java | 2 +- .../operation/transform/AbstractMathTransform.java | 2 +- .../operation/transform/MathTransforms.java | 2 +- .../operation/transform/TransformSeparator.java | 4 +-- .../sis/internal/converter/FallbackConverter.java | 2 +- .../java/org/apache/sis/math/DecimalFunctions.java | 6 ++-- .../main/java/org/apache/sis/measure/Range.java | 2 +- .../java/org/apache/sis/util/ObjectConverter.java | 2 +- .../util/UnsupportedImplementationException.java | 2 +- .../java/org/apache/sis/util/collection/Cache.java | 2 +- .../java/org/apache/sis/test/TestUtilities.java | 2 +- .../main/java/org/apache/sis/storage/Resource.java | 32 ++++++++++------------ 27 files changed, 47 insertions(+), 47 deletions(-) diff --git a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/Names.java b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/Names.java index f381c38..78f8acb 100644 --- a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/Names.java +++ b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/Names.java @@ -130,6 +130,8 @@ public final class Names extends Static { /** * Creates a local or scoped name from an array of parsed names. This method returns a local name if the * length of the {@code parsedNames} array is 1, or a scoped named if the length of the array is 2 or more. + * The first {@code parsedNames} element will be the {@linkplain AbstractName#head() head} + * and the last {@code parsedNames} element will be the {@link AbstractName#tip() tip}. * * @param namespace the namespace, or {@code null} for the global namespace. * @param separator the separator between the namespace and the generic name, or {@code null} diff --git a/core/sis-referencing/src/main/java/org/apache/sis/geometry/ArrayEnvelope.java b/core/sis-referencing/src/main/java/org/apache/sis/geometry/ArrayEnvelope.java index 7104388..e5beb1e 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/geometry/ArrayEnvelope.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/geometry/ArrayEnvelope.java @@ -332,7 +332,7 @@ scanNumber: while ((i += Character.charCount(c)) < length) { * This method does <strong>not</strong> verify if the ordinate values are between the axis minimum and * maximum values. This is because out-of-range values exist in practice but do not impact the working * of {@code add(…)}, {@code intersect(…)}, {@code contains(…)} and similar methods. This in contrast - * with the checks listed above, where failure to meet those conditions will cause the methods to + * with the checks listed above, where failure to met those conditions will cause the methods to * behave in an unexpected way. * * <div class="section">Implementation consistency</div> diff --git a/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java b/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java index 8926f70..c3ed407 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/geometry/DirectPosition2D.java @@ -49,7 +49,7 @@ import static org.apache.sis.util.ArgumentChecks.ensureDimensionMatches; * <div class="section">Caution when used in collections</div> * Do not mix instances of this class with ordinary {@link Point2D} instances * in a {@code HashSet} or as {@code HashMap} keys. - * It is not possible to meet both {@link Point2D#hashCode()} and {@link DirectPosition#hashCode()} + * It is not possible to met both {@link Point2D#hashCode()} and {@link DirectPosition#hashCode()} * contracts, and this class chooses to implements the later. Consequently, the {@link #hashCode()} * method of this class is inconsistent with {@link Point2D#equals(Object)} but is consistent with * {@link DirectPosition#equals(Object)}. diff --git a/core/sis-referencing/src/main/java/org/apache/sis/geometry/Shapes2D.java b/core/sis-referencing/src/main/java/org/apache/sis/geometry/Shapes2D.java index 8ae2584..87baccb 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/geometry/Shapes2D.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/geometry/Shapes2D.java @@ -114,7 +114,7 @@ public final class Shapes2D extends Static { * </ul> * * If no result point meets those conditions, then this method returns {@code null}. - * If two result points meet those conditions, then this method returns the point + * If two result points met those conditions, then this method returns the point * which is the closest to {@code line.getP1()}. * * @param line the line on which to search for a point. diff --git a/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/ShapeUtilities.java b/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/ShapeUtilities.java index fc87c1e..6478f98 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/ShapeUtilities.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/j2d/ShapeUtilities.java @@ -161,7 +161,7 @@ public final class ShapeUtilities extends Static { * </ul> * * If no result point meets those conditions, then this method returns {@code null}. - * If two result points meet those conditions, then this method returns the point + * If two result points met those conditions, then this method returns the point * which is the closest to {@code line.getP1()}. * * @param x1 <var>x</var> value of the first point on the line. diff --git a/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValueGroup.java b/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValueGroup.java index 927b63c..2597fba 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValueGroup.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/parameter/DefaultParameterValueGroup.java @@ -199,7 +199,7 @@ public class DefaultParameterValueGroup extends Parameters implements LenientCom * * The list will verify those conditions and throws {@link org.opengis.parameter.InvalidParameterNameException}, * {@link org.opengis.parameter.InvalidParameterCardinalityException} or other runtime exceptions if a condition - * is not meet. + * is not met. * * @return the values in this group. */ diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/Builder.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/Builder.java index 3509fda..ccb9fea 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/Builder.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/Builder.java @@ -730,7 +730,7 @@ public abstract class Builder<B extends Builder<B>> { * with the same authority and the local part defined by {@code replacements[0]}.</li> * <li>The second occurrence of a name associated to {@code authority} will be replaced by a new name * with the same authority and the local part defined by {@code replacements[1]}.</li> - * <li><i>etc.</i> until one of the following conditions is meet: + * <li><i>etc.</i> until one of the following conditions is met: * <ul> * <li>There is no more name associated to the given authority in this {@code Builder}, in which case * new names are inserted for all remaining elements in the {@code replacements} array.</li> @@ -829,7 +829,7 @@ public abstract class Builder<B extends Builder<B>> { * a new identifier with the same authority and the code defined by {@code replacements[0]}.</li> * <li>The second occurrence of an identifier associated to {@code authority} will be replaced by a * new identifier with the same authority and the local part defined by {@code replacements[1]}.</li> - * <li><i>etc.</i> until one of the following conditions is meet: + * <li><i>etc.</i> until one of the following conditions is met: * <ul> * <li>There is no more identifier associated to the given authority in this {@code Builder}, in which case * new identifiers are inserted for all remaining elements in the {@code replacements} array.</li> diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/StandardDefinitions.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/StandardDefinitions.java index db365ae..e55c93f 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/StandardDefinitions.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/StandardDefinitions.java @@ -131,7 +131,7 @@ final class StandardDefinitions { /** * Creates a Universal Transverse Mercator (UTM) or a Universal Polar Stereographic (UPS) projected CRS * using the Apache SIS factory implementation. This method restricts the factory to SIS implementation - * instead than arbitrary factory in order to meet the contract saying that {@link CommonCRS} methods + * instead than arbitrary factory in order to met the contract saying that {@link CommonCRS} methods * should never fail. * * @param code the EPSG code, or 0 if none. diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultDerivedCRS.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultDerivedCRS.java index a00f7ec..afeb4fe 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultDerivedCRS.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/crs/DefaultDerivedCRS.java @@ -73,7 +73,7 @@ import org.opengis.referencing.datum.ParametricDatum; * (for example in order to use a {@linkplain org.apache.sis.referencing.cs.DefaultPolarCS polar coordinate system}). * * <p>A {@code DerivedCRS} instance may also implement one of the interfaces listed below, - * provided that the conditions in the right column are meet (derived from ISO 19162):</p> + * provided that the conditions in the right column are met (derived from ISO 19162):</p> * * <table class="sis"> * <caption>Derived CRS types</caption> diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java index acc99ae..423f944 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/datum/BursaWolfParameters.java @@ -520,7 +520,7 @@ public class BursaWolfParameters extends FormattableObject implements Cloneable, * * @param matrix the matrix from which to get Bursa-Wolf parameters. * @param tolerance the tolerance error for the skew-symmetric matrix test, in units of PPM or arc-seconds (e.g. 1E-8). - * @throws IllegalArgumentException if the specified matrix does not meet the conditions. + * @throws IllegalArgumentException if the specified matrix does not met the conditions. * * @see #getPositionVectorTransformation(Date) */ diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/LazySynchronizedIterator.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/LazySynchronizedIterator.java index a9421a8..e4c7bae 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/LazySynchronizedIterator.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/LazySynchronizedIterator.java @@ -25,7 +25,7 @@ import org.apache.sis.internal.util.AbstractIterator; * All uses of an {@code Iterable<E>} (including its iterator) is synchronized on that {@code Iterable} instance. * * <p>Note that despite the above-cited synchronization, this iterator is <strong>not</strong> thread-safe: - * each thread needs to use its own iterator instance. However provided that the above condition is meet, + * each thread needs to use its own iterator instance. However provided that the above condition is met, * different threads can safely use their iterators concurrently even if the underlying {@code Iterable}s * were not thread-safe, because of the synchronization on {@code Iterable<E>} instances.</p> * diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/MultiAuthoritiesFactory.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/MultiAuthoritiesFactory.java index 27dfec0..e19fe4c 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/MultiAuthoritiesFactory.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/factory/MultiAuthoritiesFactory.java @@ -556,10 +556,10 @@ public class MultiAuthoritiesFactory extends GeodeticAuthorityFactory implements * <p>This iterator takes care of synchronization on the {@code Iterable<AuthorityFactory>} instances. * Note that despite the above-cited synchronization, the returned iterator is <strong>not</strong> * thread-safe: each thread needs to use its own iterator instance. However provided that the above - * condition is meet, threads can safely use their iterators concurrently.</p> + * condition is met, threads can safely use their iterators concurrently.</p> */ final Iterator<AuthorityFactory> getAllFactories() { - return new LazySynchronizedIterator<AuthorityFactory>(providers); + return new LazySynchronizedIterator<>(providers); } /** diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrices.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrices.java index c67e233..5fb909b 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrices.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Matrices.java @@ -1008,7 +1008,7 @@ public final class Matrices extends Static { /** * Compares the given matrices for equality, using the given comparison strictness level. - * To be considered equal, the two matrices must meet the following conditions, which depend + * To be considered equal, the two matrices must met the following conditions, which depend * on the {@code mode} argument: * * <ul> diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/MatrixSIS.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/MatrixSIS.java index c402fe7..32000e5 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/MatrixSIS.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/MatrixSIS.java @@ -755,7 +755,7 @@ public abstract class MatrixSIS implements Matrix, LenientComparable, Cloneable, /** * Compares this matrix with the given object for equality. To be considered equal, the two - * objects must meet the following conditions, which depend on the {@code mode} argument: + * objects must met the following conditions, which depend on the {@code mode} argument: * * <ul> * <li>{@link ComparisonMode#STRICT STRICT}: diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Solver.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Solver.java index 5c39455..249ee0b 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Solver.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/matrix/Solver.java @@ -186,7 +186,7 @@ final class Solver implements Matrix { // Not Cloneable final double[] LU = GeneralMatrix.getExtendedElements(X, size, size, noChange); final int lastRowOrColumn = size - 1; /* - * indexOfNaN array will be created only if at least one NaN value is found, and those NaN meet + * indexOfNaN array will be created only if at least one NaN value is found, and those NaN met * the conditions documented in the code below. In such case, the array will contain a sequence * of (i,j,s) where (i,j) are the indices where the NaN value has been found and s is the column * of the scale factor. diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractLinearTransform.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractLinearTransform.java index cfc692b..62b2166 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractLinearTransform.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractLinearTransform.java @@ -238,7 +238,7 @@ abstract class AbstractLinearTransform extends AbstractMathTransform implements /** * Compares the specified object with this linear transform for equality. - * This implementation returns {@code true} if the following conditions are meet: + * This implementation returns {@code true} if the following conditions are met: * <ul> * <li>In {@code STRICT} mode, the objects are of the same class and {@link #equalsSameClass(Object)} * returns {@code true}.</li> diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform.java index f821a13..e4e292d 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/AbstractMathTransform.java @@ -884,7 +884,7 @@ public abstract class AbstractMathTransform extends FormattableObject * equal or {@linkplain ComparisonMode#APPROXIMATIVE approximately} equal. * This method may conservatively returns {@code false} if unsure. * - * <p>The default implementation returns {@code true} if the following conditions are meet:</p> + * <p>The default implementation returns {@code true} if the following conditions are met:</p> * <ul> * <li>{@code object} is an instance of the same class than {@code this}. We require the * same class because there is no interface for the various kinds of transform.</li> diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/MathTransforms.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/MathTransforms.java index bd6bfb1..3845904 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/MathTransforms.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/MathTransforms.java @@ -205,7 +205,7 @@ public final class MathTransforms extends Static { * @param global the transform to use globally where there is no suitable specialization. * @param specializations more accurate transforms available in some sub-areas. * @return a transform applying the given global transform except in sub-areas where specializations are available. - * @throws IllegalArgumentException if a constraint is not meet. + * @throws IllegalArgumentException if a constraint is not met. * * @since 1.0 */ diff --git a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/TransformSeparator.java b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/TransformSeparator.java index 1186eb4..8a7d051 100644 --- a/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/TransformSeparator.java +++ b/core/sis-referencing/src/main/java/org/apache/sis/referencing/operation/transform/TransformSeparator.java @@ -162,7 +162,7 @@ public class TransformSeparator { * @param sequence the {@link #sourceDimensions} or {@link #targetDimensions} sequence to update. * @param dimensions the user-supplied dimensions to add to the given sequence. * @param max the maximal value allowed, exclusive. - * @throws IllegalArgumentException if a {@code dimensions} value does not meet the conditions. + * @throws IllegalArgumentException if a {@code dimensions} value does not met the conditions. */ private static int[] add(int[] sequence, final int[] dimensions, final int max) throws IllegalArgumentException { int offset = 0; @@ -196,7 +196,7 @@ public class TransformSeparator { * @param lower the lower value of the range to add, inclusive. * @param upper the upper value of the range to add, exclusive. * @param max the maximal value allowed, exclusive. - * @throws IllegalArgumentException if the {@code lower} or {@code upper} value does not meet the conditions. + * @throws IllegalArgumentException if the {@code lower} or {@code upper} value does not met the conditions. */ private static int[] add(int[] sequence, final int lower, final int upper, final int max) throws IllegalArgumentException { if (lower < 0 || lower > upper) { diff --git a/core/sis-utility/src/main/java/org/apache/sis/internal/converter/FallbackConverter.java b/core/sis-utility/src/main/java/org/apache/sis/internal/converter/FallbackConverter.java index 29f16d2..9e23225 100644 --- a/core/sis-utility/src/main/java/org/apache/sis/internal/converter/FallbackConverter.java +++ b/core/sis-utility/src/main/java/org/apache/sis/internal/converter/FallbackConverter.java @@ -81,7 +81,7 @@ final class FallbackConverter<S,T> extends SystemConverter<S,T> { /** * Creates a converter using the given primary and fallback converters. This method may - * interchange the two converters in order to meet the {@linkplain #fallback} contract. + * interchange the two converters in order to met the {@linkplain #fallback} contract. * * @param sourceClass the {@linkplain #getSourceClass() source class}. * @param targetClass the {@linkplain #getTargetClass() target class}. diff --git a/core/sis-utility/src/main/java/org/apache/sis/math/DecimalFunctions.java b/core/sis-utility/src/main/java/org/apache/sis/math/DecimalFunctions.java index 5f9b92f..74d3076 100644 --- a/core/sis-utility/src/main/java/org/apache/sis/math/DecimalFunctions.java +++ b/core/sis-utility/src/main/java/org/apache/sis/math/DecimalFunctions.java @@ -451,12 +451,12 @@ public final class DecimalFunctions extends Static { * the amount of digits after the decimal separator.</li> * <li>{@code fractionDigitsForValue(179.12499999999824, 3)} returns 11 because rounding the 3 last digits * (i.e. rounding after the 11<sup>th</sup> digit) results in 179.125000000000. - * Since the 4 last fraction digits are zero, the condition for allowing that rounding is meet.</li> + * Since the 4 last fraction digits are zero, the condition for allowing that rounding is met.</li> * <li>{@code fractionDigitsForValue(179.12499999999824, 2)} returns 14 because rounding the 2 last digits * (i.e. rounding after the 12<sup>th</sup> digit) results in 179.124999999998. - * The condition for 4 trailing zero fraction digits is not meet.</li> + * The condition for 4 trailing zero fraction digits is not met.</li> * <li>{@code fractionDigitsForValue(179.12499997999999, 3)} returns 14 because rounding the 3 last digits - * results in 179.12499997000. The condition for 4 trailing zero fraction digits is not meet.</li> + * results in 179.12499997000. The condition for 4 trailing zero fraction digits is not met.</li> * </ul> * </div> * diff --git a/core/sis-utility/src/main/java/org/apache/sis/measure/Range.java b/core/sis-utility/src/main/java/org/apache/sis/measure/Range.java index 584357d..75ae9d7 100644 --- a/core/sis-utility/src/main/java/org/apache/sis/measure/Range.java +++ b/core/sis-utility/src/main/java/org/apache/sis/measure/Range.java @@ -51,7 +51,7 @@ import org.apache.sis.util.Numbers; * or contain instances of that {@code <E>} type. The type is enforced by parameterized type, * but some subclasses may put additional constraints. For example {@link MeasurementRange} will * additionally checks the units of measurement. Consequently every methods defined in this class - * may throw an {@link IllegalArgumentException} if a given argument does not meet some constraint + * may throw an {@link IllegalArgumentException} if a given argument does not met some constraint * beyond the type. * * <div class="section">Relationship with ISO 19123 definition of range</div> diff --git a/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java b/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java index c4a2b4d..8c9382a 100644 --- a/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java +++ b/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java @@ -66,7 +66,7 @@ import org.apache.sis.math.FunctionProperty; * can not be declared injective because more than one <var>S</var> value can produce the same * <var>T</var> value (namely {@code null}).</li> * <li>If {@code apply(S)} throws an exception for unconvertible objects, then this {@code ObjectConverter} - * can be declared as an injective function if the other values meet the criteria. + * can be declared as an injective function if the other values met the criteria. * </ul> * * @author Martin Desruisseaux (Geomatys) diff --git a/core/sis-utility/src/main/java/org/apache/sis/util/UnsupportedImplementationException.java b/core/sis-utility/src/main/java/org/apache/sis/util/UnsupportedImplementationException.java index 8793d13..24638e8 100644 --- a/core/sis-utility/src/main/java/org/apache/sis/util/UnsupportedImplementationException.java +++ b/core/sis-utility/src/main/java/org/apache/sis/util/UnsupportedImplementationException.java @@ -21,7 +21,7 @@ import org.apache.sis.util.resources.Errors; /** * Thrown when an operation can not use arbitrary implementation of an interface, - * and a given instance does not meet the requirement. For example this exception + * and a given instance does not met the requirement. For example this exception * may be thrown when an operation requires an Apache SIS implementation of a * <a href="http://www.geoapi.org">GeoAPI</a> interface. * diff --git a/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java b/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java index 0f8bc5d..0ca344b 100644 --- a/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java +++ b/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java @@ -125,7 +125,7 @@ import org.apache.sis.internal.system.ReferenceQueueConsumer; * This implementation assumes that there is no circular dependencies (or cyclic graph) between * the values in the cache. For example if creating <var>A</var> implies creating <var>B</var>, * then creating <var>B</var> is not allowed to implies (directly or indirectly) the creation of - * <var>A</var>. If this rule is not meet, deadlock may occur randomly. + * <var>A</var>. If this condition is not met, deadlock may occur randomly. * * @author Martin Desruisseaux (Geomatys) * @author Alexis Manin (Geomatys) diff --git a/core/sis-utility/src/test/java/org/apache/sis/test/TestUtilities.java b/core/sis-utility/src/test/java/org/apache/sis/test/TestUtilities.java index d516d0a..e2a4212 100644 --- a/core/sis-utility/src/test/java/org/apache/sis/test/TestUtilities.java +++ b/core/sis-utility/src/test/java/org/apache/sis/test/TestUtilities.java @@ -433,7 +433,7 @@ public final strictfp class TestUtilities extends Static { * * @param stopCondition a condition which return {@code true} if this method can stop waiting, * or {@code false} if it needs to ask again for garbage collection. - * @return {@code true} if the given condition has been meet, or {@code false} if we waited up + * @return {@code true} if the given condition has been met, or {@code false} if we waited up * to the timeout without meeting the given condition. * @throws InterruptedException if this thread has been interrupted while waiting. */ diff --git a/storage/sis-storage/src/main/java/org/apache/sis/storage/Resource.java b/storage/sis-storage/src/main/java/org/apache/sis/storage/Resource.java index b9b50b8..f29ce87 100644 --- a/storage/sis-storage/src/main/java/org/apache/sis/storage/Resource.java +++ b/storage/sis-storage/src/main/java/org/apache/sis/storage/Resource.java @@ -16,10 +16,10 @@ */ package org.apache.sis.storage; +import org.opengis.util.GenericName; +import org.opengis.metadata.Metadata; import org.apache.sis.storage.event.ChangeEvent; import org.apache.sis.storage.event.ChangeListener; -import org.opengis.metadata.Metadata; -import org.opengis.util.GenericName; /** @@ -52,28 +52,26 @@ import org.opengis.util.GenericName; * @module */ public interface Resource { - /** * Returns the resource primary identifier. - * <p> - * This identifier can be used to uniquely identify a resource in the containing - * {@link DataStore}. For this identifier to be reliable the following - * conditions must be guaranted : - * </p> + * This identifier can be used to uniquely identify a resource in the containing {@link DataStore}. + * For this identifier to be reliable the following conditions must hold: + * * <ul> * <li>It must be unique in the {@link DataStore} which contains it, if there is one.</li> - * <li>It's value must not change after closing and reopening the {@link DataStore}.</li> - * <li>This identifier must be present in the {@link Metadata} returned by {@link #getMetadata() } - * in the field at path {@literal IdentificationInfon/Citation/Identifier}. + * <li>It's value must not change after closing and reopening the {@link DataStore} on the same data.</li> + * <li>This identifier must be consistent with the value returned by {@link #getMetadata()} + * in the field at path {@literal identificationInfo/citation/identifier}. * </li> * </ul> - * <p> - * If any of the above conditions isn't met, this identifier should be null. This - * case may happen when a resource is an intermediate result of an ongoing process - * or is an opportuniste resource like a sensor event. - * </p> * - * @return GenericName, can be null if the resource has no reliable identifier + * If any of the above conditions is not met, this identifier should be null. + * This case may happen when a resource is an intermediate result of an ongoing process + * or is a temporary resource generated on-the-fly, for example a sensor event. + * + * @return an identifier unique within the data store, or {@code null} if the resource has no reliable identifier. + * + * @since 1.0 */ GenericName getIdentifier();