From 1a26cd717f75ba6c2584b5066c1af6b476984510 Mon Sep 17 00:00:00 2001 From: robin Date: Mon, 1 Mar 2021 23:40:06 +1300 Subject: [PATCH] #2182 - Tidy javadoc - this may mean JDK 15 is required to generate javadoc --- .../src/main/java/io/ebean/BeanFinder.java | 2 +- .../main/java/io/ebean/BeanRepository.java | 4 +- .../src/main/java/io/ebean/Database.java | 2 +- .../src/main/java/io/ebean/DocumentStore.java | 2 +- ebean-api/src/main/java/io/ebean/Ebean.java | 2 +- .../main/java/io/ebean/ExpressionFactory.java | 4 +- .../main/java/io/ebean/ExpressionList.java | 4 +- ebean-api/src/main/java/io/ebean/Finder.java | 4 +- ebean-api/src/main/java/io/ebean/Model.java | 12 ++-- ebean-api/src/main/java/io/ebean/Pairs.java | 2 +- ebean-api/src/main/java/io/ebean/RawSql.java | 8 +-- .../src/main/java/io/ebean/RowMapper.java | 2 +- ebean-api/src/main/java/io/ebean/Update.java | 12 ++-- .../ebean/config/DatabaseConfigProvider.java | 2 +- .../io/ebean/config/ServerConfigProvider.java | 2 +- .../config/dbplatform/DbDefaultValue.java | 2 +- .../io/ebean/typequery/PBaseCompareable.java | 8 +-- .../java/io/ebean/typequery/TQRootBean.java | 56 +++++++------------ 18 files changed, 57 insertions(+), 73 deletions(-) diff --git a/ebean-api/src/main/java/io/ebean/BeanFinder.java b/ebean-api/src/main/java/io/ebean/BeanFinder.java index 00aec8de5..2c8e04eec 100644 --- a/ebean-api/src/main/java/io/ebean/BeanFinder.java +++ b/ebean-api/src/main/java/io/ebean/BeanFinder.java @@ -14,7 +14,7 @@ import java.util.Optional; * * public class CustomerFinder extends BeanFinder { * - * @Inject + * @Inject * public CustomerFinder(Database database) { * super(Customer.class, database); * } diff --git a/ebean-api/src/main/java/io/ebean/BeanRepository.java b/ebean-api/src/main/java/io/ebean/BeanRepository.java index 19f390582..b89a49b39 100644 --- a/ebean-api/src/main/java/io/ebean/BeanRepository.java +++ b/ebean-api/src/main/java/io/ebean/BeanRepository.java @@ -9,10 +9,10 @@ import java.util.Collection; *

*

{@code
  *
- * @Repository
+ * @Repository
  * public class CustomerRepository extends BeanRepository {
  *
- *   @Inject
+ *   @Inject
  *   public CustomerRepository(Database server) {
  *     super(Customer.class, server);
  *   }
diff --git a/ebean-api/src/main/java/io/ebean/Database.java b/ebean-api/src/main/java/io/ebean/Database.java
index 5bbf29ad3..bd38253de 100644
--- a/ebean-api/src/main/java/io/ebean/Database.java
+++ b/ebean-api/src/main/java/io/ebean/Database.java
@@ -897,7 +897,7 @@ public interface Database {
    * 
{@code
    *   public class Order { ...
    *
-   *     @OneToMany(cascade=CascadeType.ALL, mappedBy="order")
+   *     @OneToMany(cascade=CascadeType.ALL, mappedBy="order")
    * 	   List details;
    * 	   ...
    *   }
diff --git a/ebean-api/src/main/java/io/ebean/DocumentStore.java b/ebean-api/src/main/java/io/ebean/DocumentStore.java
index a4f75132d..0a2353ff0 100644
--- a/ebean-api/src/main/java/io/ebean/DocumentStore.java
+++ b/ebean-api/src/main/java/io/ebean/DocumentStore.java
@@ -149,7 +149,7 @@ public interface DocumentStore {
    *    .setUseDocStore(true)
    *    .where()... // perhaps add predicates
    *    .findEachWhile(new Predicate() {
-   *      @Override
+   *      @Override
    *      public void accept(Order bean) {
    *        // process the bean
    *
diff --git a/ebean-api/src/main/java/io/ebean/Ebean.java b/ebean-api/src/main/java/io/ebean/Ebean.java
index f68a0666b..fb0e34db3 100644
--- a/ebean-api/src/main/java/io/ebean/Ebean.java
+++ b/ebean-api/src/main/java/io/ebean/Ebean.java
@@ -346,7 +346,7 @@ public final class Ebean {
    * 
{@code
    *   public class Order { ...
    *
-   *     @OneToMany(cascade=CascadeType.ALL, mappedBy="order")
+   *     @OneToMany(cascade=CascadeType.ALL, mappedBy="order")
    * 	   List details;
    * 	   ...
    *   }
diff --git a/ebean-api/src/main/java/io/ebean/ExpressionFactory.java b/ebean-api/src/main/java/io/ebean/ExpressionFactory.java
index 1e5c4ebf5..3bcd5cb39 100644
--- a/ebean-api/src/main/java/io/ebean/ExpressionFactory.java
+++ b/ebean-api/src/main/java/io/ebean/ExpressionFactory.java
@@ -200,7 +200,7 @@ public interface ExpressionFactory {
   Expression gtOrNull(String propertyName, Object value);
 
   /**
-   * Greater than or Equal to OR Null  >= or null 
+   * Greater than or Equal to OR Null ({@code >= or null })
    * 

* A convenient expression combining GE and Is Null. Most often useful for range * expressions where the top range value is nullable. @@ -227,7 +227,7 @@ public interface ExpressionFactory { Expression ltOrNull(String propertyName, Object value); /** - * Less Than or Equal to OR Null <= or null + * Less Than or Equal to OR Null ({@code <= or null }) *

* A convenient expression combining LE and Is Null. Most often useful for range * expressions where the bottom range value is nullable. diff --git a/ebean-api/src/main/java/io/ebean/ExpressionList.java b/ebean-api/src/main/java/io/ebean/ExpressionList.java index e137f64ba..7e4e0f164 100644 --- a/ebean-api/src/main/java/io/ebean/ExpressionList.java +++ b/ebean-api/src/main/java/io/ebean/ExpressionList.java @@ -909,7 +909,7 @@ public interface ExpressionList { ExpressionList gtOrNull(String propertyName, Object value); /** - * Greater Than or Equal to OR Null - >= or null . + * Greater Than or Equal to OR Null - ({@code >= or null }). */ ExpressionList geOrNull(String propertyName, Object value); @@ -930,7 +930,7 @@ public interface ExpressionList { ExpressionList ltOrNull(String propertyName, Object value); /** - * Less Than or Equal to OR Null - <= or null . + * Less Than or Equal to OR Null - ({@code <= or null }). */ ExpressionList leOrNull(String propertyName, Object value); diff --git a/ebean-api/src/main/java/io/ebean/Finder.java b/ebean-api/src/main/java/io/ebean/Finder.java index e91238344..3c9318e7d 100644 --- a/ebean-api/src/main/java/io/ebean/Finder.java +++ b/ebean-api/src/main/java/io/ebean/Finder.java @@ -37,7 +37,7 @@ import java.util.List; * } * } * - * @Entity + * @Entity * public class Customer extends BaseModel { * * public static final CustomerFinder find = new CustomerFinder(); @@ -80,7 +80,7 @@ public class Finder { * // ... add extra customer specific finder methods * } * - * @Entity + * @Entity * public class Customer extends BaseModel { * * public static final CustomerFinder find = new CustomerFinder(); diff --git a/ebean-api/src/main/java/io/ebean/Model.java b/ebean-api/src/main/java/io/ebean/Model.java index 5fe2205e1..ac2f11ea7 100644 --- a/ebean-api/src/main/java/io/ebean/Model.java +++ b/ebean-api/src/main/java/io/ebean/Model.java @@ -32,16 +32,16 @@ import io.ebean.bean.EntityBean; * // Typically there is a common base model that has some * // common properties like the ones below * - * @MappedSuperclass + * @MappedSuperclass * public class BaseModel extends Model { * - * @Id Long id; + * @Id Long id; * - * @Version Long version; + * @Version Long version; * - * @WhenCreated Timestamp whenCreated; + * @WhenCreated Timestamp whenCreated; * - * @WhenUpdated Timestamp whenUpdated; + * @WhenUpdated Timestamp whenUpdated; * * ... * } @@ -52,7 +52,7 @@ import io.ebean.bean.EntityBean; * * // Extend the mappedSuperclass * - * @Entity @Table(name="o_account") + * @Entity @Table(name="o_account") * public class Customer extends BaseModel { * * String name; diff --git a/ebean-api/src/main/java/io/ebean/Pairs.java b/ebean-api/src/main/java/io/ebean/Pairs.java index 4f609f95a..bd5ee5137 100644 --- a/ebean-api/src/main/java/io/ebean/Pairs.java +++ b/ebean-api/src/main/java/io/ebean/Pairs.java @@ -18,7 +18,7 @@ import java.util.List; * * // where a bean is annotated with a complex * // natural key made of several properties - * @Cache(naturalKey = {"store","code","sku"}) + * @Cache(naturalKey = {"store","code","sku"}) * * * Pairs pairs = new Pairs("sku", "code"); diff --git a/ebean-api/src/main/java/io/ebean/RawSql.java b/ebean-api/src/main/java/io/ebean/RawSql.java index e0e20714b..901f1a43c 100644 --- a/ebean-api/src/main/java/io/ebean/RawSql.java +++ b/ebean-api/src/main/java/io/ebean/RawSql.java @@ -41,14 +41,14 @@ package io.ebean; *

Example OrderAggregate

*
{@code
  *  ...
- *   // @Sql indicates to that this bean
+ *   // @Sql indicates to that this bean
  *   // is based on RawSql rather than a table
  *
- *   @Entity
- *   @Sql
+ *   @Entity
+ *   @Sql
  *   public class OrderAggregate {
  *
- *    @OneToOne
+ *    @OneToOne
  *    Order order;
  *
  *    Double totalAmount;
diff --git a/ebean-api/src/main/java/io/ebean/RowMapper.java b/ebean-api/src/main/java/io/ebean/RowMapper.java
index 47e96498d..b1d59c984 100644
--- a/ebean-api/src/main/java/io/ebean/RowMapper.java
+++ b/ebean-api/src/main/java/io/ebean/RowMapper.java
@@ -22,7 +22,7 @@ import java.sql.SQLException;
  *    //
  *    class CustomerMapper implements RowMapper {
  *
- *     @Override
+ *     @Override
  *     public CustomerDto map(ResultSet rset, int rowNum) throws SQLException {
  *
  *       long id = rset.getLong(1);
diff --git a/ebean-api/src/main/java/io/ebean/Update.java b/ebean-api/src/main/java/io/ebean/Update.java
index 25aed9315..ece973392 100644
--- a/ebean-api/src/main/java/io/ebean/Update.java
+++ b/ebean-api/src/main/java/io/ebean/Update.java
@@ -13,23 +13,23 @@ package io.ebean;
  * 

*
{@code
  *    ...
- *   @NamedUpdates(value = {
- *     @NamedUpdate(
+ *   @NamedUpdates(value = {
+ *     @NamedUpdate(
  *       name = "setTitle",
  *       notifyCache = false,
  *       update = "update topic set title = :title, postCount = :count where id = :id"),
- *    @NamedUpdate(
+ *    @NamedUpdate(
  *       name = "setPostCount",
  *       notifyCache = false,
  *       update = "update f_topic set post_count = :postCount where id = :id"),
- *    @NamedUpdate(
+ *    @NamedUpdate(
  *       name = "incrementPostCount",
  *       notifyCache = false,
  *       update = "update Topic set postCount = postCount + 1 where id = :id")
  *       //update = "update f_topic set post_count = post_count + 1 where id = :id")
  *   })
- *   @Entity
- *   @Table(name = "f_topic")
+ *   @Entity
+ *   @Table(name = "f_topic")
  *   public class Topic {
  *     ...
  *   }
diff --git a/ebean-api/src/main/java/io/ebean/config/DatabaseConfigProvider.java b/ebean-api/src/main/java/io/ebean/config/DatabaseConfigProvider.java
index 0a1f3e768..066af5fc4 100644
--- a/ebean-api/src/main/java/io/ebean/config/DatabaseConfigProvider.java
+++ b/ebean-api/src/main/java/io/ebean/config/DatabaseConfigProvider.java
@@ -15,7 +15,7 @@ package io.ebean.config;
  *
  * public class EbeanConfigProvider implements DatabaseConfigProvider {
  *
- *   @Override
+ *   @Override
  *   public void apply(DatabaseConfig config) {
  *
  *     // register the entity bean classes explicitly
diff --git a/ebean-api/src/main/java/io/ebean/config/ServerConfigProvider.java b/ebean-api/src/main/java/io/ebean/config/ServerConfigProvider.java
index f992b004d..1ba45907d 100644
--- a/ebean-api/src/main/java/io/ebean/config/ServerConfigProvider.java
+++ b/ebean-api/src/main/java/io/ebean/config/ServerConfigProvider.java
@@ -16,7 +16,7 @@ package io.ebean.config;
  *
  * public class EbeanConfigProvider implements ServerConfigProvider {
  *
- *   @Override
+ *   @Override
  *   public void apply(ServerConfig config) {
  *
  *     // register the entity bean classes explicitly
diff --git a/ebean-api/src/main/java/io/ebean/config/dbplatform/DbDefaultValue.java b/ebean-api/src/main/java/io/ebean/config/dbplatform/DbDefaultValue.java
index b74465f35..851fc2707 100644
--- a/ebean-api/src/main/java/io/ebean/config/dbplatform/DbDefaultValue.java
+++ b/ebean-api/src/main/java/io/ebean/config/dbplatform/DbDefaultValue.java
@@ -79,7 +79,7 @@ public class DbDefaultValue {
   }
 
   /**
-   * This method checks & convert the {@link DbDefault#value()} to a valid SQL literal.
+   * This method checks and converts the {@link DbDefault#value()} to a valid SQL literal.
    *
    * This is mainly to quote string literals and verify integer/dates for correctness.
    * 

diff --git a/ebean-querybean/src/main/java/io/ebean/typequery/PBaseCompareable.java b/ebean-querybean/src/main/java/io/ebean/typequery/PBaseCompareable.java index c9488f63c..4e0ba7c1d 100644 --- a/ebean-querybean/src/main/java/io/ebean/typequery/PBaseCompareable.java +++ b/ebean-querybean/src/main/java/io/ebean/typequery/PBaseCompareable.java @@ -121,12 +121,12 @@ public class PBaseCompareable extends PBaseValueEqual { * Greater or equal to lower value and strictly less than upper value. *

* This is generally preferable over Between for date and datetime types - * as SQL Between is inclusive on the upper bound (<=) and generally we - * need the upper bound to be exclusive (<). + * as SQL Between is inclusive on the upper bound ({@code <= }) and generally + * we need the upper bound to be exclusive ({@code < }). *

* - * @param lower the lower bind value (>=) - * @param upper the upper bind value (<) + * @param lower the lower bind value ({@code >= }) + * @param upper the upper bind value ({@code < }) * @return the root query bean instance */ public final R inRange(T lower, T upper) { diff --git a/ebean-querybean/src/main/java/io/ebean/typequery/TQRootBean.java b/ebean-querybean/src/main/java/io/ebean/typequery/TQRootBean.java index de8f846a6..4deab6037 100644 --- a/ebean-querybean/src/main/java/io/ebean/typequery/TQRootBean.java +++ b/ebean-querybean/src/main/java/io/ebean/typequery/TQRootBean.java @@ -43,55 +43,39 @@ import java.util.function.Predicate; import java.util.stream.Stream; /** - * Base root query bean. + * Base root query bean providing common features for all root query beans. *

- * With code generation for each entity bean type a query bean is created that extends this. + * For each entity bean querybean-generator generates a query bean that extends TQRootBean. *

- * Provides common features for all root query beans + * *

- *

- *

Example - QCustomer extends TQRootBean

- *

- * These 'query beans' like QCustomer are generated using the avaje-ebeanorm-typequery-generator. - *

- *
{@code
- *
- *   public class QCustomer extends TQRootBean {
- *
- *     // properties
- *     public PLong id;
- *
- *     public PString name;
- *     ...
- *
- * }
- *

*

Example - usage of QCustomer

*
{@code
  *
- *    Date fiveDaysAgo = ...
+ *  Date fiveDaysAgo = ...
  *
- *    List customers =
- *        new QCustomer()
- *          .name.ilike("rob")
- *          .status.equalTo(Customer.Status.GOOD)
- *          .registered.after(fiveDaysAgo)
- *          .contacts.email.endsWith("@foo.com")
- *          .orderBy()
- *            .name.asc()
- *            .registered.desc()
- *          .findList();
+ *  List customers =
+ *      new QCustomer()
+ *        .name.ilike("rob")
+ *        .status.equalTo(Customer.Status.GOOD)
+ *        .registered.after(fiveDaysAgo)
+ *        .contacts.email.endsWith("@foo.com")
+ *        .orderBy()
+ *          .name.asc()
+ *          .registered.desc()
+ *        .findList();
  *
  * }
*

*

Resulting SQL where

*

- *

{@code sql
+ * 
{@code
  *
- *     where lower(t0.name) like ?  and t0.status = ?  and t0.registered > ?  and u1.email like ?
- *     order by t0.name, t0.registered desc;
+ *   where lower(t0.name) like ?  and t0.status = ?  and t0.registered > ?  and u1.email like ?
+ *   order by t0.name, t0.registered desc;
+ *
+ *   --bind(rob,GOOD,Mon Jul 27 12:05:37 NZST 2015,%@foo.com)
  *
- *     --bind(rob,GOOD,Mon Jul 27 12:05:37 NZST 2015,%@foo.com)
  * }
* * @param the entity bean type (normal entity bean type e.g. Customer) @@ -280,7 +264,7 @@ public abstract class TQRootBean { */ @SafeVarargs public final R select(TQProperty... properties) { - ((SpiQueryFetch)query).selectProperties(properties(properties)); + ((SpiQueryFetch) query).selectProperties(properties(properties)); return root; }