sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1755223 - in /sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature: AbstractFeature.java DenseFeature.java
Date Thu, 04 Aug 2016 17:50:59 GMT
Author: desruisseaux
Date: Thu Aug  4 17:50:59 2016
New Revision: 1755223

URL: http://svn.apache.org/viewvc?rev=1755223&view=rev
Log:
Javadoc (no code change).

Modified:
    sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractFeature.java
    sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DenseFeature.java

Modified: sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractFeature.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractFeature.java?rev=1755223&r1=1755222&r2=1755223&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractFeature.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/AbstractFeature.java
[UTF-8] Thu Aug  4 17:50:59 2016
@@ -349,6 +349,11 @@ public abstract class AbstractFeature im
      * number of occurrences} and does not depend on the actual number of values. If an attribute
allows more than one
      * value, then this method will always return a collection for that attribute even if
the collection is empty.</div>
      *
+     * In the case of multi-valued properties (“max. occurs” &gt; 1), the collection
returned by this method may
+     * or may not be modifiable, at implementation choice. Generally the caller can not add
new elements into the
+     * returned collection anyway since {@code Collection<?>} does not allow such operations,
and more specific
+     * casts (e.g. {@code Collection<String>} can not be checked at runtime (at least
as of Java 8).
+     *
      * @param  name  the property name.
      * @return the value for the given property, or {@code null} if none.
      * @throws PropertyNotFoundException if the given argument is not an attribute or association
name of this feature.

Modified: sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DenseFeature.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DenseFeature.java?rev=1755223&r1=1755222&r2=1755223&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DenseFeature.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DenseFeature.java
[UTF-8] Thu Aug  4 17:50:59 2016
@@ -82,8 +82,8 @@ final class DenseFeature extends Abstrac
      * Returns the index for the property of the given name, or {@link DefaultFeatureType#OPERATION_INDEX}
      * if the property is a parameterless operation.
      *
-     * @param  name The property name.
-     * @return The index for the property of the given name,
+     * @param  name  the property name.
+     * @return the index for the property of the given name,
      *         or a negative value if the property is a parameterless operation.
      * @throws PropertyNotFoundException if the given argument is not a property name of
this feature.
      */
@@ -98,9 +98,9 @@ final class DenseFeature extends Abstrac
     /**
      * Returns the property (attribute, operation or association) of the given name.
      *
-     * @param  name The property name.
-     * @return The property of the given name.
-     * @throws PropertyNotFoundException If the given argument is not a property name of
this feature.
+     * @param  name  the property name.
+     * @return the property of the given name.
+     * @throws PropertyNotFoundException if the given argument is not a property name of
this feature.
      */
     @Override
     public Property getProperty(final String name) throws PropertyNotFoundException {
@@ -131,7 +131,7 @@ final class DenseFeature extends Abstrac
     /**
      * Sets the property (attribute, operation or association).
      *
-     * @param  property The property to set.
+     * @param  property  the property to set.
      * @throws IllegalArgumentException if the type of the given property is not one of the
types
      *         known to this feature, or if the property can not be set or another reason.
      */
@@ -174,9 +174,9 @@ final class DenseFeature extends Abstrac
     /**
      * Returns the value for the property of the given name.
      *
-     * @param  name The property name.
-     * @return The value for the given property, or {@code null} if none.
-     * @throws PropertyNotFoundException If the given argument is not an attribute or association
name of this feature.
+     * @param  name  the property name.
+     * @return the value for the given property, or {@code null} if none.
+     * @throws PropertyNotFoundException if the given argument is not an attribute or association
name of this feature.
      */
     @Override
     public Object getPropertyValue(final String name) throws PropertyNotFoundException {
@@ -205,10 +205,10 @@ final class DenseFeature extends Abstrac
     /**
      * Sets the value for the property of the given name.
      *
-     * @param  name  The attribute name.
-     * @param  value The new value for the given attribute (may be {@code null}).
-     * @throws ClassCastException If the value is not assignable to the expected value class.
-     * @throws IllegalArgumentException If the given value can not be assigned for another
reason.
+     * @param  name   the attribute name.
+     * @param  value  the new value for the given attribute (may be {@code null}).
+     * @throws ClassCastException if the value is not assignable to the expected value class.
+     * @throws IllegalArgumentException if the given value can not be assigned for another
reason.
      */
     @Override
     public void setPropertyValue(final String name, Object value) throws IllegalArgumentException
{
@@ -268,7 +268,7 @@ final class DenseFeature extends Abstrac
      * the clone operation is <cite>deep</cite> or <cite>shallow</cite>)
depends on the behavior or
      * property {@code clone()} methods.
      *
-     * @return A clone of this attribute.
+     * @return a clone of this attribute.
      * @throws CloneNotSupportedException if this feature can not be cloned, typically because
      *         {@code clone()} on a property instance failed.
      */
@@ -295,7 +295,7 @@ final class DenseFeature extends Abstrac
      * in order to keep the hash code value stable before and after the {@code properties}
array is promoted from the
      * {@code Object[]} type to the {@code Property[]} type.
      *
-     * @return A hash code value.
+     * @return a hash code value.
      */
     @Override
     public int hashCode() {



Mime
View raw message