sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1777191 - in /sis/branches/JDK8/core: sis-metadata/src/main/java/org/apache/sis/metadata/ sis-referencing/src/main/java/org/apache/sis/internal/referencing/ sis-utility/src/main/java/org/apache/sis/util/ sis-utility/src/main/java/org/apach...
Date Tue, 03 Jan 2017 17:58:39 GMT
Author: desruisseaux
Date: Tue Jan  3 17:58:38 2017
New Revision: 1777191

URL: http://svn.apache.org/viewvc?rev=1777191&view=rev
Log:
Javadoc formatting.

Modified:
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/Cloner.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/SpecialCases.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/MergedProperties.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ArgumentChecks.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedContainer.java

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/Cloner.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/Cloner.java?rev=1777191&r1=1777190&r2=1777191&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/Cloner.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/Cloner.java
[UTF-8] Tue Jan  3 17:58:38 2017
@@ -79,8 +79,8 @@ final class Cloner extends org.apache.si
      *   <li>Otherwise, the object is assumed immutable and returned unchanged.</li>
      * </ul>
      *
-     * @param  object The object to convert in an immutable one.
-     * @return A presumed immutable view of the specified object.
+     * @param  object  the object to convert in an immutable one.
+     * @return a presumed immutable view of the specified object.
      */
     @Override
     public Object clone(final Object object) throws CloneNotSupportedException {

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java?rev=1777191&r1=1777190&r2=1777191&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
[UTF-8] Tue Jan  3 17:58:38 2017
@@ -194,9 +194,9 @@ public class MetadataStandard implements
      * <div class="note"><b>Example:</b>: For the ISO 19115 standard reflected
by GeoAPI interfaces,
      * {@code interfacePackage} shall be the {@link org.opengis.metadata} package.</div>
      *
-     * @param citation         Bibliographical reference to the international standard.
-     * @param interfacePackage The root package for metadata interfaces.
-     * @param dependencies     The dependencies to other metadata standards.
+     * @param  citation          bibliographical reference to the international standard.
+     * @param  interfacePackage  the root package for metadata interfaces.
+     * @param  dependencies      the dependencies to other metadata standards.
      */
     public MetadataStandard(final Citation citation, final Package interfacePackage, MetadataStandard...
dependencies) {
         ensureNonNull("citation",         citation);
@@ -204,7 +204,7 @@ public class MetadataStandard implements
         ensureNonNull("dependencies",     dependencies);
         this.citation         = citation;
         this.interfacePackage = interfacePackage.getName() + '.';
-        this.accessors        = new ConcurrentHashMap<>(); // Also defined in readObject(…)
+        this.accessors        = new ConcurrentHashMap<>();                        
 // Also defined in readObject(…)
         if (dependencies.length == 0) {
             this.dependencies = null;
         } else {
@@ -219,15 +219,15 @@ public class MetadataStandard implements
      * Creates a new instance working on implementation of interfaces defined in the
      * specified package. This constructor is used only for the pre-defined constants.
      *
-     * @param citation         Bibliographical reference to the international standard.
-     * @param interfacePackage The root package for metadata interfaces.
-     * @param dependencies     The dependencies to other metadata standards, or {@code null}
if none.
+     * @param  citation          bibliographical reference to the international standard.
+     * @param  interfacePackage  the root package for metadata interfaces.
+     * @param  dependencies      the dependencies to other metadata standards, or {@code
null} if none.
      */
     MetadataStandard(final String citation, final String interfacePackage, final MetadataStandard[]
dependencies) {
         this.citation         = new SimpleCitation(citation);
         this.interfacePackage = interfacePackage;
         this.accessors        = new ConcurrentHashMap<>();
-        this.dependencies     = dependencies; // No clone, since this constructor is for
internal use only.
+        this.dependencies     = dependencies;               // No clone, since this constructor
is for internal use only.
     }
 
     /**
@@ -235,7 +235,7 @@ public class MetadataStandard implements
      * This method verifies if the class is a member of the package given at construction
time or
      * a sub-package. This method does not verify if the type is supported by a dependency.
      *
-     * @param  classname The name of the type to verify.
+     * @param  classname  the name of the type to verify.
      * @return {@code true} if the given type is supported by this standard.
      */
     final boolean isSupported(final String classname) {
@@ -251,8 +251,8 @@ public class MetadataStandard implements
      * <p>The current implementation recognizes only the standards defined by the public
static
      * constants defined in this class. A future SIS version may recognize user-defined constants.</p>
      *
-     * @param  type The metadata standard interface, or an implementation class.
-     * @return The metadata standard for the given type, or {@code null} if not found.
+     * @param  type  the metadata standard interface, or an implementation class.
+     * @return the metadata standard for the given type, or {@code null} if not found.
      */
     public static MetadataStandard forClass(final Class<?> type) {
         String classname = type.getName();
@@ -286,7 +286,7 @@ public class MetadataStandard implements
      * Returns a bibliographical reference to the international standard.
      * The default implementation return the citation given at construction time.
      *
-     * @return Bibliographical reference to the international standard.
+     * @return bibliographical reference to the international standard.
      */
     public Citation getCitation() {
         return citation;
@@ -302,12 +302,11 @@ public class MetadataStandard implements
      *   <li>The value of {@link #getImplementation(Class)} after check for non-null
value.</li>
      * </ul>
      *
-     * @param  implementation The implementation class.
-     * @param  mandatory Whether this method shall throw an exception or return {@code null}
+     * @param  implementation  the implementation class.
+     * @param  mandatory  whether this method shall throw an exception or return {@code null}
      *         if no accessor is found for the given implementation class.
-     * @return The accessor for the given implementation, or {@code null} if the given class
does
-     *         not implement a metadata interface of the expected package and {@code mandatory}
-     *         is {@code false}.
+     * @return the accessor for the given implementation, or {@code null} if the given class
does not
+     *         implement a metadata interface of the expected package and {@code mandatory}
is {@code false}.
      * @throws ClassCastException if the specified class does not implement a metadata interface
      *         of the expected package and {@code mandatory} is {@code true}.
      */
@@ -326,7 +325,7 @@ public class MetadataStandard implements
          */
         final Class<?> type;
         if (value instanceof Class<?>) {
-            type = (Class<?>) value; // Stored result of previous call to findInterface(…).
+            type = (Class<?>) value;                            // Stored result of
previous call to findInterface(…).
             assert type == findInterface(implementation) : implementation;
         } else {
             /*
@@ -341,7 +340,7 @@ public class MetadataStandard implements
                     for (final MetadataStandard dependency : dependencies) {
                         final PropertyAccessor accessor = dependency.getAccessor(implementation,
false);
                         if (accessor != null) {
-                            accessors.put(implementation, accessor); // Ok to overwrite existing
instance here.
+                            accessors.put(implementation, accessor);        // Ok to overwrite
existing instance here.
                             return accessor;
                         }
                     }
@@ -375,7 +374,7 @@ public class MetadataStandard implements
      * If this method returns {@code true}, then invoking {@link #getInterface(Class)} is
guaranteed to succeed
      * without throwing an exception.
      *
-     * @param  type The implementation class (can be {@code null}).
+     * @param  type  the implementation class (can be {@code null}).
      * @return {@code true} if the given class is an interface of this standard,
      *         or implements an interface of this standard.
      */
@@ -425,8 +424,8 @@ public class MetadataStandard implements
      *
      * <p>This method ignores dependencies. Fallback on metadata standard dependencies
shall be done by the caller.</p>
      *
-     * @param  type The standard interface or the implementation class.
-     * @return The single interface, or {@code null} if none where found.
+     * @param  type  the standard interface or the implementation class.
+     * @return the single interface, or {@code null} if none where found.
      */
     private Class<?> findInterface(final Class<?> type) {
         if (type != null) {
@@ -507,11 +506,10 @@ public class MetadataStandard implements
      * The standard package is usually made of interfaces and code lists only, but this is
      * not verified by this method.</div>
      *
-     * @param  <T>  The compile-time {@code type}.
-     * @param  type The implementation class.
-     * @return The interface implemented by the given implementation class.
-     * @throws ClassCastException if the specified implementation class does
-     *         not implement an interface of this standard.
+     * @param  <T>   the compile-time {@code type}.
+     * @param  type  the implementation class.
+     * @return the interface implemented by the given implementation class.
+     * @throws ClassCastException if the specified implementation class does not implement
an interface of this standard.
      *
      * @see AbstractMetadata#getInterface()
      */
@@ -551,9 +549,9 @@ public class MetadataStandard implements
      * The default implementation returns {@code null} if every cases. Subclasses shall
      * override this method in order to map GeoAPI interfaces to their implementation.
      *
-     * @param  <T>  The compile-time {@code type}.
-     * @param  type The interface, typically from the {@code org.opengis.metadata} package.
-     * @return The implementation class, or {@code null} if none.
+     * @param  <T>   the compile-time {@code type}.
+     * @param  type  the interface, typically from the {@code org.opengis.metadata} package.
+     * @return the implementation class, or {@code null} if none.
      */
     public <T> Class<? extends T> getImplementation(final Class<T> type)
{
         return null;
@@ -574,7 +572,7 @@ public class MetadataStandard implements
      *   MetadataStandard standard = MetadataStandard.ISO_19115;
      *   Map<String, String> names = standard.asNameMap(Citation.class, UML_IDENTIFIER,
JAVABEANS_PROPERTY);
      *   String value = names.get("alternateTitle");
-     *   System.out.println(value); // alternateTitles
+     *   System.out.println(value);                   // alternateTitles
      * }
      * </div>
      *
@@ -582,10 +580,10 @@ public class MetadataStandard implements
      * No matter the key name policy, the {@code key} argument given to any {@link Map} method
can be any of the
      * above-cited forms of property names.
      *
-     * @param  type        The interface or implementation class of a metadata.
-     * @param  keyPolicy   Determines the string representation of map keys.
-     * @param  valuePolicy Determines the string representation of map values.
-     * @return The names of all properties defined by the given metadata type.
+     * @param  type         the interface or implementation class of a metadata.
+     * @param  keyPolicy    determines the string representation of map keys.
+     * @param  valuePolicy  determines the string representation of map values.
+     * @return the names of all properties defined by the given metadata type.
      * @throws ClassCastException if the specified interface or implementation class does
      *         not extend or implement a metadata interface of the expected package.
      */
@@ -616,14 +614,14 @@ public class MetadataStandard implements
      *   MetadataStandard  standard = MetadataStandard.ISO_19115;
      *   Map<String,Class<?>> types = standard.asTypeMap(Citation.class, UML_IDENTIFIER,
ELEMENT_TYPE);
      *   Class<?> value = types.get("alternateTitle");
-     *   System.out.println(value);  // class org.opengis.util.InternationalString
+     *   System.out.println(value);                       // class org.opengis.util.InternationalString
      * }
      *
-     * @param  type        The interface or implementation class of a metadata.
-     * @param  keyPolicy   Determines the string representation of map keys.
-     * @param  valuePolicy Whether the values shall be property types, the element types
+     * @param  type         the interface or implementation class of a metadata.
+     * @param  keyPolicy    determines the string representation of map keys.
+     * @param  valuePolicy  whether the values shall be property types, the element types
      *         (same as property types except for collections) or the declaring interface
or class.
-     * @return The types or declaring type of all properties defined in the given metadata
type.
+     * @return the types or declaring type of all properties defined in the given metadata
type.
      * @throws ClassCastException if the specified interface or implementation class does
      *         not extend or implement a metadata interface of the expected package.
      */
@@ -677,11 +675,10 @@ public class MetadataStandard implements
      *   <li>{@link org.apache.sis.measure.NumberRange} if the valid values are constrained
to some specific range.</li>
      * </ul>
      *
-     * @param  type      The metadata interface or implementation class.
-     * @param  keyPolicy Determines the string representation of map keys.
-     * @return Information about all properties defined in the given metadata type.
-     * @throws ClassCastException if the given type doesn't implement a metadata
-     *         interface of the expected package.
+     * @param  type       the metadata interface or implementation class.
+     * @param  keyPolicy  determines the string representation of map keys.
+     * @return information about all properties defined in the given metadata type.
+     * @throws ClassCastException if the given type does not implement a metadata interface
of the expected package.
      *
      * @see org.apache.sis.metadata.iso.DefaultExtendedElementInformation
      */
@@ -730,13 +727,11 @@ public class MetadataStandard implements
      * values, then make sure that the given value is a collection when the associated metadata
property expects
      * such collection.
      *
-     * @param  metadata The metadata object to view as a map.
-     * @param  keyPolicy Determines the string representation of map keys.
-     * @param  valuePolicy Whether the entries having null value or empty collection shall
be
-     *         included in the map.
-     * @return A map view over the metadata object.
-     * @throws ClassCastException if the metadata object doesn't implement a metadata
-     *         interface of the expected package.
+     * @param  metadata     the metadata object to view as a map.
+     * @param  keyPolicy    determines the string representation of map keys.
+     * @param  valuePolicy  whether the entries having null value or empty collection shall
be included in the map.
+     * @return a map view over the metadata object.
+     * @throws ClassCastException if the metadata object does not implement a metadata interface
of the expected package.
      *
      * @see AbstractMetadata#asMap()
      */
@@ -804,12 +799,10 @@ public class MetadataStandard implements
      * Note that whether the child appears as effectively removed from the node or just cleared
      * (i.e. associated to a null value) depends on the {@code valuePolicy} argument.
      *
-     * @param  metadata The metadata object to view as a tree table.
-     * @param  valuePolicy Whether the property having null value or empty collection shall
be
-     *         included in the tree.
-     * @return A tree table representation of the specified metadata.
-     * @throws ClassCastException if the metadata object doesn't implement a metadata
-     *         interface of the expected package.
+     * @param  metadata     the metadata object to view as a tree table.
+     * @param  valuePolicy  whether the property having null value or empty collection shall
be included in the tree.
+     * @return a tree table representation of the specified metadata.
+     * @throws ClassCastException if the metadata object does not implement a metadata interface
of the expected package.
      *
      * @see AbstractMetadata#asTreeTable()
      */
@@ -848,12 +841,12 @@ public class MetadataStandard implements
      * delegate their work to this {@code standard.equals(…)} method, as {@link AbstractMetadata}
does.
      * In the later case, the final result is a deep comparison.
      *
-     * @param metadata1 The first metadata object to compare.
-     * @param metadata2 The second metadata object to compare.
-     * @param mode      The strictness level of the comparison.
+     * @param  metadata1  the first metadata object to compare.
+     * @param  metadata2  the second metadata object to compare.
+     * @param  mode       the strictness level of the comparison.
      * @return {@code true} if the given metadata objects are equals.
-     * @throws ClassCastException if at least one metadata object don't
-     *         implements a metadata interface of the expected package.
+     * @throws ClassCastException if at least one metadata object does not
+     *         implement a metadata interface of the expected package.
      *
      * @see AbstractMetadata#equals(Object, ComparisonMode)
      */
@@ -919,10 +912,9 @@ public class MetadataStandard implements
      * This is a similar contract than {@link java.util.Set#hashCode()} (except for the interface)
      * and ensures that the hash code value is insensitive to the ordering of properties.
      *
-     * @param  metadata The metadata object to compute hash code.
-     * @return A hash code value for the specified metadata, or 0 if the given metadata is
null.
-     * @throws ClassCastException if the metadata object doesn't implement a metadata
-     *         interface of the expected package.
+     * @param  metadata  the metadata object to compute hash code.
+     * @return a hash code value for the specified metadata, or 0 if the given metadata is
null.
+     * @throws ClassCastException if the metadata object does not implement a metadata interface
of the expected package.
      *
      * @see AbstractMetadata#hashCode()
      */
@@ -971,16 +963,16 @@ public class MetadataStandard implements
             field.setAccessible(true);
             field.set(this, new ConcurrentHashMap<>());
         } catch (ReflectiveOperationException e) {
-            throw new AssertionError(e); // Should never happen (tested by MetadataStandardTest).
+            throw new AssertionError(e);                // Should never happen (tested by
MetadataStandardTest).
         }
     }
 
     /**
      * Invoked during deserialization for restoring the transient fields.
      *
-     * @param  in The input stream from which to deserialize a metadata standard.
-     * @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 metadata standard.
+     * @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-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java?rev=1777191&r1=1777190&r2=1777191&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyInformation.java
[UTF-8] Tue Jan  3 17:58:38 2017
@@ -117,13 +117,13 @@ final class PropertyInformation<E> exten
     /**
      * Creates a new {@code PropertyInformation} instance from the annotations on the given
getter method.
      *
-     * @param  standard    The international standard that define the property, or {@code
null} if none.
-     * @param  property    The property name as defined by the international {@code standard}.
-     * @param  getter      The getter method defined in the interface.
-     * @param  elementType The value type, either the method return type if not a collection,
-     *                     or the type of elements in the collection otherwise.
-     * @param  range       The range of valid values, or {@code null} if none. This information
is associated to the
-     *                     implementation method rather than the interface one, because it
is specific to SIS.
+     * @param  standard     the international standard that define the property, or {@code
null} if none.
+     * @param  property     the property name as defined by the international {@code standard}.
+     * @param  getter       the getter method defined in the interface.
+     * @param  elementType  the value type, either the method return type if not a collection,
+     *                      or the type of elements in the collection otherwise.
+     * @param  range        the range of valid values, or {@code null} if none. This information
is associated to the
+     *                      implementation method rather than the interface one, because
it is specific to SIS.
      */
     @SuppressWarnings({"unchecked","rawtypes"})
     PropertyInformation(final Citation standard, final String property, final Method getter,
@@ -348,7 +348,7 @@ final class PropertyInformation<E> exten
     /**
      * Compares the given object with this element information for equality.
      *
-     * @param  obj The object to compare with this element information for equality.
+     * @param  obj  the object to compare with this element information for equality.
      * @return {@code true} if both objects are equal.
      */
     @Override
@@ -378,8 +378,7 @@ final class PropertyInformation<E> exten
     }
 
     /**
-     * Invoked by {@link #toString()} in order to append additional information
-     * after the identifier.
+     * Invoked by {@link #toString()} in order to append additional information after the
identifier.
      */
     @Override
     protected void appendToString(final StringBuilder buffer) {

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/SpecialCases.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/SpecialCases.java?rev=1777191&r1=1777190&r2=1777191&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/SpecialCases.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/SpecialCases.java
[UTF-8] Tue Jan  3 17:58:38 2017
@@ -43,10 +43,10 @@ final class SpecialCases extends Propert
     /**
      * Creates a new property accessor for the specified metadata implementation.
      *
-     * @param  standard The standard which define the {@code type} interface.
-     * @param  type The interface implemented by the metadata, which must be
-     *         the value returned by {@link #getStandardType(Class, String)}.
-     * @param  implementation The class of metadata implementations, or {@code type} if none.
+     * @param  standard        the standard which define the {@code type} interface.
+     * @param  type            the interface implemented by the metadata, which must be
+     *                         the value returned by {@link #getStandardType(Class, String)}.
+     * @param  implementation  the class of metadata implementations, or {@code type} if
none.
      */
     SpecialCases(final Citation standard, final Class<?> type, final Class<?>
implementation) {
         super(standard, type, implementation);
@@ -60,7 +60,7 @@ final class SpecialCases extends Propert
     /**
      * Returns {@code true} if the given class is a special case handled by the {@link SpecialCases}
class.
      *
-     * @param  type The interface implemented by the metadata.
+     * @param  type  the interface implemented by the metadata.
      * @return {@code true} if the given type is a special case.
      */
     static boolean isSpecialCase(final Class<?> type) {

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java?rev=1777191&r1=1777190&r2=1777191&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/TreeNode.java
[UTF-8] Tue Jan  3 17:58:38 2017
@@ -144,8 +144,8 @@ class TreeNode implements Node {
     /**
      * Creates the root node of a new metadata tree table.
      *
-     * @param  table    The table which is creating this root node.
-     * @param  metadata The root metadata object (can not be null).
+     * @param  table     the table which is creating this root node.
+     * @param  metadata  the root metadata object (can not be null).
      */
     TreeNode(final TreeTableView table, final Object metadata) {
         this.table    = table;
@@ -158,8 +158,8 @@ class TreeNode implements Node {
      * This constructor is for the {@link Element} subclass only.
      * Callers must invoke {@link #init()} after construction.
      *
-     * @param  parent   The parent of this node.
-     * @param  metadata The metadata object for which this node will be a value.
+     * @param  parent    the parent of this node.
+     * @param  metadata  the metadata object for which this node will be a value.
      */
     TreeNode(final TreeNode parent, final Object metadata) {
         this.table    = parent.table;
@@ -241,7 +241,7 @@ class TreeNode implements Node {
     /**
      * Sets the metadata value for this node. Subclasses must override this method.
      *
-     * @throws UnsupportedOperationException If the metadata value is not writable.
+     * @throws UnsupportedOperationException if the metadata value is not writable.
      */
     void setUserObject(final Object value) throws UnsupportedOperationException {
         throw new UnsupportedOperationException(unmodifiableCellValue(TableColumn.VALUE));
@@ -286,10 +286,10 @@ class TreeNode implements Node {
          * Creates a new child for a property of the given metadata at the given index.
          * Callers must invoke {@link #init()} after construction.
          *
-         * @param  parent      The parent of this node.
-         * @param  metadata    The metadata object for which this node will be a value.
-         * @param  accessor    Accessor to use for fetching the name, type and value.
-         * @param  indexInData Index to be given to the accessor of fetching the value.
+         * @param  parent       the parent of this node.
+         * @param  metadata     the metadata object for which this node will be a value.
+         * @param  accessor     accessor to use for fetching the name, type and value.
+         * @param  indexInData  index to be given to the accessor of fetching the value.
          */
         Element(final TreeNode parent, final Object metadata,
                 final PropertyAccessor accessor, final int indexInData)
@@ -376,11 +376,11 @@ class TreeNode implements Node {
          * Creates a new node for the given collection element.
          * Callers must invoke {@link #init()} after construction.
          *
-         * @param  parent      The parent of this node.
-         * @param  metadata    The metadata object for which this node will be a value.
-         * @param  accessor    Accessor to use for fetching the name, type and collection.
-         * @param  indexInData Index to be given to the accessor of fetching the collection.
-         * @param  indexInList Index of the element in the collection, in iteration order.
+         * @param  parent       the parent of this node.
+         * @param  metadata     the metadata object for which this node will be a value.
+         * @param  accessor     accessor to use for fetching the name, type and collection.
+         * @param  indexInData  index to be given to the accessor of fetching the collection.
+         * @param  indexInList  index of the element in the collection, in iteration order.
          */
         CollectionElement(final TreeNode parent, final Object metadata,
                 final PropertyAccessor accessor, final int indexInData, final int indexInList)
@@ -520,6 +520,7 @@ class TreeNode implements Node {
      * Only metadata object can have children.
      */
     @Override
+    @SuppressWarnings("ReturnOfCollectionOrArrayField")
     public final Collection<Node> getChildren() {
         /*
          * 'children' is set to LEAF if an only if the node *can not* have children,
@@ -574,7 +575,7 @@ class TreeNode implements Node {
      * Do not keep a reference to the returned node for a long time, since it is only
      * a proxy toward the real node to be created once the identifier is known.
      *
-     * @throws UnsupportedOperationException If this node {@linkplain #isLeaf() is a leaf}.
+     * @throws UnsupportedOperationException if this node {@linkplain #isLeaf() is a leaf}.
      */
     @Override
     public final Node newChild() throws UnsupportedOperationException {
@@ -699,7 +700,7 @@ class TreeNode implements Node {
         if (column == TableColumn.VALUE) {
             if (isLeaf()) {
                 value = cachedValue;
-                cachedValue = null; // Use the cached value only once after iteration.
+                cachedValue = null;                 // Use the cached value only once after
iteration.
                 if (value == null) {
                     value = getUserObject();
                 }
@@ -772,8 +773,7 @@ class TreeNode implements Node {
     }
 
     /**
-     * Implementation of {@link #toString()} appending the string representation
-     * in the given buffer.
+     * Implementation of {@link #toString()} appending the string representation in the given
buffer.
      */
     final void toString(final StringBuilder buffer) {
         appendIdentifier(buffer.append("Node["));

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/MergedProperties.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/MergedProperties.java?rev=1777191&r1=1777190&r2=1777191&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/MergedProperties.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/MergedProperties.java
[UTF-8] Tue Jan  3 17:58:38 2017
@@ -52,8 +52,8 @@ public class MergedProperties extends Ab
     /**
      * Creates a new map which will merge the given properties on the fly.
      *
-     * @param properties The user-supplied properties.
-     * @param defaultProperties Fallback for values not found in {@code properties}.
+     * @param properties         the user-supplied properties.
+     * @param defaultProperties  fallback for values not found in {@code properties}.
      */
     public MergedProperties(final Map<String,?> properties, final Map<String,?>
defaultProperties) {
         this.properties = properties;
@@ -64,7 +64,7 @@ public class MergedProperties extends Ab
      * Returns an iterator over the user-supplied properties together with
      * the default properties which were not specified in the user's ones.
      *
-     * @return Iterator over merged properties.
+     * @return iterator over merged properties.
      */
     @Override
     protected EntryIterator<String,Object> entryIterator() {
@@ -81,8 +81,8 @@ public class MergedProperties extends Ab
      * then by looking in the default properties if no value were specified in the user map.
      * If there is no default value, invokes {@link #invisibleEntry(Object)} in last resort.
      *
-     * @param  key The key for which to get the value.
-     * @return The value associated to the given key, or {@code null} if none.
+     * @param  key  the key for which to get the value.
+     * @return the value associated to the given key, or {@code null} if none.
      */
     @Override
     public Object get(final Object key) {
@@ -106,8 +106,8 @@ public class MergedProperties extends Ab
      * of derived or projected CRS (because of the way we implemented derived CRS). But this
is somewhat specific to
      * SIS, so we do no want to expose this implementation details.</div>
      *
-     * @param  key The key for which to get the value.
-     * @return The value associated to the given key, or {@code null} if none.
+     * @param  key  the key for which to get the value.
+     * @return the value associated to the given key, or {@code null} if none.
      */
     protected Object invisibleEntry(final Object key) {
         return null;

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ArgumentChecks.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ArgumentChecks.java?rev=1777191&r1=1777190&r2=1777191&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ArgumentChecks.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/ArgumentChecks.java
[UTF-8] Tue Jan  3 17:58:38 2017
@@ -169,10 +169,10 @@ public final class ArgumentChecks extend
      * If this method does not thrown an exception, then the value can be casted to the class
      * represented by {@code expectedType} without throwing a {@link ClassCastException}.
      *
-     * @param  name  the name of the argument to be checked, used only if an exception is
thrown.
-     *         Can be {@code null} if the name is unknown.
-     * @param  expectedType the expected type (class or interface).
-     * @param  value  the value to check, or {@code null}.
+     * @param  name          the name of the argument to be checked, used only if an exception
is thrown.
+     *                       Can be {@code null} if the name is unknown.
+     * @param  expectedType  the expected type (class or interface).
+     * @param  value         the value to check, or {@code null}.
      * @throws IllegalArgumentException if {@code value} is non-null and is not assignable
to the given type.
      *
      * @see org.apache.sis.util.collection.Containers#property(Map, Object, Class)
@@ -204,8 +204,7 @@ public final class ArgumentChecks extend
      *
      * @param  upper  the maximal index value, exclusive.
      * @param  index  the index to check.
-     * @throws IndexOutOfBoundsException if the given index is negative or not lower than
the
-     *         given upper value.
+     * @throws IndexOutOfBoundsException if the given index is negative or not lower than
the given upper value.
      *
      * @see #ensurePositive(String, int)
      */

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java?rev=1777191&r1=1777190&r2=1777191&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java [UTF-8]
(original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Utilities.java [UTF-8]
Tue Jan  3 17:58:38 2017
@@ -29,7 +29,7 @@ import org.apache.sis.util.collection.Ch
 /**
  * Static methods for object comparisons in different ways (deeply, approximatively, <i>etc</i>).
  *
- * @author Martin Desruisseaux (IRD, Geomatys)
+ * @author  Martin Desruisseaux (IRD, Geomatys)
  * @since   0.3
  * @version 0.3
  * @module
@@ -220,8 +220,7 @@ public final class Utilities extends Sta
     }
 
     /**
-     * Compares two collections. Order are significant, unless both collections implement
the
-     * {@link Set} interface.
+     * Compares two collections. Order are significant, unless both collections implement
the {@link Set} interface.
      */
     private static boolean equals(final Iterable<?> object1, final Iterable<?>
object2, final ComparisonMode mode) {
         final Iterator<?> it1 = object1.iterator();
@@ -284,7 +283,7 @@ public final class Utilities extends Sta
      * Returns an assertion error message for mismatched types.
      *
      * @param  expected  the expected type.
-     * @param  actual  the actual object (not its type).
+     * @param  actual    the actual object (not its type).
      * @return the error message to use in assertions.
      */
     private static String mismatchedType(final Class<?> expected, final Object actual)
{

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedContainer.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedContainer.java?rev=1777191&r1=1777190&r2=1777191&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedContainer.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedContainer.java
[UTF-8] Tue Jan  3 17:58:38 2017
@@ -16,12 +16,14 @@
  */
 package org.apache.sis.util.collection;
 
+import java.util.Collection;
+
 
 /**
  * A container that ensures that all elements are assignable to a given base type.
- * Checked containers are usually {@link java.util.Collection}, but not always.
+ * Checked containers are usually {@link Collection}, but not always.
  *
- * @param <E> The base type of elements in the container.
+ * @param  <E>  the base type of elements in the container.
  *
  * @author  Martin Desruisseaux (IRD, Geomatys)
  * @since   0.3
@@ -32,7 +34,7 @@ public interface CheckedContainer<E> {
     /**
      * Returns the base type of all elements in this container.
      *
-     * @return The element type.
+     * @return the element type.
      */
     Class<E> getElementType();
 }



Mime
View raw message