sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1759699 - in /sis/branches/JDK8: core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/ core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/ co...
Date Wed, 07 Sep 2016 20:45:05 GMT
Author: desruisseaux
Date: Wed Sep  7 20:45:05 2016
New Revision: 1759699

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

Modified:
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/DefaultFeatureTypeList.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureCatalogueDescription.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureTypeInfo.java
    sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDataFile.java
    sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/GeodeticObjectBuilder.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Localized.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/resources/Errors.java
    sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStore.java

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/DefaultFeatureTypeList.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/DefaultFeatureTypeList.java?rev=1759699&r1=1759698&r2=1759699&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/DefaultFeatureTypeList.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/DefaultFeatureTypeList.java
[UTF-8] Wed Sep  7 20:45:05 2016
@@ -71,8 +71,8 @@ public class DefaultFeatureTypeList exte
     /**
      * Creates a feature type list initialized to the given values.
      *
-     * @param spatialObject The instance of a type defined in the spatial schema, or {@code
null} if none.
-     * @param spatialSchemaName The name of the spatial schema used, or {@code null} if none.
+     * @param spatialObject  the instance of a type defined in the spatial schema, or {@code
null} if none.
+     * @param spatialSchemaName  the name of the spatial schema used, or {@code null} if
none.
      */
     public DefaultFeatureTypeList(final String spatialObject, final String spatialSchemaName)
{
         this.spatialObject     = spatialObject;
@@ -84,7 +84,7 @@ public class DefaultFeatureTypeList exte
      * This is a <cite>shallow</cite> copy constructor, since the other metadata
contained in the
      * given object are not recursively copied.
      *
-     * @param object The metadata to copy values from, or {@code null} if none.
+     * @param object the metadata to copy values from, or {@code null} if none.
      *
      * @see #castOrCopy(FeatureTypeList)
      */
@@ -110,8 +110,8 @@ public class DefaultFeatureTypeList exte
      *       metadata contained in the given object are not recursively copied.</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 DefaultFeatureTypeList castOrCopy(final FeatureTypeList object) {
@@ -124,7 +124,7 @@ public class DefaultFeatureTypeList exte
     /**
      * Instance of a type defined in the spatial schema.
      *
-     * @return Instance of a type defined in the spatial schema, or {@code null}.
+     * @return instance of a type defined in the spatial schema, or {@code null}.
      */
     @Override
     @XmlElement(name = "spatialObject", required = true)
@@ -135,7 +135,7 @@ public class DefaultFeatureTypeList exte
     /**
      * Sets the instance of a type defined in the spatial schema.
      *
-     * @param newValue The new spatial object.
+     * @param newValue  the new spatial object.
      */
     public void setSpatialObject(final String newValue) {
         checkWritePermission();
@@ -145,7 +145,7 @@ public class DefaultFeatureTypeList exte
     /**
      * Name of the spatial schema used.
      *
-     * @return Name of the spatial schema used, or {@code null}.
+     * @return name of the spatial schema used, or {@code null}.
      */
     @Override
     @XmlElement(name = "spatialSchemaName", required = true)
@@ -156,7 +156,7 @@ public class DefaultFeatureTypeList exte
     /**
      * Sets the name of the spatial schema used.
      *
-     * @param newValue The new spatial schema.
+     * @param newValue  the new spatial schema.
      */
     public void setSpatialSchemaName(final String newValue) {
         checkWritePermission();

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureCatalogueDescription.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureCatalogueDescription.java?rev=1759699&r1=1759698&r2=1759699&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureCatalogueDescription.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureCatalogueDescription.java
[UTF-8] Wed Sep  7 20:45:05 2016
@@ -103,7 +103,7 @@ public class DefaultFeatureCatalogueDesc
      * This is a <cite>shallow</cite> copy constructor, since the other metadata
contained in the
      * given object are not recursively copied.
      *
-     * @param object The metadata to copy values from, or {@code null} if none.
+     * @param  object  the metadata to copy values from, or {@code null} if none.
      *
      * @see #castOrCopy(FeatureCatalogueDescription)
      */
@@ -132,8 +132,8 @@ public class DefaultFeatureCatalogueDesc
      *       metadata contained in the given object are not recursively copied.</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 DefaultFeatureCatalogueDescription castOrCopy(final FeatureCatalogueDescription
object) {
@@ -146,7 +146,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Returns whether or not the cited feature catalogue complies with ISO 19110.
      *
-     * @return Whether or not the cited feature catalogue complies with ISO 19110, or {@code
null}.
+     * @return whether or not the cited feature catalogue complies with ISO 19110, or {@code
null}.
      */
     @Override
     @XmlElement(name = "complianceCode")
@@ -157,7 +157,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Sets whether or not the cited feature catalogue complies with ISO 19110.
      *
-     * @param newValue The new compliance value.
+     * @param  newValue  the new compliance value.
      */
     public void setCompliant(final Boolean newValue) {
         checkWritePermission();
@@ -167,7 +167,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Returns the language(s) used within the catalogue
      *
-     * @return Language(s) used within the catalogue.
+     * @return language(s) used within the catalogue.
      */
     @Override
     @XmlElement(name = "language")
@@ -178,7 +178,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Sets the language(s) used within the catalogue
      *
-     * @param newValues The new languages.
+     * @param  newValues  the new languages.
      */
     public void setLanguages(final Collection<? extends Locale> newValues) {
         languages = writeCollection(newValues, languages, Locale.class);
@@ -187,7 +187,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Returns whether or not the feature catalogue is included with the resource.
      *
-     * @return Whether or not the feature catalogue is included with the resource.
+     * @return whether or not the feature catalogue is included with the resource.
      */
     @Override
     @XmlElement(name = "includedWithDataset", required = true)
@@ -198,7 +198,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Sets whether or not the feature catalogue is included with the resource.
      *
-     * @param newValue {@code true} if the feature catalogue is included.
+     * @param  newValue  {@code true} if the feature catalogue is included.
      */
     public void setIncludedWithDataset(final boolean newValue) {
         checkWritePermission();
@@ -208,7 +208,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Returns the subset of feature types from cited feature catalogue occurring in resource.
      *
-     * @return Subset of feature types occurring in resource.
+     * @return subset of feature types occurring in resource.
      *
      * @since 0.5
      */
@@ -220,7 +220,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Sets the subset of feature types from cited feature catalogue occurring in resource.
      *
-     * @param newValues The new feature types.
+     * @param  newValues  the new feature types.
      *
      * @since 0.5
      */
@@ -231,7 +231,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Returns the names of {@linkplain #getFeatureTypes() feature types}.
      *
-     * @return The feature type names.
+     * @return the feature type names.
      *
      * @deprecated As of ISO 19115:2014, replaced by {@link #getFeatureTypeInfo()}.
      */
@@ -264,7 +264,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Sets the names of {@linkplain #getFeatureTypes() feature types}.
      *
-     * @param newValues The new feature type names.
+     * @param  newValues  the new feature type names.
      *
      * @deprecated As of ISO 19115:2014, replaced by {@link #setFeatureTypeInfo(Collection)}.
      */
@@ -277,7 +277,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Returns the complete bibliographic reference to one or more external feature catalogues.
      *
-     * @return Bibliographic reference to one or more external feature catalogues.
+     * @return bibliographic reference to one or more external feature catalogues.
      */
     @Override
     @XmlElement(name = "featureCatalogueCitation", required = true)
@@ -288,7 +288,7 @@ public class DefaultFeatureCatalogueDesc
     /**
      * Sets the complete bibliographic reference to one or more external feature catalogues.
      *
-     * @param newValues The feature catalogue citations.
+     * @param  newValues  the feature catalogue citations.
      */
     public void setFeatureCatalogueCitations(final Collection<? extends Citation> newValues)
{
         featureCatalogueCitations = writeCollection(newValues, featureCatalogueCitations,
Citation.class);

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=1759699&r1=1759698&r2=1759699&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] Wed Sep  7 20:45:05 2016
@@ -75,7 +75,7 @@ public class DefaultFeatureTypeInfo exte
     /**
      * Constructs a feature type info initialized to the specified name.
      *
-     * @param featureTypeName Name of the feature type.
+     * @param  featureTypeName  name of the feature type.
      */
     public DefaultFeatureTypeInfo(final GenericName featureTypeName) {
         this.featureTypeName = featureTypeName;
@@ -93,7 +93,7 @@ public class DefaultFeatureTypeInfo exte
      * metadata instances can also be obtained by unmarshalling an invalid XML document.
      * </div>
      *
-     * @param object The metadata to copy values from, or {@code null} if none.
+     * @param  object  the metadata to copy values from, or {@code null} if none.
      *
      * @see #castOrCopy(FeatureTypeInfo)
      */
@@ -119,8 +119,8 @@ public class DefaultFeatureTypeInfo exte
      *       metadata contained in the given object are not recursively copied.</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 DefaultFeatureTypeInfo castOrCopy(final FeatureTypeInfo object) {
@@ -133,7 +133,7 @@ public class DefaultFeatureTypeInfo exte
     /**
      * Returns the name of the feature type.
      *
-     * @return Name of the feature type.
+     * @return name of the feature type.
      *
      * @see org.apache.sis.feature.DefaultFeatureType#getName()
      */
@@ -146,7 +146,7 @@ public class DefaultFeatureTypeInfo exte
     /**
      * Sets the name of the feature type.
      *
-     * @param newValue The new name.
+     * @param  newValue  the new name.
      */
     public void setFeatureTypeName(final GenericName newValue) {
         checkWritePermission();
@@ -156,7 +156,7 @@ public class DefaultFeatureTypeInfo exte
     /**
      * Returns the number of occurrence of feature instances for this feature types, or {@code
null} if none.
      *
-     * @return The number of occurrence of feature instances for this feature types, or {@code
null} if none.
+     * @return the number of occurrence of feature instances for this feature types, or {@code
null} if none.
      */
     @Override
     @ValueRange(minimum = 1)
@@ -168,7 +168,7 @@ public class DefaultFeatureTypeInfo exte
     /**
      * Sets a new number of occurrence of feature instances for this feature types.
      *
-     * @param newValue the new number of occurrence.
+     * @param  newValue  the new number of occurrence.
      * @throws IllegalArgumentException if the given value is negative.
      */
     public void setFeatureInstanceCount(final Integer newValue) {

Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDataFile.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDataFile.java?rev=1759699&r1=1759698&r2=1759699&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDataFile.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDataFile.java
[UTF-8] Wed Sep  7 20:45:05 2016
@@ -80,7 +80,7 @@ public class DefaultDataFile extends ISO
      * This is a <cite>shallow</cite> copy constructor, since the other metadata
contained in the
      * given object are not recursively copied.
      *
-     * @param object The metadata to copy values from, or {@code null} if none.
+     * @param object the metadata to copy values from, or {@code null} if none.
      *
      * @see #castOrCopy(DataFile)
      */
@@ -106,8 +106,8 @@ public class DefaultDataFile extends ISO
      *       metadata contained in the given object are not recursively copied.</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 DefaultDataFile castOrCopy(final DataFile object) {
@@ -123,7 +123,7 @@ public class DefaultDataFile extends ISO
      * This attribute may be omitted when the dataset is composed of a single file and/or
the
      * data does not relate to a feature catalogue.
      *
-     * @return List of features types concerned by the transfer data file.
+     * @return list of features types concerned by the transfer data file.
      */
     @Override
     @XmlElement(name = "featureType", namespace = Namespaces.GMX)
@@ -134,7 +134,7 @@ public class DefaultDataFile extends ISO
     /**
      * Sets the list of feature types concerned by the transfer data file.
      *
-     * @param newValues The new feature type values.
+     * @param newValues the new feature type values.
      */
     public void setFeatureTypes(final Collection<? extends LocalName> newValues) {
         featureTypes = writeCollection(newValues, featureTypes, LocalName.class);
@@ -143,7 +143,7 @@ public class DefaultDataFile extends ISO
     /**
      * Returns the format of the transfer data file.
      *
-     * @return Format of the transfer data file, or {@code null}.
+     * @return format of the transfer data file, or {@code null}.
      */
     @Override
     @XmlElement(name = "fileFormat", namespace = Namespaces.GMX, required = true)
@@ -154,7 +154,7 @@ public class DefaultDataFile extends ISO
     /**
      * Sets the format of the transfer data file.
      *
-     * @param newValue The new file format value.
+     * @param newValue the new file format value.
      */
     public void setFileFormat(final Format newValue) {
         checkWritePermission();

Modified: sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/GeodeticObjectBuilder.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/GeodeticObjectBuilder.java?rev=1759699&r1=1759698&r2=1759699&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/GeodeticObjectBuilder.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-referencing/src/main/java/org/apache/sis/internal/referencing/GeodeticObjectBuilder.java
[UTF-8] Wed Sep  7 20:45:05 2016
@@ -163,7 +163,7 @@ public class GeodeticObjectBuilder exten
      *
      * This method can be invoked only once.
      *
-     * @param  name Name of the conversion method.
+     * @param  name  name of the conversion method.
      * @return {@code this}, for method call chaining.
      * @throws FactoryException if the operation method of the given name can not be obtained.
      */
@@ -180,8 +180,8 @@ public class GeodeticObjectBuilder exten
      * Sets the name of the conversion to use for creating a {@code ProjectedCRS} or {@code
DerivedCRS}.
      * This name is for information purpose; its value does not impact the numerical results
of coordinate operations.
      *
-     * @param  name The name to give to the conversion.
-     * @return {@code this}, for method call chaining.
+     * @param  name  the name to give to the conversion.
+     * @return {@code this}, for method calls chaining.
      */
     public GeodeticObjectBuilder setConversionName(final String name) {
         conversionName = name;
@@ -201,10 +201,10 @@ public class GeodeticObjectBuilder exten
      * Sets the value of a numeric parameter. The {@link #setConversionMethod(String)} method
must have been invoked
      * exactly once before this method. Calls to this {@code setParameter(…)} can be repeated
as many times as needed.
      *
-     * @param  name  The parameter name.
-     * @param  value The value to give to the parameter.
-     * @param  unit  Unit of measurement for the given value.
-     * @return {@code this}, for method call chaining.
+     * @param  name   the parameter name.
+     * @param  value  the value to give to the parameter.
+     * @param  unit   unit of measurement for the given value.
+     * @return {@code this}, for method calls chaining.
      * @throws IllegalStateException if {@link #setConversionMethod(String)} has not been
invoked before this method.
      * @throws ParameterNotFoundException if there is no parameter of the given name.
      * @throws InvalidParameterValueException if the parameter does not accept the given
value.
@@ -238,10 +238,10 @@ public class GeodeticObjectBuilder exten
      *   <tr><td>False northing</td>                 <td>0 (North
hemisphere) or 10000000 (South hemisphere) metres</td></tr>
      * </table></blockquote>
      *
-     * @param  isUTM      If {@code true}, the given central meridian will be snapped to
the central meridian of a UTM zone.
-     * @param  latitude   The latitude in the center of the desired projection.
-     * @param  longitude  The longitude in the center of the desired projection.
-     * @return {@code this}, for method call chaining.
+     * @param  isUTM      if {@code true}, the given central meridian will be snapped to
the central meridian of a UTM zone.
+     * @param  latitude   the latitude in the center of the desired projection.
+     * @param  longitude  the longitude in the center of the desired projection.
+     * @return {@code this}, for method calls chaining.
      * @throws FactoryException if the operation method for the Transverse Mercator projection
can not be obtained.
      */
     public GeodeticObjectBuilder setTransverseMercator(boolean isUTM, double latitude, double
longitude)
@@ -277,9 +277,9 @@ public class GeodeticObjectBuilder exten
      * }
      * </div>
      *
-     * @param  baseCRS Coordinate reference system to base the derived CRS on.
-     * @param  derivedCS The coordinate system for the derived CRS.
-     * @return The projected CRS.
+     * @param  baseCRS    coordinate reference system to base the derived CRS on.
+     * @param  derivedCS  the coordinate system for the derived CRS.
+     * @return the projected CRS.
      * @throws FactoryException if an error occurred while building the projected CRS.
      */
     public ProjectedCRS createProjectedCRS(final GeographicCRS baseCRS, final CartesianCS
derivedCS) throws FactoryException {
@@ -313,9 +313,9 @@ public class GeodeticObjectBuilder exten
      * Creates a temporal CRS from the given origin and temporal unit. For this method, the
CRS name is optional:
      * if no {@code addName(…)} method has been invoked, then a default name will be used.
      *
-     * @param  origin The epoch in milliseconds since January 1st, 1970 at midnight UTC.
-     * @param  unit The unit of measurement.
-     * @return A temporal CRS using the given origin and units.
+     * @param  origin  the epoch in milliseconds since January 1st, 1970 at midnight UTC.
+     * @param  unit    the unit of measurement.
+     * @return a temporal CRS using the given origin and units.
      * @throws FactoryException if an error occurred while building the temporal CRS.
      */
     public TemporalCRS createTemporalCRS(final Date origin, final Unit<Duration> unit)
throws FactoryException {
@@ -377,8 +377,8 @@ public class GeodeticObjectBuilder exten
      * Creates a compound CRS, but we special processing for (two-dimensional Geographic
+ ellipsoidal heights) tupples.
      * If any such tupple is found, a three-dimensional geographic CRS is created instead
than the compound CRS.
      *
-     * @param  components ordered array of {@code CoordinateReferenceSystem} objects.
-     * @return The coordinate reference system for the given properties.
+     * @param  components  ordered array of {@code CoordinateReferenceSystem} objects.
+     * @return the coordinate reference system for the given properties.
      * @throws FactoryException if the object creation failed.
      */
     public CoordinateReferenceSystem createCompoundCRS(final CoordinateReferenceSystem...
components) throws FactoryException {

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Localized.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Localized.java?rev=1759699&r1=1759698&r2=1759699&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Localized.java [UTF-8]
(original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/Localized.java [UTF-8]
Wed Sep  7 20:45:05 2016
@@ -44,7 +44,7 @@ public interface Localized {
      * Implementations are encouraged to return a non-null value in every cases.
      * Nevertheless client codes should be prepared to receive null values.
      *
-     * @return The locale, or {@code null} if not explicitly defined.
+     * @return the locale, or {@code null} if not explicitly defined.
      */
     Locale getLocale();
 }

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/resources/Errors.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/resources/Errors.java?rev=1759699&r1=1759698&r2=1759699&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/resources/Errors.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/util/resources/Errors.java
[UTF-8] Wed Sep  7 20:45:05 2016
@@ -1266,7 +1266,7 @@ public final class Errors extends Indexe
     /**
      * Constructs a new resource bundle loading data from the given UTF file.
      *
-     * @param resources The path of the binary file containing resources, or {@code null}
if
+     * @param resources  the path of the binary file containing resources, or {@code null}
if
      *        there is no resources. The resources may be a file or an entry in a JAR file.
      */
     Errors(final URL resources) {
@@ -1297,8 +1297,8 @@ public final class Errors extends Indexe
      * for the {@link #LOCALE_KEY} entry. If the given map is null, or contains no entry
for the locale key,
      * or the value is not an instance of {@link Locale}, then this method fallback on the
default locale.
      *
-     * @param  properties The map of properties, or {@code null} if none.
-     * @return Resources in the given locale.
+     * @param  properties the map of properties, or {@code null} if none.
+     * @return resources in the given locale.
      * @throws MissingResourceException if resources can't be found.
      *
      * @since 0.4
@@ -1310,9 +1310,9 @@ public final class Errors extends Indexe
     /**
      * Gets a string for the given key from this resource bundle or one of its parents.
      *
-     * @param  key The key for the desired string.
-     * @return The string for the given key.
-     * @throws MissingResourceException If no object for the given key can be found.
+     * @param  key the key for the desired string.
+     * @return the string for the given key.
+     * @throws MissingResourceException if no object for the given key can be found.
      */
     public static String format(final short key) throws MissingResourceException {
         return getResources((Locale) null).getString(key);
@@ -1322,10 +1322,10 @@ public final class Errors extends Indexe
      * Gets a string for the given key are replace all occurrence of "{0}"
      * with values of {@code arg0}.
      *
-     * @param  key The key for the desired string.
-     * @param  arg0 Value to substitute to "{0}".
-     * @return The formatted string for the given key.
-     * @throws MissingResourceException If no object for the given key can be found.
+     * @param  key   the key for the desired string.
+     * @param  arg0  value to substitute to "{0}".
+     * @return the formatted string for the given key.
+     * @throws MissingResourceException if no object for the given key can be found.
      */
     public static String format(final short  key,
                                 final Object arg0) throws MissingResourceException
@@ -1337,11 +1337,11 @@ public final class Errors extends Indexe
      * Gets a string for the given key are replace all occurrence of "{0}",
      * "{1}", with values of {@code arg0}, {@code arg1}.
      *
-     * @param  key The key for the desired string.
-     * @param  arg0 Value to substitute to "{0}".
-     * @param  arg1 Value to substitute to "{1}".
-     * @return The formatted string for the given key.
-     * @throws MissingResourceException If no object for the given key can be found.
+     * @param  key   the key for the desired string.
+     * @param  arg0  value to substitute to "{0}".
+     * @param  arg1  value to substitute to "{1}".
+     * @return the formatted string for the given key.
+     * @throws MissingResourceException if no object for the given key can be found.
      */
     public static String format(final short  key,
                                 final Object arg0,
@@ -1354,12 +1354,12 @@ public final class Errors extends Indexe
      * Gets a string for the given key are replace all occurrence of "{0}",
      * "{1}", with values of {@code arg0}, {@code arg1}, etc.
      *
-     * @param  key The key for the desired string.
-     * @param  arg0 Value to substitute to "{0}".
-     * @param  arg1 Value to substitute to "{1}".
-     * @param  arg2 Value to substitute to "{2}".
-     * @return The formatted string for the given key.
-     * @throws MissingResourceException If no object for the given key can be found.
+     * @param  key   the key for the desired string.
+     * @param  arg0  value to substitute to "{0}".
+     * @param  arg1  value to substitute to "{1}".
+     * @param  arg2  value to substitute to "{2}".
+     * @return the formatted string for the given key.
+     * @throws MissingResourceException if no object for the given key can be found.
      */
     public static String format(final short  key,
                                 final Object arg0,
@@ -1373,13 +1373,13 @@ public final class Errors extends Indexe
      * Gets a string for the given key are replace all occurrence of "{0}",
      * "{1}", with values of {@code arg0}, {@code arg1}, etc.
      *
-     * @param  key The key for the desired string.
-     * @param  arg0 Value to substitute to "{0}".
-     * @param  arg1 Value to substitute to "{1}".
-     * @param  arg2 Value to substitute to "{2}".
-     * @param  arg3 Value to substitute to "{3}".
-     * @return The formatted string for the given key.
-     * @throws MissingResourceException If no object for the given key can be found.
+     * @param  key   the key for the desired string.
+     * @param  arg0  value to substitute to "{0}".
+     * @param  arg1  value to substitute to "{1}".
+     * @param  arg2  value to substitute to "{2}".
+     * @param  arg3  value to substitute to "{3}".
+     * @return the formatted string for the given key.
+     * @throws MissingResourceException if no object for the given key can be found.
      */
     public static String format(final short  key,
                                 final Object arg0,
@@ -1409,8 +1409,8 @@ public final class Errors extends Indexe
      * validity. If the key is invalid, then a {@link MissingResourceException} may be thrown
      * when a {@link InternationalString#toString(Locale)} method is invoked.
      *
-     * @param  key The key for the desired string.
-     * @return An international string for the given key.
+     * @param  key  the key for the desired string.
+     * @return an international string for the given key.
      */
     public static InternationalString formatInternational(final short key) {
         return new International(key);
@@ -1426,9 +1426,9 @@ public final class Errors extends Indexe
      * of a temporary array. There is no risk of confusion since the two methods delegate
their
      * work to the same {@code format} method anyway.</div>
      *
-     * @param  key The key for the desired string.
-     * @param  arg Values to substitute to "{0}".
-     * @return An international string for the given key.
+     * @param  key  the key for the desired string.
+     * @param  arg  values to substitute to "{0}".
+     * @return an international string for the given key.
      */
     public static InternationalString formatInternational(final short key, final Object arg)
{
         return new International(key, arg);
@@ -1439,9 +1439,9 @@ public final class Errors extends Indexe
      * validity. If the key is invalid, then a {@link MissingResourceException} may be thrown
      * when a {@link InternationalString#toString(Locale)} method is invoked.
      *
-     * @param  key  The key for the desired string.
-     * @param  args Values to substitute to "{0}", "{1}", <i>etc</i>.
-     * @return An international string for the given key.
+     * @param  key   the key for the desired string.
+     * @param  args  values to substitute to "{0}", "{1}", <i>etc</i>.
+     * @return an international string for the given key.
      */
     public static InternationalString formatInternational(final short key, final Object...
args) {
         return new International(key, args);

Modified: sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStore.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStore.java?rev=1759699&r1=1759698&r2=1759699&view=diff
==============================================================================
--- sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStore.java
[UTF-8] (original)
+++ sis/branches/JDK8/storage/sis-storage/src/main/java/org/apache/sis/storage/DataStore.java
[UTF-8] Wed Sep  7 20:45:05 2016
@@ -29,9 +29,8 @@ import org.apache.sis.util.logging.Warni
  * Manages a series of features, coverages or sensor data.
  *
  * <div class="section">Thread safety policy</div>
- * This {@code DataStore} base class is thread-safe. However subclasses are usually not.
- * Unless otherwise specified by subclasses, users should assume that {@code DataStore}
- * instances are not thread-safe.
+ * This {@code DataStore} base class is thread-safe. However subclasses do not need to be
thread-safe.
+ * Unless otherwise specified, users should assume that {@code DataStore} instances are not
thread-safe.
  *
  * @author  Johann Sorel (Geomatys)
  * @author  Martin Desruisseaux (Geomatys)
@@ -77,7 +76,7 @@ public abstract class DataStore implemen
     /**
      * Sets the locale to use for formatting warnings and other messages.
      *
-     * @param locale The new locale to use.
+     * @param locale  the new locale to use.
      */
     public synchronized void setLocale(final Locale locale) {
         ArgumentChecks.ensureNonNull("locale", locale);
@@ -89,7 +88,7 @@ public abstract class DataStore implemen
      * information such as the spatiotemporal extent of the dataset, contact information
about the creator
      * or distributor, data quality, update frequency, usage constraints and more.
      *
-     * @return Information about the dataset, or {@code null} if none.
+     * @return information about the dataset, or {@code null} if none.
      * @throws DataStoreException if an error occurred while reading the data.
      */
     public abstract Metadata getMetadata() throws DataStoreException;
@@ -117,7 +116,7 @@ public abstract class DataStore implemen
      *     }
      * }
      *
-     * @param  listener The listener to add.
+     * @param  listener  the listener to add.
      * @throws IllegalArgumentException if the given listener is already registered in this
data store.
      */
     public void addWarningListener(final WarningListener<? super DataStore> listener)
@@ -129,7 +128,7 @@ public abstract class DataStore implemen
     /**
      * Removes a previously registered listener.
      *
-     * @param  listener The listener to remove.
+     * @param  listener  the listener to remove.
      * @throws NoSuchElementException if the given listener is not registered in this data
store.
      */
     public void removeWarningListener(final WarningListener<? super DataStore> listener)



Mime
View raw message