sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1777065 - in /sis/branches/JDK8/core: sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/ sis-referencing/src/main/java/org/apache/sis/referencing/ sis-utility/src/main/java/org/apache/sis/util/ sis-utility/src/main/java/org/ap...
Date Tue, 03 Jan 2017 05:10:12 GMT
Author: desruisseaux
Date: Tue Jan  3 05:10:11 2017
New Revision: 1777065

URL: http://svn.apache.org/viewvc?rev=1777065&view=rev
Log:
Javadoc formatting. There is no significant code change in this commit.

Modified:
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureTypeInfo.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NamedIdentifier.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractName.java

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureTypeInfo.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureTypeInfo.java?rev=1777065&r1=1777064&r2=1777065&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureTypeInfo.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureTypeInfo.java
[UTF-8] Tue Jan  3 05:10:11 2017
@@ -44,6 +44,9 @@ import static org.apache.sis.internal.me
  * @since   0.5
  * @version 0.5
  * @module
+ *
+ * @see org.apache.sis.storage.FeatureNaming
+ * @see org.apache.sis.feature.DefaultFeatureType
  */
 @XmlType(name = "MD_FeatureTypeInfo", propOrder = {
     "featureTypeName",

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NamedIdentifier.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NamedIdentifier.java?rev=1777065&r1=1777064&r2=1777065&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NamedIdentifier.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/referencing/NamedIdentifier.java
[UTF-8] Tue Jan  3 05:10:11 2017
@@ -19,6 +19,7 @@ package org.apache.sis.referencing;
 import java.util.Map;
 import java.util.List;
 import java.util.Locale;
+import java.util.Objects;
 import java.io.IOException;
 import java.io.ObjectInputStream;
 import java.io.ObjectOutputStream;
@@ -38,9 +39,6 @@ import org.apache.sis.internal.util.Cita
 import org.apache.sis.metadata.iso.ImmutableIdentifier;
 import org.apache.sis.util.ArgumentChecks;
 
-// Branch-dependent imports
-import java.util.Objects;
-
 
 /**
  * An identification of a CRS object which is both a {@link Identifier} and a {@link GenericName}.
@@ -90,6 +88,10 @@ import java.util.Objects;
  * @since   0.4
  * @version 0.7
  * @module
+ *
+ * @see org.apache.sis.metadata.iso.DefaultIdentifier
+ * @see org.apache.sis.util.iso.AbstractName
+ * @see AbstractIdentifiedObject#getName()
  */
 public class NamedIdentifier extends ImmutableIdentifier implements GenericName {
     /**
@@ -117,7 +119,7 @@ public class NamedIdentifier extends Imm
      * {@link #tip()}, {@link #head()}, {@link #scope()} and similar methods will delegate
      * to that name.</p>
      *
-     * @param identifier The identifier to copy.
+     * @param  identifier  the identifier to copy.
      */
     public NamedIdentifier(final Identifier identifier) {
         super(identifier);
@@ -132,7 +134,7 @@ public class NamedIdentifier extends Imm
      * (code, codespace and authority) from the given name. Calls to name-related methods
like {@link #tip()},
      * {@link #head()} and {@link #scope()} will delegate to the given name.
      *
-     * @param name The name to wrap.
+     * @param  name  the name to wrap.
      */
     public NamedIdentifier(final GenericName name) {
         super(name instanceof Identifier ? (Identifier) name : new NameToIdentifier(name));
@@ -196,7 +198,7 @@ public class NamedIdentifier extends Imm
      * are optional. If a {@code "name"} property is provided, then calls to name-related
methods like
      * {@link #tip()}, {@link #head()} and {@link #scope()} will delegate to the given name.
      *
-     * @param  properties The properties to be given to this identifier.
+     * @param  properties  the properties to be given to this identifier.
      * @throws InvalidParameterValueException if a property has an invalid value.
      * @throws IllegalArgumentException if a property is invalid for some other reason.
      */
@@ -215,17 +217,17 @@ public class NamedIdentifier extends Imm
      * string will be used for the {@link #getName() name} property.</p>
      *
      * @param authority
-     *          Organization or party responsible for definition and maintenance of the code
-     *          space or code, or {@code null} if not available.
+     *          organization or party responsible for definition and maintenance of the code
space or code,
+     *          or {@code null} if not available.
      * @param code
-     *          Identifier code or name, optionally from a controlled list or pattern defined
by
-     *          the authority. The code can not be null.
+     *          identifier code or name, optionally from a controlled list or pattern defined
by the authority.
+     *          The code can not be null.
      */
     public NamedIdentifier(final Citation authority, final CharSequence code) {
         super(authority, Citations.getCodeSpace(authority), toString(code));
         if (code instanceof InternationalString) {
             name = createName(authority, super.getCodeSpace(), code);
-            isNameSupplied = true;      // Because 'code' is an international string.
+            isNameSupplied = true;                              // Because 'code' is an international
string.
         }
     }
 
@@ -238,19 +240,19 @@ public class NamedIdentifier extends Imm
      * string will be used for the {@link #getName() name} property.</p>
      *
      * @param authority
-     *          Organization or party responsible for definition and maintenance of the code
-     *          space or code, or {@code null} if not available.
+     *          organization or party responsible for definition and maintenance of the code
space or code,
+     *          or {@code null} if not available.
      * @param codeSpace
-     *          Name or identifier of the person or organization responsible for namespace,
or
-     *          {@code null} if not available. This is often an abbreviation of the authority
name.
+     *          name or identifier of the person or organization responsible for namespace,
or {@code null}
+     *          if not available. This is often an abbreviation of the authority name.
      * @param code
-     *          Identifier code or name, optionally from a controlled list or pattern defined
by
-     *          a code space. The code can not be null.
+     *          identifier code or name, optionally from a controlled list or pattern defined
by a code space.
+     *          The code can not be null.
      * @param version
-     *          The version of the associated code space or code as specified by the code
authority,
+     *          the version of the associated code space or code as specified by the code
authority,
      *          or {@code null} if none.
      * @param description
-     *          Natural language description of the meaning of the code value, or {@code
null} if none.
+     *          natural language description of the meaning of the code value, or {@code
null} if none.
      */
     public NamedIdentifier(final Citation authority, final String codeSpace, final CharSequence
code,
             final String version, final InternationalString description)
@@ -258,7 +260,7 @@ public class NamedIdentifier extends Imm
         super(authority, codeSpace, toString(code), version, description);
         if (code instanceof InternationalString) {
             name = createName(authority, codeSpace, code);
-            isNameSupplied = true;      // Because 'code' is an international string.
+            isNameSupplied = true;                              // Because 'code' is an international
string.
         }
     }
 
@@ -304,10 +306,10 @@ public class NamedIdentifier extends Imm
     /**
      * Constructs a generic name from the specified authority and code.
      *
-     * @param  authority The authority, or {@code null} if none.
-     * @param  codeSpace The code space, or {@code null} if none.
-     * @param  code      The code.
-     * @return A new generic name for the given authority and code.
+     * @param  authority  the authority, or {@code null} if none.
+     * @param  codeSpace  the code space, or {@code null} if none.
+     * @param  code       the code.
+     * @return a new generic name for the given authority and code.
      * @category Generic name
      *
      * @see <a href="https://issues.apache.org/jira/browse/SIS-197">SIS-197</a>
@@ -328,7 +330,7 @@ public class NamedIdentifier extends Imm
      * The last element in the sequence of {@linkplain #getParsedNames() parsed names}.
      * By default, this is the same value than the {@linkplain #getCode() code} provided
as a local name.
      *
-     * @return The last element in the list of {@linkplain #getParsedNames() parsed names}.
+     * @return the last element in the list of {@linkplain #getParsedNames() parsed names}.
      *
      * @see #getCode()
      */
@@ -341,7 +343,7 @@ public class NamedIdentifier extends Imm
      * Returns the first element in the sequence of {@linkplain #getParsedNames() parsed
names}.
      * By default, this is the same value than the {@linkplain #getCodeSpace() code space}
provided as a local name.
      *
-     * @return The first element in the list of {@linkplain #getParsedNames() parsed names}.
+     * @return the first element in the list of {@linkplain #getParsedNames() parsed names}.
      *
      * @see #scope()
      * @see #getCodeSpace()
@@ -358,7 +360,7 @@ public class NamedIdentifier extends Imm
      * @see #head()
      * @see #getAuthority()
      *
-     * @return The scope of this name.
+     * @return the scope of this name.
      */
     @Override
     public NameSpace scope() {
@@ -368,7 +370,7 @@ public class NamedIdentifier extends Imm
     /**
      * Returns the depth of this name within the namespace hierarchy.
      *
-     * @return The depth of this name.
+     * @return the depth of this name.
      */
     @Override
     public int depth() {
@@ -380,7 +382,7 @@ public class NamedIdentifier extends Imm
      * The length of this sequence is the {@linkplain #depth() depth}.
      * It does not include the {@linkplain #scope() scope}.
      *
-     * @return The local names making this generic name, without the {@linkplain #scope()
scope}.
+     * @return the local names making this generic name, without the {@linkplain #scope()
scope}.
      *         Shall never be {@code null} neither empty.
      */
     @Override
@@ -403,7 +405,7 @@ public class NamedIdentifier extends Imm
     /**
      * Returns a view of this name as a fully-qualified name.
      *
-     * @return The fully-qualified name (never {@code null}).
+     * @return the fully-qualified name (never {@code null}).
      */
     @Override
     public GenericName toFullyQualifiedName() {
@@ -417,7 +419,7 @@ public class NamedIdentifier extends Imm
      * If no international string is available, then this method returns an implementation
mapping
      * to {@code toString()} for all locales.
      *
-     * @return A localizable string representation of this name.
+     * @return a localizable string representation of this name.
      */
     @Override
     public InternationalString toInternationalString() {
@@ -429,7 +431,7 @@ public class NamedIdentifier extends Imm
      * is local-independent. It contains all elements listed by {@link #getParsedNames()}
      * separated by a namespace-dependent character (usually {@code :} or {@code /}).
      *
-     * @return A local-independent string representation of this generic name.
+     * @return a local-independent string representation of this generic name.
      *
      * @see IdentifiedObjects#toString(Identifier)
      */
@@ -443,7 +445,7 @@ public class NamedIdentifier extends Imm
      * zero, or a positive integer as this name lexicographically precedes, is equal to,
      * or follows the specified object.
      *
-     * @param object The object to compare with.
+     * @param  object  the object to compare with.
      * @return -1 if this identifier precedes the given object, +1 if it follows it.
      */
     @Override
@@ -454,7 +456,7 @@ public class NamedIdentifier extends Imm
     /**
      * Compares this identifier with the specified object for equality.
      *
-     * @param object The object to compare with this name.
+     * @param  object  the object to compare with this name.
      * @return {@code true} if the given object is equal to this name.
      */
     @Override
@@ -488,8 +490,8 @@ public class NamedIdentifier extends Imm
      * Invoked on serialization for writing the {@linkplain #name} if it was supplied by
the user.
      * Otherwise, we will let {@link #getName()} recompute the name only when needed.
      *
-     * @param  out The output stream where to serialize this named identifier.
-     * @throws IOException If an I/O error occurred while writing.
+     * @param  out  the output stream where to serialize this named identifier.
+     * @throws IOException if an I/O error occurred while writing.
      */
     private void writeObject(final ObjectOutputStream out) throws IOException {
         out.defaultWriteObject();
@@ -500,9 +502,9 @@ public class NamedIdentifier extends Imm
      * Invoked on deserialization for reading the name written by {@link #writeObject(ObjectOutputStream)},
      * if any.
      *
-     * @param  in The input stream from which to deserialize a named identifier.
-     * @throws IOException If an I/O error occurred while reading or if the stream contains
invalid data.
-     * @throws ClassNotFoundException If the class serialized on the stream is not on the
classpath.
+     * @param  in  the input stream from which to deserialize a named identifier.
+     * @throws IOException if an I/O error occurred while reading or if the stream contains
invalid data.
+     * @throws ClassNotFoundException if the class serialized on the stream is not on the
classpath.
      */
     private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException
{
         in.defaultReadObject();

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java?rev=1777065&r1=1777064&r2=1777065&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverters.java
[UTF-8] Tue Jan  3 05:10:11 2017
@@ -75,9 +75,9 @@ public final class ObjectConverters exte
     /**
      * Returns an identity converter for objects of the given type.
      *
-     * @param  <T>  The object type.
-     * @param  type The object type.
-     * @return An identity converter for objects of the given type.
+     * @param  <T>   the object type.
+     * @param  type  the object type.
+     * @return an identity converter for objects of the given type.
      */
     public static <T> ObjectConverter<T,T> identity(final Class<T> type)
{
         ArgumentChecks.ensureNonNull("type", type);
@@ -87,11 +87,11 @@ public final class ObjectConverters exte
     /**
      * Returns a converter for the specified source and target classes.
      *
-     * @param  <S> The source class.
-     * @param  <T> The target class.
-     * @param  source The source class.
-     * @param  target The target class, or {@code Object.class} for any.
-     * @return The converter from the specified source class to the target class.
+     * @param  <S>     the source class.
+     * @param  <T>     the target class.
+     * @param  source  the source class.
+     * @param  target  the target class, or {@code Object.class} for any.
+     * @return the converter from the specified source class to the target class.
      * @throws UnconvertibleObjectException if no converter is found.
      */
     public static <S,T> ObjectConverter<? super S, ? extends T> find(final Class<S>
source, final Class<T> target)
@@ -108,10 +108,10 @@ public final class ObjectConverters exte
      * consider invoking {@link #find(Class, Class)} instead in order to reuse the same converter
      * for all values to convert.
      *
-     * @param  <T>    The type of the {@code target} class.
-     * @param  value  The value to convert, or {@code null}.
-     * @param  target The target class.
-     * @return The converted value (may be {@code null}).
+     * @param  <T>     the type of the {@code target} class.
+     * @param  value   the value to convert, or {@code null}.
+     * @param  target  the target class.
+     * @return the converted value (may be {@code null}).
      * @throws UnconvertibleObjectException if the given value can not be converted.
      */
     @SuppressWarnings({"unchecked","rawtypes"})
@@ -132,13 +132,12 @@ public final class ObjectConverters exte
      * {@link Containers#derivedSet Containers.derivedSet(…)}.
      * See the javadoc of the above method for more information.
      *
-     * @param  <S>       The type of elements in the storage (original) set.
-     * @param  <E>       The type of elements in the derived set.
-     * @param  storage   The storage set containing the original elements, or {@code null}.
-     * @param  converter The converter from the elements in the storage set to the elements
-     *                   in the derived set.
-     * @return A view over the {@code storage} set containing all elements converted by the
given
-     *         converter, or {@code null} if {@code storage} was null.
+     * @param  <S>        the type of elements in the storage (original) set.
+     * @param  <E>        the type of elements in the derived set.
+     * @param  storage    the storage set containing the original elements, or {@code null}.
+     * @param  converter  the converter from the elements in the storage set to the elements
in the derived set.
+     * @return a view over the {@code storage} set containing all elements converted by the
given converter, or
+     *         {@code null} if {@code storage} was null.
      *
      * @see Containers#derivedSet(Set, ObjectConverter)
      */
@@ -155,15 +154,15 @@ public final class ObjectConverters exte
      * {@link Containers#derivedMap Containers.derivedMap(…)}.
      * See the javadoc of the above method for more information.
      *
-     * @param <SK>         The type of keys   in the storage map.
-     * @param <SV>         The type of values in the storage map.
-     * @param <K>          The type of keys   in the derived map.
-     * @param <V>          The type of values in the derived map.
-     * @param storage      The storage map containing the original entries, or {@code null}.
-     * @param keyConverter The converter from the keys in the storage map to the keys in
the derived map.
-     * @param valueConverter The converter from the values in the storage map to the values
in the derived map.
-     * @return A view over the {@code storage} map containing all entries converted by the
given
-     *         converters, or {@code null} if {@code storage} was null.
+     * @param  <SK>            the type of keys   in the storage map.
+     * @param  <SV>            the type of values in the storage map.
+     * @param  <K>             the type of keys   in the derived map.
+     * @param  <V>             the type of values in the derived map.
+     * @param  storage         the storage map containing the original entries, or {@code
null}.
+     * @param  keyConverter    the converter from the keys in the storage map to the keys
in the derived map.
+     * @param  valueConverter  the converter from the values in the storage map to the values
in the derived map.
+     * @return a view over the {@code storage} map containing all entries converted by the
given converters, or
+     *         {@code null} if {@code storage} was null.
      *
      * @see Containers#derivedMap(Map, ObjectConverter, ObjectConverter)
      */
@@ -183,13 +182,13 @@ public final class ObjectConverters exte
      * {@link Containers#derivedMap Containers.derivedMap(…)}.
      * See the javadoc of the above method for more information.
      *
-     * @param <SK>         The type of keys   in the storage map.
-     * @param <K>          The type of keys   in the derived map.
-     * @param <V>          The type of values in the storage and derived map.
-     * @param storage      The storage map containing the original entries, or {@code null}.
-     * @param keyConverter The converter from the keys in the storage map to the keys in
the derived map.
-     * @param valueType    The type of values in the storage and derived map.
-     * @return A view over the {@code storage} map containing all entries with the keys converted
+     * @param  <SK>          the type of keys   in the storage map.
+     * @param  <K>           the type of keys   in the derived map.
+     * @param  <V>           the type of values in the storage and derived map.
+     * @param  storage       the storage map containing the original entries, or {@code null}.
+     * @param  keyConverter  the converter from the keys in the storage map to the keys in
the derived map.
+     * @param  valueType     the type of values in the storage and derived map.
+     * @return a view over the {@code storage} map containing all entries with the keys converted
      *         by the given converter, or {@code null} if {@code storage} was null.
      *
      * @see Containers#derivedMap(Map, ObjectConverter, ObjectConverter)
@@ -211,14 +210,14 @@ public final class ObjectConverters exte
      * {@link Containers#derivedMap Containers.derivedMap(…)}.
      * See the javadoc of the above method for more information.
      *
-     * @param <K>          The type of keys in the storage and derived map.
-     * @param <SV>         The type of values in the storage map.
-     * @param <V>          The type of values in the derived map.
-     * @param storage      The storage map containing the original entries, or {@code null}.
-     * @param keyType      The type of keys in the storage and derived map.
-     * @param valueConverter The converter from the values in the storage map to the values
in the derived map.
-     * @return A view over the {@code storage} map containing all entries with the values
converted
-     *         by the given converter, or {@code null} if {@code storage} was null.
+     * @param  <K>             the type of keys in the storage and derived map.
+     * @param  <SV>            the type of values in the storage map.
+     * @param  <V>             the type of values in the derived map.
+     * @param  storage         the storage map containing the original entries, or {@code
null}.
+     * @param  keyType         the type of keys in the storage and derived map.
+     * @param  valueConverter  the converter from the values in the storage map to the values
in the derived map.
+     * @return a view over the {@code storage} map containing all entries with the values
converted by the given
+     *         converter, or {@code null} if {@code storage} was null.
      *
      * @see Containers#derivedMap(Map, ObjectConverter, ObjectConverter)
      */

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java?rev=1777065&r1=1777064&r2=1777065&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java
[UTF-8] Tue Jan  3 05:10:11 2017
@@ -54,7 +54,7 @@ public final class Containers extends St
      * pattern. In such cases, null collections (i.e. collections not yet instantiated) are
typically
      * considered as {@linkplain Collection#isEmpty() empty}.</p>
      *
-     * @param collection The collection to test, or {@code null}.
+     * @param  collection the collection to test, or {@code null}.
      * @return {@code true} if the given collection is null or empty, or {@code false} otherwise.
      */
     public static boolean isNullOrEmpty(final Collection<?> collection) {
@@ -70,7 +70,7 @@ public final class Containers extends St
      * pattern. In such cases, null maps (i.e. maps not yet instantiated) are typically considered
      * as {@linkplain Map#isEmpty() empty}.</p>
      *
-     * @param map The map to test, or {@code null}.
+     * @param  map  the map to test, or {@code null}.
      * @return {@code true} if the given map is null or empty, or {@code false} otherwise.
      */
     public static boolean isNullOrEmpty(final Map<?,?> map) {
@@ -87,9 +87,9 @@ public final class Containers extends St
      * Because arrays in the Java language are covariant (at the contrary of collections),
      * the list type have to be {@code <? extends E>} instead than {@code <E>}.</p>
      *
-     * @param  <E> The base type of elements in the list.
-     * @param  array The array to wrap, or {@code null} if none.
-     * @return The given array wrapped in an unmodifiable list, or {@code null} if the given
array was null.
+     * @param  <E>    the base type of elements in the list.
+     * @param  array  the array to wrap, or {@code null} if none.
+     * @return the given array wrapped in an unmodifiable list, or {@code null} if the given
array was null.
      *
      * @see java.util.Arrays#asList(Object[])
      */
@@ -109,12 +109,12 @@ public final class Containers extends St
      * Because arrays in the Java language are covariant (at the contrary of collections),
      * the list type have to be {@code <? extends E>} instead than {@code <E>}.</p>
      *
-     * @param  <E>   The type of elements in the list.
-     * @param  array The array to wrap (can not be null).
-     * @param  lower Low endpoint (inclusive) of the sublist.
-     * @param  upper High endpoint (exclusive) of the sublist.
-     * @return The given array wrapped in an unmodifiable list.
-     * @throws IndexOutOfBoundsException If the lower or upper value are out of bounds.
+     * @param  <E>    the type of elements in the list.
+     * @param  array  the array to wrap (can not be null).
+     * @param  lower  low endpoint (inclusive) of the sublist.
+     * @param  upper  high endpoint (exclusive) of the sublist.
+     * @return the given array wrapped in an unmodifiable list.
+     * @throws IndexOutOfBoundsException if the lower or upper value are out of bounds.
      */
     public static <E> List<? extends E> unmodifiableList(final E[] array, final
int lower, final int upper) {
         ArgumentChecks.ensureNonNull("array", array);
@@ -145,11 +145,11 @@ public final class Containers extends St
      * The returned set is not synchronized by itself, but is nevertheless thread-safe if
the
      * given set (including its iterator) and converter are thread-safe.</p>
      *
-     * @param  <S>       The type of elements in the storage (original) set.
-     * @param  <E>       The type of elements in the derived set.
-     * @param  storage   The storage set containing the original elements, or {@code null}.
-     * @param  converter The converter from the elements in the storage set to the elements
in the derived set.
-     * @return A view over the {@code storage} set containing all elements converted by the
given converter,
+     * @param  <S>        the type of elements in the storage (original) set.
+     * @param  <E>        the type of elements in the derived set.
+     * @param  storage    the storage set containing the original elements, or {@code null}.
+     * @param  converter  the converter from the elements in the storage set to the elements
in the derived set.
+     * @return a view over the {@code storage} set containing all elements converted by the
given converter,
      *         or {@code null} if {@code storage} was null.
      *
      * @see org.apache.sis.util.ObjectConverters#derivedSet(Set, ObjectConverter)
@@ -187,14 +187,14 @@ public final class Containers extends St
      * is not a {@code Collection} sub-type, but the derived map {@linkplain Map#keySet()
key set} and
      * {@linkplain Map#entrySet() entry set} do.</p>
      *
-     * @param <SK>         The type of keys   in the storage map.
-     * @param <SV>         The type of values in the storage map.
-     * @param <K>          The type of keys   in the derived map.
-     * @param <V>          The type of values in the derived map.
-     * @param storage      The storage map containing the original entries, or {@code null}.
-     * @param keyConverter The converter from the keys in the storage map to the keys in
the derived map.
-     * @param valueConverter The converter from the values in the storage map to the values
in the derived map.
-     * @return A view over the {@code storage} map containing all entries converted by the
given converters,
+     * @param  <SK>            the type of keys   in the storage map.
+     * @param  <SV>            the type of values in the storage map.
+     * @param  <K>             the type of keys   in the derived map.
+     * @param  <V>             the type of values in the derived map.
+     * @param  storage         the storage map containing the original entries, or {@code
null}.
+     * @param  keyConverter    the converter from the keys in the storage map to the keys
in the derived map.
+     * @param  valueConverter  the converter from the values in the storage map to the values
in the derived map.
+     * @return a view over the {@code storage} map containing all entries converted by the
given converters,
      *         or {@code null} if {@code storage} was null.
      *
      * @see org.apache.sis.util.ObjectConverters#derivedMap(Map, ObjectConverter, ObjectConverter)
@@ -224,12 +224,12 @@ public final class Containers extends St
      * kinds, as in the {@link org.apache.sis.referencing.AbstractIdentifiedObject#AbstractIdentifiedObject(Map)
      * AbstractIdentifiedObject} constructor.</p>
      *
-     * @param  <T>        The compile-time value of the {@code type} argument.
-     * @param  properties The map of properties from which to get a value, or {@code null}
if none.
-     * @param  key        The key of the property value to return. Can be {@code null} if
the map supports null key.
-     * @param  type       The expected type of the property value. Can not be null.
-     * @return The property value for the given key casted to the given type, or {@code null}
if none.
-     * @throws IllegalArgumentException If a non-null property value exists for the given
key but can
+     * @param  <T>         the compile-time value of the {@code type} argument.
+     * @param  properties  the map of properties from which to get a value, or {@code null}
if none.
+     * @param  key         the key of the property value to return. Can be {@code null} if
the map supports null key.
+     * @param  type        the expected type of the property value. Can not be null.
+     * @return the property value for the given key casted to the given type, or {@code null}
if none.
+     * @throws IllegalArgumentException if a non-null property value exists for the given
key but can
      *         not be casted to the given type.
      *
      * @see ArgumentChecks#ensureCanCast(String, Class, Object)
@@ -258,8 +258,8 @@ public final class Containers extends St
      * {@link java.util.HashSet} as well, which are built on top of {@code HashMap}.
      * However it is not needed for {@link java.util.IdentityHashMap}.</p>
      *
-     * @param count The number of elements to be put into the hash map or hash set.
-     * @return The minimal initial capacity to be given to the hash map constructor.
+     * @param  count  the number of elements to be put into the hash map or hash set.
+     * @return the minimal initial capacity to be given to the hash map constructor.
      */
     public static int hashMapCapacity(final int count) {
         int r = count >>> 2;

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractName.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractName.java?rev=1777065&r1=1777064&r2=1777065&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractName.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractName.java
[UTF-8] Tue Jan  3 05:10:11 2017
@@ -18,6 +18,7 @@ package org.apache.sis.util.iso;
 
 import java.util.List;
 import java.util.Locale;
+import java.util.Objects;
 import java.util.Iterator;
 import java.util.ConcurrentModificationException;
 import java.io.Serializable;
@@ -31,9 +32,6 @@ import org.opengis.util.InternationalStr
 import org.apache.sis.internal.system.DefaultFactories;
 import org.apache.sis.util.resources.Errors;
 
-// Branch-dependent imports
-import java.util.Objects;
-
 
 /**
  * Base class for sequence of identifiers rooted within the context of a {@linkplain DefaultNameSpace
namespace}.
@@ -50,7 +48,7 @@ import java.util.Objects;
  * This class has a natural ordering that is inconsistent with {@link #equals(Object)}.
  * See {@link #compareTo(GenericName)} for more information.
  *
- * <div class="section">Note for implemetors</div>
+ * <div class="section">Note for implementors</div>
  * Subclasses need only to implement the following methods:
  * <ul>
  *   <li>{@link #scope()}</li>
@@ -64,10 +62,15 @@ import java.util.Objects;
  * @since   0.3
  * @version 0.5
  * @module
+ *
+ * @see org.apache.sis.referencing.NamedIdentifier
+ * @see org.apache.sis.storage.FeatureNaming
+ * @see org.apache.sis.feature.AbstractIdentifiedType#getName()
+ * @see org.apache.sis.referencing.AbstractIdentifiedObject#getAlias()
  */
 
 /*
- * JAXB annotation would be @XmlType(name ="CodeType"), but this can not be used here
+ * JAXB annotation would be @XmlType(name = "CodeType"), but this can not be used here
  * since "CodeType" is used for various classes (including LocalName and ScopedName).
  */
 @XmlTransient
@@ -116,8 +119,8 @@ public abstract class AbstractName imple
      *       {@link DefaultNameFactory#createGenericName(NameSpace, CharSequence[])} method.</li>
      * </ul>
      *
-     * @param  object The object to get as a SIS implementation, or {@code null} if none.
-     * @return A SIS implementation containing the values of the given object (may be the
+     * @param  object  the object to get as a SIS implementation, or {@code null} if none.
+     * @return a SIS implementation containing the values of the given object (may be the
      *         given object itself), or {@code null} if the argument was null.
      */
     public static AbstractName castOrCopy(final GenericName object) {
@@ -159,7 +162,7 @@ public abstract class AbstractName imple
      * global scope instance (i.e. an instance for which {@link DefaultNameSpace#isGlobal()}
      * returns {@code true}) which is unique and named {@code "global"}.</p>
      *
-     * @return The scope of this name.
+     * @return the scope of this name.
      */
     @Override
     public abstract NameSpace scope();
@@ -168,7 +171,7 @@ public abstract class AbstractName imple
      * Indicates the number of levels specified by this name. The default implementation
returns
      * the size of the list returned by the {@link #getParsedNames()} method.
      *
-     * @return The depth of this name.
+     * @return the depth of this name.
      */
     @Override
     public int depth() {
@@ -189,7 +192,7 @@ public abstract class AbstractName imple
      * The length of this sequence is the {@linkplain #depth() depth}. It does not include
the
      * {@linkplain #scope() scope}.
      *
-     * @return The local names making this generic name, without the {@linkplain #scope()
scope}.
+     * @return the local names making this generic name, without the {@linkplain #scope()
scope}.
      *         Shall never be {@code null} neither empty.
      */
     @Override
@@ -203,7 +206,7 @@ public abstract class AbstractName imple
      * If {@code this} name is {@code "org.opengis.util.Record"}
      * (no matter its scope, then this method returns {@code "org"}.</div>
      *
-     * @return The first element in the list of {@linkplain #getParsedNames() parsed names}.
+     * @return the first element in the list of {@linkplain #getParsedNames() parsed names}.
      */
     @Override
     public LocalName head() {
@@ -218,7 +221,7 @@ public abstract class AbstractName imple
      * If {@code this} name is {@code "org.opengis.util.Record"}
      * (no matter its scope, then this method returns {@code "Record"}.</div>
      *
-     * @return The last element in the list of {@linkplain #getParsedNames() parsed names}.
+     * @return the last element in the list of {@linkplain #getParsedNames() parsed names}.
      */
     @Override
     public LocalName tip() {
@@ -231,7 +234,7 @@ public abstract class AbstractName imple
      * of a fully qualified name is {@linkplain DefaultNameSpace#isGlobal() global}.
      * If the scope of this name is already global, then this method returns {@code this}.
      *
-     * @return The fully-qualified name (never {@code null}).
+     * @return the fully-qualified name (never {@code null}).
      */
     @Override
     public synchronized GenericName toFullyQualifiedName() {
@@ -255,8 +258,8 @@ public abstract class AbstractName imple
      * {@code "org.opengis"}, then {@code this.push(scope)} shall return
      * {@code "org.opengis.util.Record"}.
      *
-     * @param  scope The name to use as prefix.
-     * @return A concatenation of the given scope with this name.
+     * @param  scope  the name to use as prefix.
+     * @return a concatenation of the given scope with this name.
      */
     @Override
     public ScopedName push(final GenericName scope) {
@@ -269,8 +272,8 @@ public abstract class AbstractName imple
      * We really want {@link DefaultNameSpace#headSeparator}, not {@link DefaultNameSpace#separator}.
      * See {@link DefaultNameSpace#child(CharSequence)} for details.
      *
-     * @param  name The name after which to write a separator.
-     * @return The separator to write after the given name.
+     * @param  name  the name after which to write a separator.
+     * @return the separator to write after the given name.
      */
     static String separator(final GenericName name) {
         if (name != null) {
@@ -296,7 +299,7 @@ public abstract class AbstractName imple
      *       any scope.</li>
      * </ul>
      *
-     * @return A local-independent string representation of this name.
+     * @return a local-independent string representation of this name.
      */
     @Override
     public synchronized String toString() {
@@ -325,7 +328,7 @@ public abstract class AbstractName imple
      * If no international string is available, then this method returns an implementation
mapping
      * to {@link #toString()} for all locales.
      *
-     * @return A localizable string representation of this name.
+     * @return a localizable string representation of this name.
      */
     @Override
     public synchronized InternationalString toInternationalString() {
@@ -359,8 +362,8 @@ public abstract class AbstractName imple
         /**
          * Constructs a new international string from the specified {@link AbstractName}
fields.
          *
-         * @param asString The string representation of the enclosing abstract name.
-         * @param parsedNames The value returned by {@link AbstractName#getParsedNames()}.
+         * @param  asString     the string representation of the enclosing abstract name.
+         * @param  parsedNames  the value returned by {@link AbstractName#getParsedNames()}.
          */
         International(final String asString, final List<? extends LocalName> parsedNames)
{
             super(asString);
@@ -424,7 +427,7 @@ public abstract class AbstractName imple
      *   <li>Otherwise, returns 0.</li>
      * </ul>
      *
-     * @param name The other name to compare with this name.
+     * @param  name  the other name to compare with this name.
      * @return -1 if this name precedes the given one, +1 if it follows, 0 if equals.
      */
     @Override
@@ -454,7 +457,7 @@ public abstract class AbstractName imple
      * The default implementation returns {@code true} if the {@linkplain #scope() scopes}
      * and the lists of {@linkplain #getParsedNames() parsed names} are equal.
      *
-     * @param object The object to compare with this name for equality.
+     * @param  object  the object to compare with this name for equality.
      * @return {@code true} if the given object is equal to this name.
      */
     @Override



Mime
View raw message