Fixed javadoc warning

git-svn-id: https://svn.d4science.research-infrastructures.eu/gcube/trunk/data-publishing/document-store-lib@157729 82a268e6-3cf1-43bd-a215-b396298e98cf

.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,6 @@
+eclipse.preferences.version=1
+encoding//src/main/java=UTF-8
+encoding//src/main/resources=UTF-8
+encoding//src/test/java=UTF-8
+encoding//src/test/resources=UTF-8
+encoding/<project>=UTF-8

.settings/org.eclipse.jdt.core.prefs

@@ -0,0 +1,5 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
+org.eclipse.jdt.core.compiler.compliance=1.8
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
+org.eclipse.jdt.core.compiler.source=1.8

distro/descriptor.xml

@@ -10,7 +10,7 @@
 	<fileSets>
 		<fileSet>
 			<directory>${distroDirectory}</directory>
-			<outputDirectory>/</outputDirectory>
+			<outputDirectory>${file.separator}</outputDirectory>
 			<useDefaultExcludes>true</useDefaultExcludes>
 			<includes>
 				<include>README</include>
@@ -24,8 +24,8 @@
 	</fileSets>
 	<files>
 		<file>
-			<source>target/${build.finalName}.jar</source>
-			<outputDirectory>/${artifactId}</outputDirectory>
+			<source>target${file.separator}${build.finalName}.jar</source>
+			<outputDirectory>${file.separator}${artifactId}</outputDirectory>
 		</file>
 	</files>
 </assembly>

src/main/java/org/gcube/documentstore/persistence/PersistenceBackend.java

@@ -250,13 +250,12 @@ public abstract class PersistenceBackend {
 	}
 
 	/**
-	 * Persist the {@link #UsageRecord}. The Record is validated first, then
+	 * Persist the Record. The Record is validated first, then
 	 * accounted, in a separated thread. So that the program can continue the
 	 * execution. If the persistence fails the class write that the record in a
-	 * local file so that the {@link #UsageRecord} can be recorder later.
+	 * local file so that the Record can be recorder later.
 	 * 
-	 * @param usageRecord
-	 *            the {@link #UsageRecord} to persist
+	 * @param record the Record to persist
 	 * @throws InvalidValueException
 	 *             if the Record Validation Fails
 	 */

src/main/java/org/gcube/documentstore/persistence/PersistenceBackendFactory.java

@@ -274,7 +274,7 @@ public abstract class PersistenceBackendFactory {
 
 
 	/**
-	 * Use {@link PersistenceBackendFactory#flush()} instead
+	 * Use {@link PersistenceBackendFactory#flush(String)} instead
 	 * @param context
 	 * @param timeout
 	 * @param timeUnit

src/main/java/org/gcube/documentstore/records/DSMapper.java

@@ -50,8 +50,9 @@ public class DSMapper {
 	 * Write the serialization of a given resource to a given
 	 * {@link OutputStream} .
 	 * 
-	 * @param resource the resource
+	 * @param object the resource
 	 * @param stream the stream in input
+	 * @return the OutputStream
 	 * @throws IOException
 	 * @throws JsonMappingException
 	 * @throws JsonGenerationException
@@ -64,8 +65,9 @@ public class DSMapper {
 
 	/**
 	 * Write the serialization of a given resource to a given {@link Writer} .
-	 * @param resource the resource
+	 * @param object the resource
 	 * @param writer the writer in input
+	 * @return the Writer
 	 * @throws IOException
 	 * @throws JsonMappingException
 	 * @throws JsonGenerationException

src/main/java/org/gcube/documentstore/records/Record.java

@@ -57,9 +57,7 @@ public interface Record extends Comparable<Record>, Serializable {
 	public Set<String> getComputedFields();
 	
 	/**
-	 * 
-	 * @param instance
-	 * @return
+	 * @return Querable Keys as SortedSet
 	 * @throws Exception
 	 */
 	@JsonIgnore

src/main/java/org/gcube/documentstore/records/RecordUtility.java

@@ -220,7 +220,7 @@ public class RecordUtility {
 	
 	/**
 	 * Create a Record from a Map serialized using toString()
-	 * @param serializedMapOrValidJSON the String representation of Map
+	 * @param jsonString the String representation of Map
 	 * @return the Record
 	 * @throws Exception if deserialization fails
 	 */

src/main/java/org/gcube/documentstore/records/aggregation/AggregationScheduler.java

@@ -230,14 +230,10 @@ public abstract class AggregationScheduler implements Runnable {
 	}
 
 	/**
-	 * Get an usage records and try to aggregate with other buffered Usage
-	 * Record.
-	 * 
-	 * @param singleRecord
-	 *            the Usage Record To Buffer
-	 * @return true if is time to persist the buffered Usage Record
+	 * Get a record and try to aggregate with other buffered Records.
+	 * @param record The Record
+	 * @param persistenceExecutor
 	 * @throws Exception
-	 *             if fails
 	 */
 	public void aggregate(Record record, PersistenceExecutor persistenceExecutor) throws Exception {
 		aggregate(record, persistenceExecutor, false);
@@ -259,8 +255,7 @@ public abstract class AggregationScheduler implements Runnable {
 
 	/**
 	 * Get Configuration (used from reload configuration)
-	 * 
-	 * @return
+	 * @return PersistenceBackendConfiguration
 	 */
 	protected PersistenceBackendConfiguration getConfiguration() {
 		ServiceLoader<PersistenceBackend> serviceLoader = ServiceLoader.load(PersistenceBackend.class);

src/main/java/org/gcube/documentstore/records/implementation/AbstractRecord.java

@@ -212,9 +212,6 @@ public abstract class AbstractRecord implements Record {
 		return new HashSet<String>(computedFields);
 	}
 
-	/**
-	 * {@inheritDoc}
-	 */
 	@JsonIgnore
 	public Set<String> getAggregatedFields() {
 		return new HashSet<String>(aggregatedFields);
@@ -376,16 +373,13 @@ public abstract class AbstractRecord implements Record {
 	
 	/**
 	 * Set the boolean aggregate by this Record
-	 * @param Boolean aggregate
+	 * @param aggregate
 	 * @throws InvalidValueException
 	 */
 	protected void setAggregated(Boolean aggregate) throws InvalidValueException {
 		setResourceProperty(AggregatedRecord.AGGREGATED, aggregate);
 	}
-	/**
-	 * Return the boolean aggregate by this Record
-	 * @return Boolean Aggregate
-	 */
+
 	@JsonIgnore
 	protected Boolean isAggregated() {
 		Boolean bool = (Boolean) this.resourceProperties.get(AggregatedRecord.AGGREGATED);