This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sis.git
commit d214faa29b785586ab2835cefc4f693c19b99cd9
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Tue Oct 3 23:46:44 2023 +0200
Fix some Javadoc warnings specific to the main branch.
---
.../main/org/apache/sis/feature/AbstractFeature.java | 4 ++--
.../org/apache/sis/feature/internal/FeatureExpression.java | 6 +++---
.../main/org/apache/sis/filter/Filter.java | 2 ++
.../main/org/apache/sis/xml/TransformedEvent.java | 2 +-
.../sis/xml/bind/metadata/replace/QualityParameter.java | 2 +-
.../sis/xml/bind/metadata/replace/ServiceParameter.java | 2 +-
.../main/org/apache/sis/storage/sql/feature/Table.java | 2 +-
.../main/org/apache/sis/storage/FeatureQuery.java | 14 +++++++-------
.../main/org/apache/sis/storage/base/MetadataBuilder.java | 2 +-
.../main/org/apache/sis/util/internal/PropertyFormat.java | 2 +-
10 files changed, 20 insertions(+), 18 deletions(-)
diff --git
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/AbstractFeature.java
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/AbstractFeature.java
index 6def733227..033cc8d924 100644
---
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/AbstractFeature.java
+++
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/AbstractFeature.java
@@ -54,8 +54,8 @@ import org.apache.sis.feature.internal.Resources;
* </ul>
*
* <h2>Operations</h2>
- * Properties that are instances of {@link Operation} are usually not stored
in {@code Feature} instances.
- * Instead, the {@link Operation#apply Operation.apply(…)} method is invoked
every times that the property
+ * Properties that are instances of {@code Operation} are usually not stored
in {@code Feature} instances.
+ * Instead, the {@link AbstractOperation#apply Operation.apply(…)} method is
invoked every times that the property
* value is requested. {@code AbstractFeature} does not cache operation
results.
* Those results are usually read-only, but may be writable under the
conditions documented in
* {@link #setOperationValue(String, Object)}.
diff --git
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/internal/FeatureExpression.java
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/internal/FeatureExpression.java
index cc2b87f3f6..05bd7e153e 100644
---
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/internal/FeatureExpression.java
+++
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/feature/internal/FeatureExpression.java
@@ -73,9 +73,9 @@ public interface FeatureExpression<R,V> extends
Expression<R,V> {
/**
* Provides the expected type of values produced by this expression when a
feature of the given
- * type is evaluated. The resulting type shall describe a "static"
property, i.e. it can be an
- * {@link AttributeType} or a {@link
org.opengis.feature.FeatureAssociationRole}
- * but not an {@link org.opengis.feature.Operation}.
+ * type is evaluated. The resulting type shall describe a "static"
property, i.e. it can be a
+ * {@link org.apache.sis.feature.DefaultAttributeType} or a {@link
org.apache.sis.feature.DefaultAssociationRole}
+ * but not an {@link org.apache.sis.feature.AbstractOperation}.
*
* <p>If this method returns an instance of {@link AttributeTypeBuilder},
then its parameterized
* type should be the same {@code <V>} than this {@code
FeatureExpression}.</p>
diff --git
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/Filter.java
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/Filter.java
index 8676107bf7..0e11130b4f 100644
--- a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/Filter.java
+++ b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/filter/Filter.java
@@ -32,6 +32,8 @@ import java.util.function.Predicate;
* instead of {@code org.apache.sis.filter}.
* </div>
*
+ * @param <R> the type of resources (e.g. {@link
org.apache.sis.feature.AbstractFeature}) to filter.
+ *
* @since 1.1
*/
public interface Filter<R> extends Predicate<R> {
diff --git
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/TransformedEvent.java
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/TransformedEvent.java
index f906873041..e86698e2c0 100644
---
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/TransformedEvent.java
+++
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/TransformedEvent.java
@@ -126,7 +126,7 @@ abstract class TransformedEvent<E extends XMLEvent>
implements XMLEvent {
/**
* Wrapper over a namespace emitted during the reading or writing of an
XML document.
* This wrapper is used for changing the namespace URI. The wrapped {@link
#event}
- * should be a {@link Namespace}, but this class accepts also the {@link
Attribute}
+ * should be a {@link Namespace}, but this class accepts also the {@code
Attribute}
* super-type for allowing the {@link Type} attribute to create synthetic
namespaces.
*/
static final class NS extends TransformedEvent<Attribute> implements
Namespace {
diff --git
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/QualityParameter.java
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/QualityParameter.java
index a0baeb0a66..c74f3dfd1d 100644
---
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/QualityParameter.java
+++
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/QualityParameter.java
@@ -84,7 +84,7 @@ public final class QualityParameter extends Parameter {
/**
* Definition of the data quality parameter.
- * Stored in {@link Identifier#getDescription()}.
+ * Stored in {@link ReferenceIdentifier#getDescription()}.
*
* @see #getName()
*/
diff --git
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/ServiceParameter.java
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/ServiceParameter.java
index 0ad9af3f45..deb3829690 100644
---
a/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/ServiceParameter.java
+++
b/endorsed/src/org.apache.sis.metadata/main/org/apache/sis/xml/bind/metadata/replace/ServiceParameter.java
@@ -180,7 +180,7 @@ public final class ServiceParameter extends Parameter {
* <li>Otherwise this method searches for the first {@linkplain
ParameterDescriptor#getAlias() alias}
* which is an instance of {@code MemberName}. If found, that alias
is returned.</li>
* <li>If no alias is found, then this method tries to build a member
name from the primary name and the
- * {@linkplain ParameterDescriptor#getValueType() value type} (if
available) or the
+ * {@linkplain
org.apache.sis.parameter.DefaultParameterDescriptor#getValueType() value type}
(if available) or the
* {@linkplain ParameterDescriptor#getValueClass() value class}.</li>
* </ul>
*
diff --git
a/endorsed/src/org.apache.sis.storage.sql/main/org/apache/sis/storage/sql/feature/Table.java
b/endorsed/src/org.apache.sis.storage.sql/main/org/apache/sis/storage/sql/feature/Table.java
index fe153c3c8c..b296aeb17b 100644
---
a/endorsed/src/org.apache.sis.storage.sql/main/org/apache/sis/storage/sql/feature/Table.java
+++
b/endorsed/src/org.apache.sis.storage.sql/main/org/apache/sis/storage/sql/feature/Table.java
@@ -46,7 +46,7 @@ import org.apache.sis.feature.DefaultAssociationRole;
/**
* Description of a table in the database, including columns, primary keys and
foreigner keys.
* This class contains a {@code FeatureType} inferred from the table structure.
- * The {@code FeatureType} contains an {@link AttributeType} for each table
column,
+ * The {@code FeatureType} contains an {@code AttributeType} for each table
column,
* except foreigner keys which are represented by {@code
FeatureAssociationRole}s.
*
* <h2>Multi-threading</h2>
diff --git
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/FeatureQuery.java
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/FeatureQuery.java
index 4b48c05264..9a5b59763b 100644
---
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/FeatureQuery.java
+++
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/FeatureQuery.java
@@ -434,8 +434,8 @@ public class FeatureQuery extends Query implements
Cloneable, Serializable {
/**
* Whether a property evaluated by a query is computed on the fly or
stored.
* By default, an expression is evaluated only once for each feature
instance,
- * then the result is stored as a feature {@link Attribute} value.
- * But the same expression can also be wrapped in a feature {@link
Operation}
+ * then the result is stored as a feature {@link DefaultAttribute} value.
+ * But the same expression can also be wrapped in a feature {@link
AbstractOperation}
* and evaluated every times that the value is requested.
*
* <h2>Analogy with relational databases</h2>
@@ -452,7 +452,7 @@ public class FeatureQuery extends Query implements
Cloneable, Serializable {
/**
* The expression is evaluated exactly once when a feature instance is
created,
* and the result is stored as a feature attribute.
- * The feature property type will be {@link Attribute} and its value
will be modifiable.
+ * The feature property type will be {@link DefaultAttribute} and its
value will be modifiable.
* This is the default projection type.
*
* <h4>Feature instances in expression evaluation</h4>
@@ -483,7 +483,7 @@ public class FeatureQuery extends Query implements
Cloneable, Serializable {
/**
* The expression is evaluated every times that the property value is
requested.
- * The feature property type will be {@link Operation}.
+ * The feature property type will be {@link AbstractOperation}.
* This projection type may be preferable to {@link #STORED} in the
following circumstances:
*
* <ul>
@@ -546,8 +546,8 @@ public class FeatureQuery extends Query implements
Cloneable, Serializable {
/**
* Whether the expression result should be stored or evaluated every
times that it is requested.
- * A stored value will exist as a feature {@link Attribute}, while a
virtual value will exist as
- * a feature {@link Operation}. The latter are commonly called
"computed fields" and are equivalent
+ * A stored value will exist as a feature {@link DefaultAttribute},
while a virtual value will exist as
+ * a feature {@link AbstractOperation}. The latter are commonly called
"computed fields" and are equivalent
* to SQL {@code GENERATED ALWAYS} keyword for columns.
*
* @since 1.4
@@ -592,7 +592,7 @@ public class FeatureQuery extends Query implements
Cloneable, Serializable {
*
* @param expression the literal, value reference or expression to be
retrieved by a {@code Query}.
* @param alias the name to assign to the expression result, or
{@code null} if unspecified.
- * @param type whether to create a feature {@link Attribute} or
a feature {@link Operation}.
+ * @param type whether to create a feature {@link
DefaultAttribute} or a feature {@link AbstractOperation}.
*
* @since 1.4
*/
diff --git
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/MetadataBuilder.java
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/MetadataBuilder.java
index f5c139f80e..c8fdb23ef0 100644
---
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/MetadataBuilder.java
+++
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/base/MetadataBuilder.java
@@ -1057,7 +1057,7 @@ public class MetadataBuilder {
/**
* Adds information about the scope of the resource.
- * The scope is typically (but not restricted to) {@link
ScopeCode#COVERAGE},
+ * The scope is typically (but not restricted to) {@code
ScopeCode.COVERAGE},
* {@link ScopeCode#FEATURE} or the more generic {@link ScopeCode#DATASET}.
* Storage locations are:
*
diff --git
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/PropertyFormat.java
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/PropertyFormat.java
index 0186bb4c78..cc7e2af88b 100644
---
a/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/PropertyFormat.java
+++
b/endorsed/src/org.apache.sis.util/main/org/apache/sis/util/internal/PropertyFormat.java
@@ -152,7 +152,7 @@ public abstract class PropertyFormat extends LineAppender
implements Localized {
/**
* Invoked by {@link PropertyFormat} for formatting a value which has not
been recognized as one of the types
* to be handled in a special way. Some of the types handled in a special
way are {@link InternationalString},
- * {@link ControlledVocabulary}, {@link Enum}, {@link Type}, {@link
Locale}, {@link TimeZone}, {@link Charset},
+ * {@link CodeList}, {@link Enum}, {@link Type}, {@link Locale}, {@link
TimeZone}, {@link Charset},
* {@link Currency}, {@link Record}, {@link Iterable} and arrays. Other
types should be handled by this method.
* In particular, {@link Number}, {@link java.util.Date} and {@link
org.apache.sis.measure.Angle}
* are <strong>not</strong> handled by default by this {@link
PropertyFormat} class and should be handled here.
