Javadoc fixes found by jdk12

Author: majst01

compile-and-test.sh

@@ -5,7 +5,7 @@
 set -e
 
 DEFAULT_INFLUXDB_VERSION="1.7"
-DEFAULT_MAVEN_JAVA_VERSION="3-jdk-11-slim"
+DEFAULT_MAVEN_JAVA_VERSION="3-jdk-12-alpine"
 
 INFLUXDB_VERSION="${INFLUXDB_VERSION:-$DEFAULT_INFLUXDB_VERSION}"
 MAVEN_JAVA_VERSION="${MAVEN_JAVA_VERSION:-$DEFAULT_MAVEN_JAVA_VERSION}"

src/main/java/org/influxdb/InfluxDB.java

@@ -166,6 +166,8 @@ public interface Cancellable {
    * Note that batch processing needs to be explicitly stopped before the application is shutdown.
    * To do so call disableBatch().
    *
+   * @param batchOptions
+   *            the options to set for batching the writes.
    * @return the InfluxDB instance to be able to use it in a fluent manner.
    */
   public InfluxDB enableBatch(final BatchOptions batchOptions);
@@ -551,8 +553,8 @@ public void query(Query query, int chunkSize, BiConsumer<Cancellable, QueryResul
    *
    * @param name
    *            the name of the new database.
-   * @deprecated (since 2.9, removed in 3.0) Use <tt>org.influxdb.InfluxDB.query(Query)</tt> to execute a parameterized
-   *             <strong>CREATE DATABASE</strong> query.
+   * @deprecated (since 2.9, removed in 3.0) Use <code>org.influxdb.InfluxDB.query(Query)</code>
+   *             to execute a parameterized <strong>CREATE DATABASE</strong> query.
    */
   @Deprecated
   public void createDatabase(final String name);
@@ -562,8 +564,8 @@ public void query(Query query, int chunkSize, BiConsumer<Cancellable, QueryResul
    *
    * @param name
    *            the name of the database to delete.
-   * @deprecated (since 2.9, removed in 3.0) Use <tt>org.influxdb.InfluxDB.query(Query)</tt> to execute a
-   *             <strong>DROP DATABASE</strong> query.
+   * @deprecated (since 2.9, removed in 3.0) Use <code>org.influxdb.InfluxDB.query(Query)</code>
+   *             to execute a <strong>DROP DATABASE</strong> query.
    */
   @Deprecated
   public void deleteDatabase(final String name);
@@ -572,8 +574,8 @@ public void query(Query query, int chunkSize, BiConsumer<Cancellable, QueryResul
    * Describe all available databases.
    *
    * @return a List of all Database names.
-   * @deprecated (since 2.9, removed in 3.0) Use <tt>org.influxdb.InfluxDB.query(Query)</tt> to execute a
-   *             <strong>SHOW DATABASES</strong> query.
+   * @deprecated (since 2.9, removed in 3.0) Use <code>org.influxdb.InfluxDB.query(Query)</code>
+   *             to execute a <strong>SHOW DATABASES</strong> query.
    */
   @Deprecated
   public List<String> describeDatabases();
@@ -585,8 +587,8 @@ public void query(Query query, int chunkSize, BiConsumer<Cancellable, QueryResul
    *            the name of the database to search.
    *
    * @return true if the database exists or false if it doesn't exist
-   * @deprecated (since 2.9, removed in 3.0) Use <tt>org.influxdb.InfluxDB.query(Query)</tt> to execute a
-   *             <strong>SHOW DATABASES</strong> query and inspect the result.
+   * @deprecated (since 2.9, removed in 3.0) Use <code>org.influxdb.InfluxDB.query(Query)</code>
+   *             to execute a <strong>SHOW DATABASES</strong> query and inspect the result.
    */
   @Deprecated
   public boolean databaseExists(final String name);
@@ -639,8 +641,8 @@ public void query(Query query, int chunkSize, BiConsumer<Cancellable, QueryResul
    * @param shardDuration the shardDuration
    * @param replicationFactor the replicationFactor of the rp
    * @param isDefault if the rp is the default rp for the database or not
-   * @deprecated (since 2.9, removed in 3.0) Use <tt>org.influxdb.InfluxDB.query(Query)</tt> to execute a parameterized
-   *             <strong>CREATE RETENTION POLICY</strong> query.
+   * @deprecated (since 2.9, removed in 3.0) Use <code>org.influxdb.InfluxDB.query(Query)</code>
+   *             to execute a parameterized <strong>CREATE RETENTION POLICY</strong> query.
    */
   @Deprecated
   public void createRetentionPolicy(final String rpName, final String database, final String duration,
@@ -653,8 +655,8 @@ public void createRetentionPolicy(final String rpName, final String database, fi
    * @param duration the duration of the rp
    * @param replicationFactor the replicationFactor of the rp
    * @param isDefault if the rp is the default rp for the database or not
-   * @deprecated (since 2.9, removed in 3.0) Use <tt>org.influxdb.InfluxDB.query(Query)</tt> to execute a parameterized
-   *             <strong>CREATE RETENTION POLICY</strong> query.
+   * @deprecated (since 2.9, removed in 3.0) Use <code>org.influxdb.InfluxDB.query(Query)</code>
+   *             to execute a parameterized <strong>CREATE RETENTION POLICY</strong> query.
    */
   @Deprecated
   public void createRetentionPolicy(final String rpName, final String database, final String duration,
@@ -667,8 +669,8 @@ public void createRetentionPolicy(final String rpName, final String database, fi
    * @param duration the duration of the rp
    * @param shardDuration the shardDuration
    * @param replicationFactor the replicationFactor of the rp
-   * @deprecated (since 2.9, removed in 3.0) Use <tt>org.influxdb.InfluxDB.query(Query)</tt> to execute a parameterized
-   *             <strong>CREATE RETENTION POLICY</strong> query.
+   * @deprecated (since 2.9, removed in 3.0) Use <code>org.influxdb.InfluxDB.query(Query)</code>
+   *             to execute a parameterized <strong>CREATE RETENTION POLICY</strong> query.
    */
   @Deprecated
   public void createRetentionPolicy(final String rpName, final String database, final String duration,
@@ -678,8 +680,8 @@ public void createRetentionPolicy(final String rpName, final String database, fi
    * Drops a retentionPolicy in a database.
    * @param rpName the name of the retentionPolicy
    * @param database the name of the database
-   * @deprecated (since 2.9, removed in 3.0) Use <tt>org.influxdb.InfluxDB.query(Query)</tt> to execute a
-   *             <strong>DROP RETENTION POLICY</strong> query.
+   * @deprecated (since 2.9, removed in 3.0) Use <code>org.influxdb.InfluxDB.query(Query)</code>
+   *             to execute a <strong>DROP RETENTION POLICY</strong> query.
    */
   @Deprecated
   public void dropRetentionPolicy(final String rpName, final String database);

src/main/java/org/influxdb/InfluxDBException.java

@@ -179,7 +179,8 @@ public static InfluxDBException buildExceptionForErrorState(final String errorBo
   /**
    * Create corresponding InfluxDBException from the message pack error body.
    * @param messagePackErrorBody
-   * @return
+   *          the error body if any
+   * @return the Exception
    */
   public static InfluxDBException buildExceptionForErrorState(final InputStream messagePackErrorBody) {
     try {

src/main/java/org/influxdb/dto/BatchPoints.java

@@ -140,7 +140,7 @@ public Builder consistency(final ConsistencyLevel consistencyLevel) {
 
     /**
      * Set the time precision to use for the whole batch. If unspecified, will default to {@link TimeUnit#NANOSECONDS}
-     * @param precision
+     * @param precision the precision of the points
      * @return the Builder instance
      */
     public Builder precision(final TimeUnit precision) {

src/main/java/org/influxdb/impl/InfluxDBResultMapper.java

@@ -56,7 +56,7 @@ public class InfluxDBResultMapper {
   private static final boolean ADD_DECIMAL_POINT = true;
 
   /**
-   * When a query is executed without {@link TimeUnit}, InfluxDB returns the <tt>time</tt>
+   * When a query is executed without {@link TimeUnit}, InfluxDB returns the <code>time</code>
    * column as a RFC3339 date.
    */
   private static final DateTimeFormatter RFC3339_FORMATTER = new DateTimeFormatterBuilder()
@@ -80,7 +80,7 @@ public class InfluxDBResultMapper {
    * same order as received from InfluxDB.
    *
    * @throws InfluxDBMapperException If {@link QueryResult} parameter contain errors,
-   * <tt>clazz</tt> parameter is not annotated with &#64;Measurement or it was not
+   * <code>clazz</code> parameter is not annotated with &#64;Measurement or it was not
    * possible to define the values of your POJO (e.g. due to an unsupported field type).
    */
   public <T> List<T> toPOJO(final QueryResult queryResult, final Class<T> clazz) throws InfluxDBMapperException {
@@ -103,7 +103,7 @@ public <T> List<T> toPOJO(final QueryResult queryResult, final Class<T> clazz) t
    * same order as received from InfluxDB.
    *
    * @throws InfluxDBMapperException If {@link QueryResult} parameter contain errors,
-   * <tt>clazz</tt> parameter is not annotated with &#64;Measurement or it was not
+   * <code>clazz</code> parameter is not annotated with &#64;Measurement or it was not
    * possible to define the values of your POJO (e.g. due to an unsupported field type).
    */
   public <T> List<T> toPOJO(final QueryResult queryResult, final Class<T> clazz,
@@ -129,7 +129,7 @@ public <T> List<T> toPOJO(final QueryResult queryResult, final Class<T> clazz,
    * same order as received from InfluxDB.
    *
    * @throws InfluxDBMapperException If {@link QueryResult} parameter contain errors,
-   * <tt>clazz</tt> parameter is not annotated with &#64;Measurement or it was not
+   * <code>clazz</code> parameter is not annotated with &#64;Measurement or it was not
    * possible to define the values of your POJO (e.g. due to an unsupported field type).
    */
   public <T> List<T> toPOJO(final QueryResult queryResult, final Class<T> clazz, final String measurementName)
@@ -154,7 +154,7 @@ public <T> List<T> toPOJO(final QueryResult queryResult, final Class<T> clazz, f
    * same order as received from InfluxDB.
    *
    * @throws InfluxDBMapperException If {@link QueryResult} parameter contain errors,
-   * <tt>clazz</tt> parameter is not annotated with &#64;Measurement or it was not
+   * <code>clazz</code> parameter is not annotated with &#64;Measurement or it was not
    * possible to define the values of your POJO (e.g. due to an unsupported field type).
    */
   public <T> List<T> toPOJO(final QueryResult queryResult, final Class<T> clazz, final String measurementName,

src/main/java/org/influxdb/querybuilder/BuiltQuery.java

@@ -153,15 +153,18 @@ public static Clause subTime(final long interval, final String literal) {
       return new SubRelativeTimeClause(new TimeInterval(interval, literal));
     }
 
-    /** @return */
+    /**
+     *
+     * @return the Ordering
+     */
     public static Ordering asc() {
       return new Ordering(false);
     }
 
     /**
      * InfluxDB supports only time for ordering.
      *
-     * @return
+     * @return the Ordering
      */
     public static Ordering desc() {
       return new Ordering(true);