You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2016/11/03 15:02:14 UTC
svn commit: r1767898 -
/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/
Author: desruisseaux
Date: Thu Nov 3 15:02:14 2016
New Revision: 1767898
URL: http://svn.apache.org/viewvc?rev=1767898&view=rev
Log:
Javadoc formatting (no significant code change).
Modified:
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/CitationConstant.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCharacterIterator.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCitation.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleExtent.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifier.java
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/CitationConstant.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/CitationConstant.java?rev=1767898&r1=1767897&r2=1767898&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/CitationConstant.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/CitationConstant.java [UTF-8] Thu Nov 3 15:02:14 2016
@@ -57,7 +57,7 @@ public class CitationConstant extends Si
* The most typical example is the "EPSG" authority which manage the codes identifying Coordinate Reference
* System (CRS) objects in the EPSG namespace.
*
- * @param <T> The type of object used as identifier values.
+ * @param <T> the type of object used as identifier values.
*/
public static class Authority<T> extends CitationConstant implements IdentifierSpace<T> {
/**
@@ -68,7 +68,7 @@ public class CitationConstant extends Si
/**
* Creates a new citation for an authority managing codes in the given namespace.
*
- * @param namespace The namespace of codes managed by this authority (e.g. "EPSG").
+ * @param namespace the namespace of codes managed by this authority (e.g. "EPSG").
*/
public Authority(final String namespace) {
super(namespace);
@@ -105,7 +105,7 @@ public class CitationConstant extends Si
* Creates a new proxy for the given primary key.
* The key should be readable enough for being usable as a fallback if the database is not available.
*
- * @param name A human-understandable primary key for fetching more information.
+ * @param name a human-understandable primary key for fetching more information.
*/
public CitationConstant(final String name) {
super(name);
@@ -150,7 +150,7 @@ public class CitationConstant extends Si
/**
* Redirects the call to the delegate citation (the instance which actually contain the data).
*
- * @return The value returned by the delegate.
+ * @return the value returned by the delegate.
*/
@Override public InternationalString getTitle() {return delegate().getTitle();}
@Override public Collection<? extends InternationalString> getAlternateTitles() {return delegate().getAlternateTitles();}
@@ -171,7 +171,7 @@ public class CitationConstant extends Si
* Invoked at deserialization time in order to replace the deserialized instance by the existing
* instance defined in the {@link org.apache.sis.metadata.iso.citation.Citations} class.
*
- * @return The instance to use, as an unique instance if possible.
+ * @return the instance to use, as an unique instance if possible.
*/
protected Object readResolve() {
CitationConstant c = MetadataServices.getInstance().getCitationConstant(title);
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java?rev=1767898&r1=1767897&r2=1767898&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java [UTF-8] Thu Nov 3 15:02:14 2016
@@ -32,7 +32,7 @@ import org.opengis.util.TypeName;
* Such simple type are suitable for use in ISO 19103 {@link org.opengis.util.RecordType}
* in addition to ISO 19109 {@link org.opengis.feature.FeatureType}.
*
- * @param <V> The type of attribute value.
+ * @param <V> the type of attribute value.
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.5
@@ -58,8 +58,8 @@ public final class SimpleAttributeType<V
/**
* Creates a new attribute type for the given name and class of values.
*
- * @param name The name for this attribute type (shall not be null).
- * @param valueClass The class of value for attributes of this type (shall not be null).
+ * @param name the name for this attribute type (shall not be null).
+ * @param valueClass the class of value for attributes of this type (shall not be null).
*/
public SimpleAttributeType(final TypeName name, final Class<V> valueClass) {
this.name = name;
@@ -69,7 +69,7 @@ public final class SimpleAttributeType<V
/**
* Returns the name of this attribute type (ISO 19109).
*
- * @return The name of this attribute type.
+ * @return the name of this attribute type.
*/
@Override
public GenericName getName() {
@@ -79,7 +79,7 @@ public final class SimpleAttributeType<V
/**
* Returns the name of this attribute type (ISO 19103).
*
- * @return The name of this attribute type.
+ * @return the name of this attribute type.
*/
@Override
public TypeName getTypeName() {
@@ -89,7 +89,7 @@ public final class SimpleAttributeType<V
/**
* Returns the class of value for attributes of this type.
*
- * @return The class of value for attributes of this type.
+ * @return the class of value for attributes of this type.
*/
@Override
public Class<V> getValueClass() {
@@ -99,7 +99,7 @@ public final class SimpleAttributeType<V
/**
* Returns 1 as of simple feature definition.
*
- * @return Always 1.
+ * @return always 1.
*/
@Override
public int getMinimumOccurs() {
@@ -109,7 +109,7 @@ public final class SimpleAttributeType<V
/**
* Returns 1 as of simple feature definition.
*
- * @return Always 1.
+ * @return always 1.
*/
@Override
public int getMaximumOccurs() {
@@ -119,7 +119,7 @@ public final class SimpleAttributeType<V
/**
* Not used for this simple attribute type.
*
- * @return Always {@code null}.
+ * @return always {@code null}.
*/
@Override
public V getDefaultValue() {
@@ -129,7 +129,7 @@ public final class SimpleAttributeType<V
/**
* Not used for this simple attribute type.
*
- * @return Always {@code null}.
+ * @return always {@code null}.
*/
@Override
public InternationalString getDefinition() {
@@ -139,7 +139,7 @@ public final class SimpleAttributeType<V
/**
* Not used for this simple attribute type.
*
- * @return Always {@code null}.
+ * @return always {@code null}.
*/
@Override
public InternationalString getDesignation() {
@@ -159,7 +159,7 @@ public final class SimpleAttributeType<V
/**
* Not used for this simple attribute type.
*
- * @return Always empty.
+ * @return always empty.
*/
@Override
public Map<String, AttributeType<?>> characteristics() {
@@ -177,7 +177,7 @@ public final class SimpleAttributeType<V
/**
* Returns a hash code value for this type.
*
- * @return A hash code value.
+ * @return a hash code value.
*/
@Override
public int hashCode() {
@@ -187,7 +187,7 @@ public final class SimpleAttributeType<V
/**
* Compares this attribute type with the given object for equality.
*
- * @param object The object to compare with this attribute type.
+ * @param object the object to compare with this attribute type.
* @return {@code true} if both objects are equal.
*/
@Override
@@ -205,7 +205,7 @@ public final class SimpleAttributeType<V
/**
* Returns the type name.
*
- * @return The type name.
+ * @return the type name.
*/
@Override
public String toString() {
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCharacterIterator.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCharacterIterator.java?rev=1767898&r1=1767897&r2=1767898&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCharacterIterator.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCharacterIterator.java [UTF-8] Thu Nov 3 15:02:14 2016
@@ -62,7 +62,7 @@ public class SimpleCharacterIterator imp
/**
* Creates a new character iterator for the given character sequence.
*
- * @param text The character sequence to wrap.
+ * @param text the character sequence to wrap.
*/
public SimpleCharacterIterator(final CharSequence text) {
ArgumentChecks.ensureNonNull("text", text);
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCitation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCitation.java?rev=1767898&r1=1767897&r2=1767898&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCitation.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleCitation.java [UTF-8] Thu Nov 3 15:02:14 2016
@@ -17,6 +17,7 @@
package org.apache.sis.internal.simple;
import java.util.Date;
+import java.util.Objects;
import java.util.Collection;
import java.util.Collections;
import java.io.Serializable;
@@ -32,9 +33,6 @@ import org.opengis.util.InternationalStr
import org.apache.sis.util.iso.SimpleInternationalString;
import org.apache.sis.util.Debug;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* A trivial implementation of {@link Citation} containing only a title.
@@ -64,7 +62,7 @@ public class SimpleCitation implements C
/**
* Creates a new object for the given title.
*
- * @param title The title to be returned by {@link #getTitle()}.
+ * @param title the title to be returned by {@link #getTitle()}.
*/
public SimpleCitation(final String title) {
this.title = title;
@@ -73,7 +71,7 @@ public class SimpleCitation implements C
/**
* Returns the title as an international string.
*
- * @return The title given at construction time.
+ * @return the title given at construction time.
*/
@Override
public InternationalString getTitle() {
@@ -84,7 +82,7 @@ public class SimpleCitation implements C
* Methods inherited from the {@link Citation} interface which are not of interest to this
* {@code SimpleCitation} implementation. Those methods may be removed in the JDK8 branch.
*
- * @return An empty list.
+ * @return an empty list.
*/
@Override public Collection<? extends InternationalString> getAlternateTitles() {return Collections.emptyList();}
@Override public Collection<? extends CitationDate> getDates() {return Collections.emptyList();}
@@ -105,7 +103,7 @@ public class SimpleCitation implements C
/**
* Compares the given object with this citation for equality.
*
- * @param obj The object to compare with this citation.
+ * @param obj the object to compare with this citation.
* @return {@code true} if both objects are equal.
*/
@Override
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleExtent.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleExtent.java?rev=1767898&r1=1767897&r2=1767898&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleExtent.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleExtent.java [UTF-8] Thu Nov 3 15:02:14 2016
@@ -55,9 +55,9 @@ public final class SimpleExtent implemen
/**
* Creates a new extent with the given elements.
*
- * @param geographicElements Geographic components of the extent, or {@code null}.
- * @param verticalElements Vertical components of the extent, or {@code null}.
- * @param temporalElements Temporal components of the extent, or {@code null}.
+ * @param geographicElements geographic components of the extent, or {@code null}.
+ * @param verticalElements vertical components of the extent, or {@code null}.
+ * @param temporalElements temporal components of the extent, or {@code null}.
*/
public SimpleExtent(final GeographicExtent geographicElements,
final VerticalExtent verticalElements,
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java?rev=1767898&r1=1767897&r2=1767898&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifiedObject.java [UTF-8] Thu Nov 3 15:02:14 2016
@@ -17,6 +17,7 @@
package org.apache.sis.internal.simple;
import java.util.Set;
+import java.util.Objects;
import java.util.Collection;
import java.util.Collections;
import java.io.Serializable;
@@ -33,9 +34,6 @@ import org.apache.sis.util.ComparisonMod
import static org.apache.sis.util.collection.Containers.isNullOrEmpty;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* A trivial implementation of {@link IdentifiedObject} containing only a primary name.
@@ -69,7 +67,7 @@ public class SimpleIdentifiedObject impl
/**
* Creates an identified object with the same identifier than the given one.
*
- * @param object The identified object to partially copy.
+ * @param object the identified object to partially copy.
*/
public SimpleIdentifiedObject(final IdentifiedObject object) {
name = object.getName();
@@ -78,7 +76,7 @@ public class SimpleIdentifiedObject impl
/**
* Creates an identified object with the given identifier.
*
- * @param name The primary name by which this object is identified.
+ * @param name the primary name by which this object is identified.
*/
public SimpleIdentifiedObject(final Identifier name) {
this.name = name;
@@ -87,7 +85,7 @@ public class SimpleIdentifiedObject impl
/**
* Returns the primary name by which this object is identified.
*
- * @return The identifier given at construction time.
+ * @return the identifier given at construction time.
*/
@Override
public Identifier getName() {
@@ -101,7 +99,7 @@ public class SimpleIdentifiedObject impl
* <p>If a future version allows this method to returns a non-empty set,
* revisit {@link #equals(Object, ComparisonMode)}.</p>
*
- * @return The identifiers, or an empty set if none.
+ * @return the identifiers, or an empty set if none.
*/
@Override
public final Set<Identifier> getIdentifiers() {
@@ -115,7 +113,7 @@ public class SimpleIdentifiedObject impl
* <p>If a future version allows this method to returns a non-empty set,
* revisit {@link #equals(Object, ComparisonMode)}.</p>
*
- * @return The aliases, or an empty set if none.
+ * @return the aliases, or an empty set if none.
*/
@Override
public final Collection<GenericName> getAlias() {
@@ -129,7 +127,7 @@ public class SimpleIdentifiedObject impl
* <p>If a future version allows this method to returns a non-null value,
* revisit {@link #equals(Object, ComparisonMode)} in subclasses.</p>
*
- * @return The domain of validity, or {@code null} if none.
+ * @return the domain of validity, or {@code null} if none.
*/
public final Extent getDomainOfValidity() {
return null;
@@ -142,7 +140,7 @@ public class SimpleIdentifiedObject impl
* <p>If a future version allows this method to returns a non-null value,
* revisit {@link #equals(Object, ComparisonMode)} in subclasses.</p>
*
- * @return The scope, or {@code null} if none.
+ * @return the scope, or {@code null} if none.
*/
public final InternationalString getScope() {
return null;
@@ -155,7 +153,7 @@ public class SimpleIdentifiedObject impl
* <p>If a future version allows this method to returns a non-null value,
* revisit {@link #equals(Object, ComparisonMode)}.</p>
*
- * @return The remarks, or {@code null} if none.
+ * @return the remarks, or {@code null} if none.
*/
@Override
public final InternationalString getRemarks() {
@@ -178,7 +176,7 @@ public class SimpleIdentifiedObject impl
/**
* Compares this object with the given one for equality.
*
- * @param object The object to compare with this reference system.
+ * @param object the object to compare with this reference system.
* @return {@code true} if both objects are equal.
*/
@Override
@@ -192,8 +190,8 @@ public class SimpleIdentifiedObject impl
* If name is a critical component of this object, then it shall be compared by the subclass.
* This behavior is consistent with {@link org.apache.sis.referencing.AbstractIdentifiedObject}.
*
- * @param object The object to compare with this reference system.
- * @param mode The strictness level of the comparison.
+ * @param object the object to compare with this reference system.
+ * @param mode the strictness level of the comparison.
* @return {@code true} if both objects are equal.
*/
@Override
@@ -219,8 +217,8 @@ public class SimpleIdentifiedObject impl
/**
* Throws an exception in all cases, since this object can't be formatted in a valid WKT.
*
- * @return The Well Known Text.
- * @throws UnsupportedOperationException Always thrown.
+ * @return the Well Known Text.
+ * @throws UnsupportedOperationException always thrown.
*/
@Override
public String toWKT() throws UnsupportedOperationException {
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifier.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifier.java?rev=1767898&r1=1767897&r2=1767898&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifier.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleIdentifier.java [UTF-8] Thu Nov 3 15:02:14 2016
@@ -16,6 +16,7 @@
*/
package org.apache.sis.internal.simple;
+import java.util.Objects;
import java.io.Serializable;
import org.opengis.util.InternationalString;
import org.opengis.metadata.Identifier;
@@ -28,9 +29,6 @@ import org.apache.sis.util.Deprecable;
import static org.apache.sis.util.iso.DefaultNameSpace.DEFAULT_SEPARATOR;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* An implementation of {@link Identifier} as a wrapper around a {@link Citation}.
@@ -77,8 +75,8 @@ public class SimpleIdentifier implements
/**
* Creates a new reference identifier.
*
- * @param authority Responsible party for definition and maintenance of the code, or null.
- * @param code Alphanumeric value identifying an instance in the namespace.
+ * @param authority responsible party for definition and maintenance of the code, or null.
+ * @param code alphanumeric value identifying an instance in the namespace.
* @param isDeprecated {@code true} if this identifier is deprecated.
*/
public SimpleIdentifier(final Citation authority, final String code, final boolean isDeprecated) {
@@ -92,9 +90,9 @@ public class SimpleIdentifier implements
* of the {@linkplain #getCode() code}, or {@code null} if none. It can be a
* bibliographical reference to an international standard such as ISO 19115.
*
- * <p>The default implementation returns the citation specified at construction time;</p>
+ * <p>The default implementation returns the citation specified at construction time.</p>
*
- * @return The authority given at construction time, or {@code null} if none.
+ * @return the authority given at construction time, or {@code null} if none.
*/
@Override
public Citation getAuthority() {
@@ -106,7 +104,7 @@ public class SimpleIdentifier implements
* The default implementation returns the shortest identifier of the {@linkplain #getAuthority() authority},
* if any.
*
- * @return A code space inferred from the authority given at construction time, or {@code null} if none.
+ * @return a code space inferred from the authority given at construction time, or {@code null} if none.
*/
@Override
public String getCodeSpace() {
@@ -118,9 +116,9 @@ public class SimpleIdentifier implements
* It can be for example the name of a class defined by the international standard
* referenced by the {@linkplain #getAuthority() authority} citation.
*
- * <p>The default implementation returns the code specified at construction time;</p>
+ * <p>The default implementation returns the code specified at construction time.</p>
*
- * @return The code given at construction time, or {@code null} if none.
+ * @return the code given at construction time, or {@code null} if none.
*/
@Override
public String getCode() {
@@ -132,7 +130,7 @@ public class SimpleIdentifier implements
* When appropriate, the edition is identified by the effective date, coded
* using ISO 8601 date format.
*
- * @return A version inferred from the authority given at construction time, or {@code null} if none.
+ * @return a version inferred from the authority given at construction time, or {@code null} if none.
*/
@Override
public String getVersion() {
@@ -148,7 +146,7 @@ public class SimpleIdentifier implements
/**
* Returns a natural language description of the meaning of the code value.
*
- * @return Natural language description, or {@code null} if none.
+ * @return natural language description, or {@code null} if none.
*
* @since 0.5
*/
@@ -181,7 +179,7 @@ public class SimpleIdentifier implements
* Returns {@code true} if the given object is of the same class than this
* {@code SimpleIdentifier} and has the same values.
*
- * @param obj The object to compare with this {@code SimpleIdentifier} for equality.
+ * @param obj the object to compare with this {@code SimpleIdentifier} for equality.
* @return {@code true} if both objects are equal.
*/
@Override
@@ -198,7 +196,7 @@ public class SimpleIdentifier implements
/**
* Returns a hash code value for this identifier.
*
- * @return A hash code value for this identifier.
+ * @return a hash code value for this identifier.
*/
@Override
public int hashCode() {
@@ -214,7 +212,7 @@ public class SimpleIdentifier implements
final String classname = Classes.getShortClassName(this);
final StringBuilder buffer = new StringBuilder(classname.length() + CharSequences.length(code) + 10);
buffer.append(classname).append('[');
- final String codespace = getCodeSpace(); // Subclasses may have overridden this method.
+ final String codespace = getCodeSpace(); // Subclasses may have overridden this method.
boolean open = false;
if (codespace != null) {
buffer.append('\u201c').append(codespace);
@@ -235,8 +233,7 @@ public class SimpleIdentifier implements
* Invoked by {@link #toString()} in order to allow subclasses to add additional information.
* This method is invoked just before the final {@code ']'} is appended to the buffer.
*
- * @param buffer A buffer filled with the {@link #toString()} characters,
- * that subclasses can update.
+ * @param buffer a buffer filled with the {@link #toString()} characters, that subclasses can update.
*/
protected void appendToString(final StringBuilder buffer) {
}
@@ -246,7 +243,7 @@ public class SimpleIdentifier implements
* While this method is not defined in the {@link Identifier} interface, it is often
* defined in related interfaces like {@link org.opengis.referencing.IdentifiedObject}.
*
- * @return Pseudo Well Known Text for this identifier.
+ * @return pseudo Well Known Text for this identifier.
*/
public String toWKT() {
final StringBuilder buffer = new StringBuilder(40).append("Id["); // Consistent with WKTKeywords.Id.