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 a83df8e6cdaeba95a5b845d83061959df69fd1f9
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Fri Dec 31 02:58:11 2021 +0100
Trivial comment formatting.
---
.../main/java/org/apache/sis/feature/DefaultFeatureType.java | 12 ++++++------
.../main/java/org/apache/sis/util/iso/DefaultLocalName.java | 8 ++++----
.../main/java/org/apache/sis/util/iso/DefaultMemberName.java | 2 +-
.../java/org/apache/sis/util/iso/DefaultNameFactory.java | 4 ++--
.../main/java/org/apache/sis/util/iso/DefaultScopedName.java | 4 ++--
.../main/java/org/apache/sis/util/iso/DefaultTypeName.java | 4 ++--
.../src/main/java/org/apache/sis/util/iso/TypeNames.java | 2 +-
7 files changed, 18 insertions(+), 18 deletions(-)
diff --git
a/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultFeatureType.java
b/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultFeatureType.java
index 8990704..e2ebc82 100644
---
a/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultFeatureType.java
+++
b/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultFeatureType.java
@@ -293,7 +293,7 @@ public class DefaultFeatureType extends
AbstractIdentifiedType implements Featur
}
/*
* Before to resolve cyclic associations, verify that operations
depend only on existing properties.
- * Note: the 'allProperties' collection has been created by
computeTransientFields(…) above.
+ * Note: the `allProperties` collection has been created by
computeTransientFields(…) above.
*/
for (final PropertyType property : allProperties) {
if (property instanceof AbstractOperation) {
@@ -329,7 +329,7 @@ public class DefaultFeatureType extends
AbstractIdentifiedType implements Featur
in.defaultReadObject();
computeTransientFields(properties);
/*
- * Set isResolved to a conservative value. The 'resolve' method will
compute a more accurate value if needed,
+ * Set isResolved to a conservative value. The `resolve` method will
compute a more accurate value if needed,
* the first time that another DefaultFeatureType will have a
dependency to this DefaultFeatureType through a
* DefaultAssociationRole.
*/
@@ -392,7 +392,7 @@ public class DefaultFeatureType extends
AbstractIdentifiedType implements Featur
* name for convenience, provided that it does not create ambiguity.
If a short alias could map to two or
* more properties, then that alias is not added.
*
- * In the 'aliases' map below, null values will be assigned to
ambiguous short names.
+ * In the `aliases` map below, null values will be assigned to
ambiguous short names.
*/
final Map<String, PropertyType> aliases = new LinkedHashMap<>();
for (final PropertyType property : allProperties) {
@@ -411,7 +411,7 @@ public class DefaultFeatureType extends
AbstractIdentifiedType implements Featur
if (byName.putIfAbsent(tip, property) == null) {
/*
* This block is skipped if there is properties named
"tip" and "head:tip".
- * The 'indices' value may be null if the property is an
operation.
+ * The `indices` value may be null if the property is an
operation.
*/
final Integer value =
indices.get(property.getName().toString());
if (value != null && indices.put(tip, value) != null) {
@@ -525,7 +525,7 @@ public class DefaultFeatureType extends
AbstractIdentifiedType implements Featur
/*
* The isResolved field is used only as a cache for skipping
completely the DefaultFeatureType instance if
* we have determined that there is no unresolved name. If the given
argument is not a DefaultFeatureType
- * instance, conservatively assumes 'isSimple'. It may cause more
calculation than needed, but should not
+ * instance, conservatively assumes `isSimple`. It may cause more
calculation than needed, but should not
* change the result.
*/
if (feature instanceof DefaultFeatureType) {
@@ -566,7 +566,7 @@ public class DefaultFeatureType extends
AbstractIdentifiedType implements Featur
}
/*
* Resolve recursively the associated features, with a
check against infinite recursivity.
- * If we fall in a loop (for example A → B → C → A),
conservatively returns 'false'. This
+ * If we fall in a loop (for example A → B → C → A),
conservatively returns `false`. This
* may not be the most accurate answer, but will not cause
any more hurt than checking more
* often than necessary.
*/
diff --git
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultLocalName.java
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultLocalName.java
index e1616f2..e11a7b1 100644
---
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultLocalName.java
+++
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultLocalName.java
@@ -139,18 +139,18 @@ public class DefaultLocalName extends AbstractName
implements LocalName {
* flavor instead of InternationalString (this is done by
name.toString() at
* the end of this constructor). It will not cause any lost of
information since
* SimpleInternationalString contains only one String. This
simplification allows
- * the equals(Object) method to return "true" for
DefaultLocalName that would
+ * the equals(Object) method to return `true` for
`DefaultLocalName` that would
* otherwise be considered different.
*
* In order to reduce the amount of objects created, we retain
the full
- * InternationalString in the "asString" field, which is NOT
considered
+ * InternationalString in the `asString` field, which is NOT
considered
* by equals(Object). This is the value returned by
toInternationalString().
*/
asString = name;
} else {
/*
* For any InternationalString that are not
SimpleInternationalString, we retain
- * the given name and we do NOT set the "asString" field. It
will be computed on
+ * the given name and we do NOT set the `asString` field. It
will be computed on
* the fly when first needed.
*/
this.name = name;
@@ -365,7 +365,7 @@ public class DefaultLocalName extends AbstractName
implements LocalName {
/**
* Empty constructor to be used by JAXB only, or by sub-classes empty
constructors
- * themselves used only by JAXB. Despite its "final" declaration, the
{@link #name}
+ * themselves used only by JAXB. Despite its `final` declaration, the
{@link #name}
* field will be set by JAXB during unmarshalling.
*/
DefaultLocalName() {
diff --git
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultMemberName.java
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultMemberName.java
index 2271562..462b151 100644
---
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultMemberName.java
+++
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultMemberName.java
@@ -148,7 +148,7 @@ public class DefaultMemberName extends DefaultLocalName
implements MemberName {
//////////////////////////////////////////////////////////////////////////////////////////////////
/**
- * Empty constructor to be used by JAXB only. Despite its "final"
declaration,
+ * Empty constructor to be used by JAXB only. Despite its `final`
declaration,
* the {@link #attributeType} field will be set by JAXB during
unmarshalling.
*/
private DefaultMemberName() {
diff --git
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultNameFactory.java
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultNameFactory.java
index 4dac9a1..cc78ce2 100644
---
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultNameFactory.java
+++
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultNameFactory.java
@@ -446,11 +446,11 @@ public class DefaultNameFactory extends AbstractFactory
implements NameFactory {
/*
* Create TypeNames outide the synchronized block because the
TypeNames constructor will call back
* methods from this class. Since those methods are overrideable,
this could invoke user's code.
- * Note also that methods in this class use the 'pool', which is
itself synchronized, so we are
+ * Note also that methods in this class use the `pool`, which is
itself synchronized, so we are
* better to avoid double synchronization for reducing the risk of
dead-lock.
*/
final TypeNames c = new TypeNames(this);
- synchronized (this) { // Double-check
strategy is ok if 'typeNames' is volatile.
+ synchronized (this) { // Double-check
strategy is ok if `typeNames` is volatile.
t = typeNames;
if (t == null) {
typeNames = t = c;
diff --git
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultScopedName.java
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultScopedName.java
index 6ca4f1b..b2c20c8 100644
---
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultScopedName.java
+++
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultScopedName.java
@@ -150,7 +150,7 @@ public class DefaultScopedName extends AbstractName
implements ScopedName {
if (i != size) { // Paranoiac
check.
throw new
ConcurrentModificationException(Errors.format(Errors.Keys.UnexpectedChange_1,
"names"));
}
- // Following line is safe because 'parsedNames' type is <? extends
LocalName>.
+ // Following line is safe because `parsedNames` type is <? extends
LocalName>.
parsedNames = UnmodifiableArrayList.wrap(locals);
}
@@ -214,7 +214,7 @@ public class DefaultScopedName extends AbstractName
implements ScopedName {
if (index != locals.length) { // Paranoiac check.
throw new
ConcurrentModificationException(Errors.format(Errors.Keys.UnexpectedChange_1,
"tail"));
}
- // Following line is safe because 'parsedNames' type is <? extends
LocalName>.
+ // Following line is safe because `parsedNames` type is <? extends
LocalName>.
parsedNames = UnmodifiableArrayList.wrap(locals);
if (tail instanceof LocalName) {
this.path = path;
diff --git
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultTypeName.java
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultTypeName.java
index 9b691b8..c065bd6 100644
---
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultTypeName.java
+++
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/DefaultTypeName.java
@@ -258,7 +258,7 @@ public class DefaultTypeName extends DefaultLocalName
implements TypeName {
/*
* Invoke super.foo() instead of this.foo() because we do not want
to invoke any overridden method.
* This is for ensuring that two TypeNames constructed with the
same name will map to the same class.
- * See 'valueClass' javadoc for more information.
+ * See `valueClass` javadoc for more information.
*/
try {
c = TypeNames.toClass(TypeNames.namespace(super.scope()),
super.toString());
@@ -288,7 +288,7 @@ public class DefaultTypeName extends DefaultLocalName
implements TypeName {
//////////////////////////////////////////////////////////////////////////////////////////////////
/**
- * Empty constructor to be used by JAXB only. Despite its "final"
declaration,
+ * Empty constructor to be used by JAXB only. Despite its `final`
declaration,
* the {@link #name} field will be set by JAXB during unmarshalling.
*/
private DefaultTypeName() {
diff --git
a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/TypeNames.java
b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/TypeNames.java
index 3e87004..48325ec 100644
--- a/core/sis-metadata/src/main/java/org/apache/sis/util/iso/TypeNames.java
+++ b/core/sis-metadata/src/main/java/org/apache/sis/util/iso/TypeNames.java
@@ -128,7 +128,7 @@ final class TypeNames {
}
}
/*
- * Now create the name and remember the 'valueClass' for that name if
the implementation allows that.
+ * Now create the name and remember the `valueClass` for that name if
the implementation allows that.
*/
final TypeName t = factory.createTypeName(ns, name);
if (t instanceof DefaultTypeName) {
