Author: desruisseaux
Date: Thu Apr 4 08:58:56 2013
New Revision: 1464370
URL: http://svn.apache.org/r1464370
Log:
Javadoc updates.
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -69,23 +69,19 @@
* {@code └─} {@linkplain
org.apache.sis.metadata.iso.acquisition.DefaultEnvironmentalRecord
Environmental record}<br>
* </td></tr></table>
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Cédric Briançon (Geomatys)
* @author Martin Desruisseaux (Geomatys)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -64,23 +64,19 @@
* except at XML marshalling time (for ISO 19139 compliance).
* See {@link org.apache.sis.xml.IdentifierMap} for more information.
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/constraint/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -43,23 +43,19 @@
* {@code └─} {@linkplain org.opengis.metadata.constraints.Classification
Classification} «code list»<br>
* </td></tr></table>
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -66,23 +66,19 @@
* Both {@code Band} and {@code SampleDimension} interfaces extend the same
parent,
* {@link org.opengis.metadata.content.RangeDimension}.
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -51,23 +51,19 @@
* {@linkplain
org.apache.sis.metadata.iso.distribution.DefaultDataFile Data
file}<br>
* </td></tr></table>
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -88,23 +88,19 @@
* for adding extent elements inferred from the given envelope.</li>
* </ul>
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -67,23 +67,19 @@
* for computing the denominator from a scale value.</li>
* </ul>
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -46,23 +46,19 @@
* {@code └─} {@linkplain
org.apache.sis.metadata.iso.lineage.DefaultProcessStepReport Process step
report}<br>
* </td></tr></table>
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -41,24 +41,20 @@
* {@code └─} {@linkplain
org.apache.sis.metadata.iso.maintenance.DefaultScopeDescription Scope
description}<br>
* </td></tr></table>
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
* modify directly the underlying metadata object. Noticeable exceptions to
this rule are <cite>union</cite>
- * structures, for which only one property can be non-empty in the same object.
+ * structures, for which only one property can be non-empty in the same
object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -60,23 +60,19 @@
* {@link org.apache.sis.metadata.iso.DefaultMetadata#setLanguage
setLanguage(Locale)} method
* will have precedence. The later behavior is compliant with INSPIRE rules.
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -91,23 +91,19 @@
* {@linkplain
org.apache.sis.metadata.iso.quality.DefaultCoverageResult
Coverage result}<br>
* </td></tr></table>
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
Modified:
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java
URL:
http://svn.apache.org/viewvc/sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java?rev=1464370&r1=1464369&r2=1464370&view=diff
==============================================================================
---
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java
[UTF-8] (original)
+++
sis/branches/JDK7/sis-metadata/src/main/java/org/apache/sis/metadata/iso/spatial/package-info.java
[UTF-8] Thu Apr 4 08:58:56 2013
@@ -65,23 +65,19 @@
* {@linkplain
org.opengis.metadata.spatial.SpatialRepresentationType Spatial
representation type} «code list»<br>
* </td></tr></table>
*
- * {@section Collections and null values}
- * All constructors (except the <cite>copy constructor</cite>) and setter
methods accept {@code null} arguments.
+ * {@section Null values, nil objects and collections}
+ * All constructors (except the <cite>copy constructors</cite>) and setter
methods accept {@code null} arguments.
* A null argument value means that the metadata element can not be provided,
and the reason for that is unspecified.
* Alternatively, users can specify why a metadata element is missing by
providing a value created by
* {@link org.apache.sis.xml.NilReason#createNilObject
NilReason.createNilObject(Class)}.
*
* <p>Unless otherwise noted in the Javadoc, all getter methods may return an
empty collection,
- * an empty array or {@code null} if there is no value. More specifically:</p>
- * <ul>
- * <li>If the return type is a collection, the method may return an empty
collection (never {@code null}).</li>
- * <li>If the return type is an array, the method may return an empty array
(never {@code null}).</li>
- * <li>Otherwise the method may return {@code null}.</li>
- * </ul>
+ * an empty array or {@code null} if the type is neither a collection or an
array.
+ * Note that non-null values may be {@link org.apache.sis.xml.NilObject}s.</p>
*
- * Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
+ * <p>Unless the metadata object has been marked as unmodifiable and unless
otherwise noted in the Javadoc,
* all collections returned by getter methods are <cite>live</cite>: adding
new elements in the collection
- * modify directly the underlying metadata object.
+ * modify directly the underlying metadata object.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
