You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2016/09/02 17:43:14 UTC
svn commit: r1758996 - in
/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso:
ISOMetadata.java content/AbstractContentInformation.java
content/DefaultCoverageDescription.java content/DefaultImageDescription.java
Author: desruisseaux
Date: Fri Sep 2 17:43:14 2016
New Revision: 1758996
URL: http://svn.apache.org/viewvc?rev=1758996&view=rev
Log:
Javadoc formatting (no code change in this commit).
Modified:
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/AbstractContentInformation.java
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultCoverageDescription.java
sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultImageDescription.java
Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java?rev=1758996&r1=1758995&r2=1758996&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/ISOMetadata.java [UTF-8] Fri Sep 2 17:43:14 2016
@@ -81,7 +81,7 @@ public class ISOMetadata extends Modifia
* If the given object is an instance of {@link IdentifiedObject}, then this constructor
* copies the {@linkplain #identifiers collection of identifiers}.
*
- * @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.
*/
protected ISOMetadata(final Object object) {
if (object instanceof IdentifiedObject) {
@@ -113,7 +113,7 @@ public class ISOMetadata extends Modifia
* since this method may be indirectly invoked by copy constructors (i.e. is may be
* invoked before this metadata object is fully constructed).
*
- * @return The metadata standard, which is {@linkplain MetadataStandard#ISO_19115 ISO 19115} by default.
+ * @return the metadata standard, which is {@linkplain MetadataStandard#ISO_19115 ISO 19115} by default.
*/
@Override
public MetadataStandard getStandard() {
Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/AbstractContentInformation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/AbstractContentInformation.java?rev=1758996&r1=1758995&r2=1758996&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/AbstractContentInformation.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/AbstractContentInformation.java [UTF-8] Fri Sep 2 17:43:14 2016
@@ -67,7 +67,7 @@ public class AbstractContentInformation
* 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(ContentInformation)
*/
@@ -94,8 +94,8 @@ public class AbstractContentInformation
* 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 AbstractContentInformation castOrCopy(final ContentInformation object) {
Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultCoverageDescription.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultCoverageDescription.java?rev=1758996&r1=1758995&r2=1758996&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultCoverageDescription.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultCoverageDescription.java [UTF-8] Fri Sep 2 17:43:14 2016
@@ -101,7 +101,7 @@ public class DefaultCoverageDescription
* 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(CoverageDescription)
*/
@@ -131,8 +131,8 @@ public class DefaultCoverageDescription
* 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 DefaultCoverageDescription castOrCopy(final CoverageDescription object) {
@@ -149,7 +149,7 @@ public class DefaultCoverageDescription
/**
* Returns the description of the attribute described by the measurement value.
*
- * @return Description of the attribute.
+ * @return description of the attribute.
*/
@Override
@XmlElement(name = "attributeDescription", required = true)
@@ -160,7 +160,7 @@ public class DefaultCoverageDescription
/**
* Sets the description of the attribute described by the measurement value.
*
- * @param newValue The new attribute description.
+ * @param newValue the new attribute description.
*/
public void setAttributeDescription(final RecordType newValue) {
checkWritePermission();
@@ -170,7 +170,7 @@ public class DefaultCoverageDescription
/**
* Returns an identifier for the level of processing that has been applied to the resource, or {@code null} if none.
*
- * @return Identifier for the level of processing that has been applied to the resource, or {@code null} if none.
+ * @return identifier for the level of processing that has been applied to the resource, or {@code null} if none.
*
* @since 0.5
*/
@@ -183,7 +183,7 @@ public class DefaultCoverageDescription
/**
* Sets the identifier for the level of processing that has been applied to the resource.
*
- * @param newValue The new identifier for the level of processing.
+ * @param newValue the new identifier for the level of processing.
*
* @since 0.5
*/
@@ -195,7 +195,7 @@ public class DefaultCoverageDescription
/**
* Returns information on attribute groups of the resource.
*
- * @return Information on attribute groups of the resource.
+ * @return information on attribute groups of the resource.
*
* @since 0.5
*/
@@ -208,7 +208,7 @@ public class DefaultCoverageDescription
/**
* Sets information on attribute groups of the resource.
*
- * @param newValues The new information on attribute groups of the resource.
+ * @param newValues the new information on attribute groups of the resource.
*
* @since 0.5
*/
@@ -220,7 +220,7 @@ public class DefaultCoverageDescription
* Returns the type of information represented by the cell value.
* This method fetches the value from the {@linkplain #getAttributeGroups() attribute groups}.
*
- * @return Type of information represented by the cell value, or {@code null}.
+ * @return type of information represented by the cell value, or {@code null}.
*
* @deprecated As of ISO 19115:2014, moved to {@link DefaultAttributeGroup#getContentTypes()}.
*/
@@ -253,7 +253,7 @@ public class DefaultCoverageDescription
* Sets the type of information represented by the cell value.
* This method stores the value in the first writable {@linkplain #getAttributeGroups() attribute groups}.
*
- * @param newValue The new content type.
+ * @param newValue the new content type.
*
* @deprecated As of ISO 19115:2014, moved to {@link DefaultAttributeGroup#setContentTypes(Collection)}.
*/
@@ -284,7 +284,7 @@ public class DefaultCoverageDescription
* Returns the information on the dimensions of the cell measurement value.
* This method fetches the values from the first {@linkplain #getAttributeGroups() attribute groups}.
*
- * @return Dimensions of the cell measurement value.
+ * @return dimensions of the cell measurement value.
*
* @deprecated As of ISO 19115:2014, moved to {@link DefaultAttributeGroup#getAttributes()}.
*/
@@ -321,7 +321,7 @@ public class DefaultCoverageDescription
* Sets the information on the dimensions of the cell measurement value.
* This method stores the values in the {@linkplain #getAttributeGroups() attribute groups}.
*
- * @param newValues The new dimensions.
+ * @param newValues the new dimensions.
*
* @deprecated As of ISO 19115:2014, moved to {@link DefaultAttributeGroup#setAttributes(Collection)}.
*/
@@ -334,7 +334,7 @@ public class DefaultCoverageDescription
/**
* Provides the description of the specific range elements of a coverage.
*
- * @return Description of the specific range elements of a coverage.
+ * @return description of the specific range elements of a coverage.
*/
@Override
@XmlElement(name = "rangeElementDescription", namespace = Namespaces.GMI)
@@ -345,7 +345,7 @@ public class DefaultCoverageDescription
/**
* Sets the description of the specific range elements of a coverage.
*
- * @param newValues The new range element description.
+ * @param newValues the new range element description.
*/
public void setRangeElementDescriptions(final Collection<? extends RangeElementDescription> newValues) {
rangeElementDescriptions = writeCollection(newValues, rangeElementDescriptions, RangeElementDescription.class);
Modified: sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultImageDescription.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultImageDescription.java?rev=1758996&r1=1758995&r2=1758996&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultImageDescription.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultImageDescription.java [UTF-8] Fri Sep 2 17:43:14 2016
@@ -151,7 +151,7 @@ public class DefaultImageDescription ext
* 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(ImageDescription)
*/
@@ -186,8 +186,8 @@ public class DefaultImageDescription ext
* 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 DefaultImageDescription castOrCopy(final ImageDescription object) {
@@ -198,13 +198,13 @@ public class DefaultImageDescription ext
}
/**
- * Returns the illumination elevation measured in degrees clockwise from the target plane at
- * intersection of the optical line of sight with the Earth's surface.
+ * Returns the illumination elevation measured in degrees clockwise from the target plane
+ * at intersection of the optical line of sight with the Earth's surface.
* For images from a scanning device, refer to the centre pixel of the image.
*
* <p>The horizon is at 0�, straight up has an elevation of 90�.</p>
*
- * @return A value between -90� and +90�, or {@code null} if unspecified.
+ * @return a value between -90� and +90�, or {@code null} if unspecified.
*/
@Override
@ValueRange(minimum = -90, maximum = +90)
@@ -214,11 +214,11 @@ public class DefaultImageDescription ext
}
/**
- * Sets the illumination elevation measured in degrees clockwise from the target plane at
- * intersection of the optical line of sight with the Earth's surface. For images from a
- * scanning device, refer to the centre pixel of the image.
+ * Sets the illumination elevation measured in degrees clockwise from the target plane
+ * at intersection of the optical line of sight with the Earth's surface.
+ * For images from a scanning device, refer to the centre pixel of the image.
*
- * @param newValue The new illumination elevation angle, or {@code null}.
+ * @param newValue the new illumination elevation angle, or {@code null}.
* @throws IllegalArgumentException if the given value is out of range.
*/
public void setIlluminationElevationAngle(final Double newValue) {
@@ -229,10 +229,10 @@ public class DefaultImageDescription ext
}
/**
- * Returns the illumination azimuth measured in degrees clockwise from true north at the time
- * the image is taken. For images from a scanning device, refer to the centre pixel of the image.
+ * Returns the illumination azimuth measured in degrees clockwise from true north at the time the image is taken.
+ * For images from a scanning device, refer to the centre pixel of the image.
*
- * @return A value between 0� and 360�, or {@code null} if unspecified.
+ * @return a value between 0� and 360�, or {@code null} if unspecified.
*/
@Override
@ValueRange(minimum = 0, maximum = 360)
@@ -242,10 +242,10 @@ public class DefaultImageDescription ext
}
/**
- * Sets the illumination azimuth measured in degrees clockwise from true north at the time the
- * image is taken. For images from a scanning device, refer to the centre pixel of the image.
+ * Sets the illumination azimuth measured in degrees clockwise from true north at the time the image is taken.
+ * For images from a scanning device, refer to the centre pixel of the image.
*
- * @param newValue The new illumination azimuth angle, or {@code null}.
+ * @param newValue the new illumination azimuth angle, or {@code null}.
* @throws IllegalArgumentException if the given value is out of range.
*/
public void setIlluminationAzimuthAngle(final Double newValue) {
@@ -258,7 +258,7 @@ public class DefaultImageDescription ext
/**
* Returns the conditions which affected the image.
*
- * @return Conditions which affected the image, or {@code null} if unspecified.
+ * @return conditions which affected the image, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "imagingCondition")
@@ -269,7 +269,7 @@ public class DefaultImageDescription ext
/**
* Sets the conditions that affected the image.
*
- * @param newValue The new imaging condition.
+ * @param newValue the new imaging condition.
*/
public void setImagingCondition(final ImagingCondition newValue) {
checkWritePermission();
@@ -279,7 +279,7 @@ public class DefaultImageDescription ext
/**
* Returns a code in producer\u2019s codespace that specifies the image quality.
*
- * @return The image quality, or {@code null} if unspecified.
+ * @return the image quality, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "imageQualityCode")
@@ -290,7 +290,7 @@ public class DefaultImageDescription ext
/**
* Sets a code in producer\u2019s codespace that specifies the image quality.
*
- * @param newValue The new image quality code.
+ * @param newValue the new image quality code.
*/
public void setImageQualityCode(final Identifier newValue) {
checkWritePermission();
@@ -300,7 +300,7 @@ public class DefaultImageDescription ext
/**
* Returns the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.
*
- * @return A value between 0 and 100, or {@code null} if unspecified.
+ * @return a value between 0 and 100, or {@code null} if unspecified.
*/
@Override
@ValueRange(minimum = 0, maximum = 100)
@@ -312,7 +312,7 @@ public class DefaultImageDescription ext
/**
* Sets the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.
*
- * @param newValue The new cloud cover percentage, or {@code null}.
+ * @param newValue the new cloud cover percentage, or {@code null}.
* @throws IllegalArgumentException if the given value is out of range.
*/
public void setCloudCoverPercentage(final Double newValue) {
@@ -326,8 +326,7 @@ public class DefaultImageDescription ext
* Returns the image distributor's code that identifies the level of radiometric and geometric
* processing that has been applied.
*
- * @return The level of radiometric and geometric processing that has been applied,
- * or {@code null} if unspecified.
+ * @return the level of radiometric and geometric processing that has been applied, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "processingLevelCode")
@@ -339,7 +338,7 @@ public class DefaultImageDescription ext
* Sets the image distributor's code that identifies the level of radiometric and geometric
* processing that has been applied.
*
- * @param newValue The new processing level code.
+ * @param newValue the new processing level code.
*/
@Override
public void setProcessingLevelCode(final Identifier newValue) {
@@ -349,8 +348,7 @@ public class DefaultImageDescription ext
/**
* Returns the count of the number of lossy compression cycles performed on the image.
*
- * @return The number of lossy compression cycles performed on the image,
- * or {@code null} if unspecified.
+ * @return the number of lossy compression cycles performed on the image, or {@code null} if unspecified.
*/
@Override
@ValueRange(minimum = 0)
@@ -362,7 +360,7 @@ public class DefaultImageDescription ext
/**
* Sets the count of the number the number of lossy compression cycles performed on the image.
*
- * @param newValue The new compression generation quantity.
+ * @param newValue the new compression generation quantity.
* @throws IllegalArgumentException if the given value is negative.
*/
public void setCompressionGenerationQuantity(final Integer newValue) {
@@ -375,8 +373,7 @@ public class DefaultImageDescription ext
/**
* Returns the indication of whether or not triangulation has been performed upon the image.
*
- * @return Whether or not triangulation has been performed upon the image,
- * or {@code null} if unspecified.
+ * @return whether or not triangulation has been performed upon the image, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "triangulationIndicator")
@@ -387,7 +384,7 @@ public class DefaultImageDescription ext
/**
* Sets the indication of whether or not triangulation has been performed upon the image.
*
- * @param newValue The new triangulation indicator.
+ * @param newValue the new triangulation indicator.
*/
public void setTriangulationIndicator(final Boolean newValue) {
checkWritePermission();
@@ -398,8 +395,7 @@ public class DefaultImageDescription ext
* Returns the indication of whether or not the radiometric calibration information for
* generating the radiometrically calibrated standard data product is available.
*
- * @return Whether or not the radiometric calibration information is available,
- * or {@code null} if unspecified.
+ * @return whether or not the radiometric calibration information is available, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "radiometricCalibrationDataAvailability")
@@ -411,7 +407,7 @@ public class DefaultImageDescription ext
* Sets the indication of whether or not the radiometric calibration information for generating
* the radiometrically calibrated standard data product is available.
*
- * @param newValue {@code true} if radiometric calibration data are available.
+ * @param newValue {@code true} if radiometric calibration data are available.
*/
public void setRadiometricCalibrationDataAvailable(final Boolean newValue) {
checkWritePermission();
@@ -419,11 +415,9 @@ public class DefaultImageDescription ext
}
/**
- * Returns the indication of whether or not constants are available which allow for camera
- * calibration corrections.
+ * Returns the indication of whether or not constants are available which allow for camera calibration corrections.
*
- * @return Whether or not constants are available for camera calibration corrections,
- * or {@code null} if unspecified.
+ * @return whether or not constants are available for camera calibration corrections, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "cameraCalibrationInformationAvailability")
@@ -432,10 +426,9 @@ public class DefaultImageDescription ext
}
/**
- * Sets the indication of whether or not constants are available which allow for camera
- * calibration corrections.
+ * Sets the indication of whether or not constants are available which allow for camera calibration corrections.
*
- * @param newValue {@code true} if camera calibration information are available.
+ * @param newValue {@code true} if camera calibration information are available.
*/
public void setCameraCalibrationInformationAvailable(final Boolean newValue) {
checkWritePermission();
@@ -445,8 +438,7 @@ public class DefaultImageDescription ext
/**
* Returns the indication of whether or not Calibration Reseau information is available.
*
- * @return Whether or not Calibration Reseau information is available,
- * or {@code null} if unspecified.
+ * @return whether or not Calibration Reseau information is available, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "filmDistortionInformationAvailability")
@@ -457,7 +449,7 @@ public class DefaultImageDescription ext
/**
* Sets the indication of whether or not Calibration Reseau information is available.
*
- * @param newValue {@code true} if film distortion information are available.
+ * @param newValue {@code true} if film distortion information are available.
*/
public void setFilmDistortionInformationAvailable(final Boolean newValue) {
checkWritePermission();
@@ -467,8 +459,7 @@ public class DefaultImageDescription ext
/**
* Returns the indication of whether or not lens aberration correction information is available.
*
- * @return Whether or not lens aberration correction information is available,
- * or {@code null} if unspecified.
+ * @return whether or not lens aberration correction information is available, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "lensDistortionInformationAvailability")
@@ -479,7 +470,7 @@ public class DefaultImageDescription ext
/**
* Sets the indication of whether or not lens aberration correction information is available.
*
- * @param newValue {@code true} if lens distortion information are available.
+ * @param newValue {@code true} if lens distortion information are available.
*/
public void setLensDistortionInformationAvailable(final Boolean newValue) {
checkWritePermission();