sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1469303 - in /sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata: AbstractMetadata.java MetadataStandard.java PropertyMap.java
Date Thu, 18 Apr 2013 13:04:41 GMT
Author: desruisseaux
Date: Thu Apr 18 13:04:40 2013
New Revision: 1469303

URL: http://svn.apache.org/r1469303
Log:
Minor javadoc fixes.

Modified:
    sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java
    sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
    sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyMap.java

Modified: sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java?rev=1469303&r1=1469302&r2=1469303&view=diff
==============================================================================
--- sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java
[UTF-8] (original)
+++ sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/AbstractMetadata.java
[UTF-8] Thu Apr 18 13:04:40 2013
@@ -121,7 +121,7 @@ public abstract class AbstractMetadata i
      *   <li>An empty {@linkplain CharSequence character sequences}.</li>
      *   <li>An {@linkplain java.util.Collection#isEmpty() empty collection} or an
empty array.</li>
      *   <li>A collection or array containing only {@code null} or empty elements.</li>
-     *   <li>An other metadata object containing only {@code null} or empty attributes.</li>
+     *   <li>An other metadata object containing only {@code null} or empty properties.</li>
      * </ul>
      *
      * Note that empty properties can be removed by calling the {@link ModifiableMetadata#prune()}

Modified: sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java?rev=1469303&r1=1469302&r2=1469303&view=diff
==============================================================================
--- sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
[UTF-8] (original)
+++ sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/MetadataStandard.java
[UTF-8] Thu Apr 18 13:04:40 2013
@@ -43,15 +43,14 @@ import static org.apache.sis.util.Argume
  * {@linkplain java.lang.reflect Java reflection}. The following rules are assumed:</p>
  *
  * <ul>
- *   <li>Properties (or metadata attributes) are defined by the collection of
- *       following getter methods found <strong>in the interface</strong>
- *       (methods declared only in the implementation are ignored):
+ *   <li>Metadata properties are defined by the collection of following getter methods
found
+ *       <strong>in the interface</strong>, ignoring implementation methods:
  *       <ul>
  *         <li>{@code get*()} methods with arbitrary return type;</li>
  *         <li>or {@code is*()} methods with boolean return type.</li>
  *       </ul></li>
- *   <li>Every properties are <cite>readable</cite>.
- *       But a property is also <cite>writable</cite> if a {@code set*(…)}
method is defined
+ *   <li>All properties are <cite>readable</cite>.</li>
+ *   <li>A property is also <cite>writable</cite> if a {@code set*(…)}
method is defined
  *       <strong>in the implementation class</strong> for the corresponding getter
method.
  *       The setter method doesn't need to be defined in the interface.</li>
  * </ul>
@@ -66,7 +65,7 @@ import static org.apache.sis.util.Argume
  *
  * <ul>
  *   <li>For <em>read-only</em> metadata, {@code MetadataStandard} can
be instantiated directly.
- *       only getter methods will be used and all operations that modify the metadata properties
+ *       Only getter methods will be used and all operations that modify the metadata properties
  *       will throw an {@link UnmodifiableMetadataException}.</li>
  *   <li>For <em>read/write</em> metadata, the {@link #getImplementation(Class)}
  *       method must be overridden in a {@code MetadataStandard} subclass.</li>
@@ -154,9 +153,10 @@ public class MetadataStandard {
     private final Map<Class<?>, Object> accessors;
 
     /**
-     * Creates a new instance working on implementation of interfaces defined
-     * in the specified package. For the ISO 19115 standard reflected by GeoAPI
-     * interfaces, it should be the {@link org.opengis.metadata} package.
+     * Creates a new instance working on implementation of interfaces defined in the specified
package.
+     *
+     * <p><b>Example:</b>: For the ISO 19115 standard reflected by GeoAPI
interfaces,
+     * {@code interfacePackage} shall be the {@link org.opengis.metadata} package.</p>
      *
      * @param citation         Bibliographical reference to the international standard.
      * @param interfacePackage The root package for metadata interfaces.

Modified: sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyMap.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyMap.java?rev=1469303&r1=1469302&r2=1469303&view=diff
==============================================================================
--- sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyMap.java
[UTF-8] (original)
+++ sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/PropertyMap.java
[UTF-8] Thu Apr 18 13:04:40 2013
@@ -115,7 +115,7 @@ final class PropertyMap extends Metadata
      *
      * @throws IllegalArgumentException if the given key is not the name of a property in
the metadata.
      * @throws ClassCastException if the given value is not of the expected type.
-     * @throws UnmodifiableMetadataException if the attribute for the given key is read-only.
+     * @throws UnmodifiableMetadataException if the property for the given key is read-only.
      */
     @Override
     public Object put(final String key, final Object value) {
@@ -129,7 +129,7 @@ final class PropertyMap extends Metadata
      *
      * @throws IllegalArgumentException if at least one key is not the name of a property
in the metadata.
      * @throws ClassCastException if at least one value is not of the expected type.
-     * @throws UnmodifiableMetadataException if at least one attribute is read-only.
+     * @throws UnmodifiableMetadataException if at least one property is read-only.
      */
     @Override
     public void putAll(final Map<? extends String, ?> map) {
@@ -141,7 +141,7 @@ final class PropertyMap extends Metadata
     /**
      * Removes the mapping for a key from this map if it is present.
      *
-     * @throws UnmodifiableMetadataException if the attribute for the given key is read-only.
+     * @throws UnmodifiableMetadataException if the property for the given key is read-only.
      */
     @Override
     public Object remove(final Object key) throws UnsupportedOperationException {
@@ -226,7 +226,7 @@ final class PropertyMap extends Metadata
          * Replaces the value corresponding to this entry with the specified value.
          *
          * @throws ClassCastException if the given value is not of the expected type.
-         * @throws UnmodifiableMetadataException if the attribute for this entry is read-only.
+         * @throws UnmodifiableMetadataException if the property for this entry is read-only.
          */
         @Override
         public Object setValue(final Object value) {
@@ -352,7 +352,7 @@ final class PropertyMap extends Metadata
         /**
          * Removes from the underlying collection the last element returned by the iterator.
          *
-         * @throws UnmodifiableMetadataException if the attribute for this entry is read-only.
+         * @throws UnmodifiableMetadataException if the property for this entry is read-only.
          */
         @Override
         public void remove() {



Mime
View raw message