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 788778542c Documentation fixes.
788778542c is described below
commit 788778542c0fedb6521dbe813595f07055515fb3
Author: Martin Desruisseaux <[email protected]>
AuthorDate: Mon Jul 21 09:42:30 2025 +0200
Documentation fixes.
---
.../sis/storage/modifier/CoverageModifier.java | 61 +++++++++++-----------
1 file changed, 31 insertions(+), 30 deletions(-)
diff --git
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/modifier/CoverageModifier.java
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/modifier/CoverageModifier.java
index b2ab2fff1b..17c33cdda0 100644
---
a/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/modifier/CoverageModifier.java
+++
b/endorsed/src/org.apache.sis.storage/main/org/apache/sis/storage/modifier/CoverageModifier.java
@@ -65,12 +65,6 @@ import org.apache.sis.util.privy.Strings;
* @since 1.5
*/
public interface CoverageModifier {
- /**
- * The default instance using the default implementation documented in
each method.
- */
- CoverageModifier DEFAULT = new CoverageModifier() {
- };
-
/**
* Returns modifier specified in the options of the given storage
connector.
* This convenience method fetches the value associated to {@link
DataOptionKey#COVERAGE_MODIFIER}.
@@ -81,7 +75,7 @@ public interface CoverageModifier {
*/
public static CoverageModifier getOrDefault(StorageConnector connector) {
final CoverageModifier customizer =
connector.getOption(DataOptionKey.COVERAGE_MODIFIER);
- return (customizer != null) ? customizer : DEFAULT;
+ return (customizer != null) ? customizer : Source.DEFAULT;
}
/**
@@ -92,11 +86,18 @@ public interface CoverageModifier {
* @since 1.5
*/
public static class Source {
+ /**
+ * The default instance using the default implementation documented in
each method.
+ * Defined in this class because we cannot have private static field
in an interface.
+ */
+ static final CoverageModifier DEFAULT = new CoverageModifier() {
+ };
+
/** The data store for which to modify a file or coverage description.
*/
private final DataStore store;
/** Index of the coverage for which to compute information, or -1 for
the whole file. */
- private final int coverage;
+ private final int coverageIndex;
/** The type of raster data, or {@code null} if unknown. */
private final DataType dataType;
@@ -108,21 +109,21 @@ public interface CoverageModifier {
* @param store the data store for which to modify some coverages or
sample dimensions.
*/
public Source(final DataStore store) {
- this.store = Objects.requireNonNull(store);
- this.coverage = -1;
+ this.store = Objects.requireNonNull(store);
+ this.coverageIndex = -1;
this.dataType = null;
}
/**
* Creates a new source for a coverage at the specified index.
*
- * @param store the data store for which to modify some coverages
or sample dimensions.
- * @param coverage index of the coverage (image) for which to compute
information.
- * @param dataType the type of raster data, or {@code null} if
unknown.
+ * @param store the data store for which to modify some
coverages or sample dimensions.
+ * @param coverageIndex index of the coverage (image) for which to
compute information.
+ * @param dataType the type of raster data, or {@code null} if
unknown.
*/
- public Source(final DataStore store, final int coverage, final
DataType dataType) {
- this.store = Objects.requireNonNull(store);
- this.coverage = coverage;
+ public Source(final DataStore store, final int coverageIndex, final
DataType dataType) {
+ this.store = Objects.requireNonNull(store);
+ this.coverageIndex = coverageIndex;
this.dataType = dataType;
}
@@ -148,7 +149,7 @@ public interface CoverageModifier {
* @return the index of the coverage to eventually modify.
*/
public OptionalInt getCoverageIndex() {
- return (coverage >= 0) ? OptionalInt.of(coverage) :
OptionalInt.empty();
+ return (coverageIndex >= 0) ? OptionalInt.of(coverageIndex) :
OptionalInt.empty();
}
/**
@@ -194,14 +195,14 @@ public interface CoverageModifier {
@Override
public String toString() {
@SuppressWarnings("LocalVariableHidesMemberVariable")
- final int coverage = getCoverageIndex().orElse(-1);
- final int bandIndex = getBandIndex();
- final int numBands = getNumBands();
+ final int coverageIndex = getCoverageIndex().orElse(-1);
+ final int bandIndex = getBandIndex();
+ final int numBands = getNumBands();
return Strings.toString(getClass(),
"store", getDataStore().getDisplayName(),
- "coverageIndex", (coverage >= 0) ? coverage : null,
- "bandIndex", (bandIndex >= 0) ? bandIndex : null,
- "numBands", (numBands >= 0) ? numBands : null,
+ "coverageIndex", (coverageIndex >= 0) ? coverageIndex :
null,
+ "bandIndex", (bandIndex >= 0) ? bandIndex : null,
+ "numBands", (numBands >= 0) ? numBands : null,
"dataType", getDataType(),
"sampleRange", getSampleRange().orElse(null));
}
@@ -224,16 +225,16 @@ public interface CoverageModifier {
/**
* Creates a new source for the specified band.
*
- * @param store the data store which contains the band to modify.
- * @param coverage index of the coverage for which to create a
sample dimension.
- * @param bandIndex index of the band for which to create a sample
dimension.
- * @param numBands number of bands.
- * @param dataType type of raster data, or {@code null} if unknown.
+ * @param store the data store which contains the band to
modify.
+ * @param coverageIndex index of the coverage for which to create a
sample dimension.
+ * @param bandIndex index of the band for which to create a
sample dimension.
+ * @param numBands number of bands.
+ * @param dataType type of raster data, or {@code null} if
unknown.
*/
- public BandSource(final DataStore store, final int coverage, final int
bandIndex,
+ public BandSource(final DataStore store, final int coverageIndex,
final int bandIndex,
final int numBands, final DataType dataType)
{
- super(store, coverage, dataType);
+ super(store, coverageIndex, dataType);
this.bandIndex = bandIndex;
this.numBands = numBands;
}
