no effective change - format and javadoc

src/main/java/com/avaje/ebean/annotation/Aggregation.java

@@ -13,7 +13,7 @@ import java.lang.annotation.Target;
  * included in a query. To populate the aggregation property it must be
  * explicitly included in the select().
  * </p>
- *
+ * <p>
  * <h3>Example:</h3>
  * <pre>{@code
  *
@@ -24,7 +24,7 @@ import java.lang.annotation.Target;
  * Long totalAmount;
  *
  * }</pre>
- *
+ * <p>
  * <h3>Example query</h3>
  * <pre>{@code
  *

src/main/java/com/avaje/ebean/annotation/Cache.java

@@ -8,7 +8,7 @@ import java.lang.annotation.Target;
 /**
  * Specify the default cache use specific entity type.
  */
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Cache {
 

src/main/java/com/avaje/ebean/annotation/CacheBeanTuning.java

@@ -12,7 +12,7 @@ import java.lang.annotation.Target;
  * ElasticSearch, Hazelcast, Ignite etc.
  * </p>
  */
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface CacheBeanTuning {
 

src/main/java/com/avaje/ebean/annotation/CacheQueryTuning.java

@@ -11,7 +11,7 @@ import java.lang.annotation.Target;
  * If this is not specified then the system default settings are used.
  * </p>
  */
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface CacheQueryTuning {
 

src/main/java/com/avaje/ebean/annotation/CreatedTimestamp.java

@@ -22,7 +22,7 @@ import java.lang.annotation.Target;
  * timestamp value after the insert has occurred. You need to fetch the entity
  * back to get the inserted timestamp if you want to used it.
  * </p>
- *
+ * <p>
  * <h3>Example:</h3>
  * <pre>{@code
  *
@@ -31,7 +31,7 @@ import java.lang.annotation.Target;
  *
  * }</pre>
  */
-@Target({ ElementType.FIELD, ElementType.METHOD })
+@Target({ElementType.FIELD, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface CreatedTimestamp {
 

src/main/java/com/avaje/ebean/annotation/DbArray.java

@@ -11,7 +11,7 @@ import java.lang.annotation.Target;
  * If the target database does not support ARRAY type (so not Postgres)
  * then the collection will be stored in JSON format into a VARCHAR column.
  * </p>
- *
+ * <p>
  * <h3>Example:</h3>
  * <pre>{@code
  *

src/main/java/com/avaje/ebean/annotation/DbHstore.java

@@ -10,7 +10,7 @@ import java.lang.annotation.Target;
  * <p>
  * The Map property should have keys and values of type String.
  * </p>
- *
+ * <p>
  * <h3>Example:</h3>
  * <pre>{@code
  *
@@ -27,4 +27,4 @@ public @interface DbHstore {
    * For VARCHAR storage specify the column length (defaults to 1000).
    */
   int length() default 0;
-}
+}

src/main/java/com/avaje/ebean/annotation/DbJson.java

@@ -18,7 +18,7 @@ import java.lang.annotation.Target;
  * Map<String,Object> content;
  *
  * }</pre>
- *
+ * <p>
  * <h3>Example with JSONB storage</h3>
  * <pre>{@code
  *
@@ -41,4 +41,4 @@ public @interface DbJson {
    * For VARCHAR storage specify the column length (defaults to 3000).
    */
   int length() default 0;
-}
+}

src/main/java/com/avaje/ebean/annotation/DbJsonB.java

@@ -11,9 +11,9 @@ import java.lang.annotation.Target;
  * The content will be stored on Postgres using it's JSONB type and as Clob for other databases.
  * </p>
  * <p>
- *   This is equivalent to using <code>@DbJson(storage = DbJsonType.JSONB)</code>
+ * This is equivalent to using <code>@DbJson(storage = DbJsonType.JSONB)</code>
  * </p>
- *
+ * <p>
  * <h3>Example:</h3>
  * <pre>{@code
  *
@@ -22,7 +22,7 @@ import java.lang.annotation.Target;
  * Map<String,Object> content;
  *
  * }</pre>
- *
+ * <p>
  * <h3>Equivalent to:</h3>
  * <pre>{@code
  *
@@ -40,4 +40,4 @@ public @interface DbJsonB {
    * For VARCHAR storage specify the column length.
    */
   int length() default 0;
-}
+}

src/main/java/com/avaje/ebean/annotation/DocEmbedded.java

@@ -7,7 +7,6 @@ import java.lang.annotation.Target;
 
 /**
  * Specify the property is included in the parent document store index.
- *
  * <pre>{@code
  *
  *
@@ -25,7 +24,7 @@ import java.lang.annotation.Target;
  *
  * }</pre>
  */
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface DocEmbedded {
 

src/main/java/com/avaje/ebean/annotation/DocMapping.java

@@ -8,7 +8,7 @@ import java.lang.annotation.Target;
 /**
  * Specify the entity type maps to a document store (like ElasticSearch).
  */
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface DocMapping {
 

src/main/java/com/avaje/ebean/annotation/DocProperty.java

@@ -8,7 +8,7 @@ import java.lang.annotation.Target;
 /**
  * Specify the entity type maps to a document store (like ElasticSearch).
  */
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface DocProperty {
 

src/main/java/com/avaje/ebean/annotation/DocSortable.java

@@ -13,7 +13,7 @@ import java.lang.annotation.Target;
  * For example, customer name and product name are good candidates for marking with @DocSortable.
  * </p>
  */
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface DocSortable {
 

src/main/java/com/avaje/ebean/annotation/DocStore.java

@@ -8,7 +8,7 @@ import java.lang.annotation.Target;
 /**
  * Specify the entity type maps to a document store (like ElasticSearch).
  */
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface DocStore {
 
@@ -73,7 +73,6 @@ public @interface DocStore {
    * Note that typically DocStoreEmbedded is used on @ManyToOne and @OneToMany
    * properties to indicate what part of the nested document should be included.
    * </p>
-   *
    * <h3>Example:</h3>
    * <pre>{@code
    *

src/main/java/com/avaje/ebean/annotation/DocStoreMode.java

@@ -23,9 +23,9 @@ public enum DocStoreMode {
   /**
    * Ignore the event and not update the document store.
    * <p>
-   *   This can be used on a index or for a transaction where you want to have more
-   *   manual programmatic control over the updating of the document store.  Say you want to
-   *   IGNORE on a particular transaction and instead manually queue a bulk update.
+   * This can be used on a index or for a transaction where you want to have more
+   * manual programmatic control over the updating of the document store.  Say you want to
+   * IGNORE on a particular transaction and instead manually queue a bulk update.
    * </p>
    */
   IGNORE,

src/main/java/com/avaje/ebean/annotation/EmbeddedColumns.java

@@ -12,7 +12,7 @@ import java.lang.annotation.Target;
  * standard JPA.
  * </p>
  */
-@Target({ ElementType.FIELD, ElementType.METHOD })
+@Target({ElementType.FIELD, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface EmbeddedColumns {
 

src/main/java/com/avaje/ebean/annotation/Encrypted.java

@@ -8,7 +8,7 @@ import java.lang.annotation.Target;
 /**
  * Specify that the property is stored in encrypted form.
  */
-@Target({ ElementType.FIELD, ElementType.METHOD })
+@Target({ElementType.FIELD, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Encrypted {
 

src/main/java/com/avaje/ebean/annotation/EnumValue.java

@@ -7,21 +7,20 @@ import java.lang.annotation.Target;
 
 /**
  * Enables you to specify a value to use to persist for an enum value.
- * 
  * <pre>{@code
  *
  * public enum Status {
  *
  *   @EnumValue("N")
  *   NEW,
- * 
+ *
  *   @EnumValue("A")
  *   ACTIVE,
- * 
+ *
  *   @EnumValue("I")
  *   INACTIVE,
  * }
- * 
+ *
  * }</pre>
  * <p>
  * This is an alternative to using the JPA standard approach or Ebean's
@@ -33,7 +32,7 @@ import java.lang.annotation.Target;
  * and fetched as strings.
  * </p>
  */
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface EnumValue {
 

src/main/java/com/avaje/ebean/annotation/Formula.java

@@ -1,12 +1,12 @@
 package com.avaje.ebean.annotation;
 
+import com.avaje.ebean.Query;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-import com.avaje.ebean.Query;
-
 /**
  * Assign to a property to be based on a SQL formula.
  * <p>
@@ -24,28 +24,27 @@ import com.avaje.ebean.Query;
  * You may want to do this if the Formula is relatively expensive and only want
  * it included in the query when you explicitly state it.
  * </p>
- * 
- * <pre class="code">
- * // On the Order &quot;master&quot; bean
+ * <p>
+ * <pre>{@code
+ * // On the Order "master" bean
  * // ... a formula using the Order details
  * // ... sum(order_qty*unit_price)
- * &#064;Transient
- * &#064;Formula(select = &quot;_b${ta}.total_amount&quot;, join = &quot;join (select order_id, sum(order_qty*unit_price) as total_amount from o_order_detail group by order_id) as _b${ta} on _b${ta}.order_id = ${ta}.id&quot;)
+ * @Transient
+ * @Formula(select = "_b${ta}.total_amount", join = "join (select order_id, sum(order_qty*unit_price) as total_amount from o_order_detail group by order_id) as _b${ta} on _b${ta}.order_id = ${ta}.id")
  * Double totalAmount;
- * 
- * </pre>
+ *
+ * }</pre>
  * <p>
  * As the totalAmount formula is also Transient it is not included by default in
  * queries - it needs to be explicitly included.
  * </p>
- * 
  * <pre>{@code
  *
  * // find by Id
  * Order o1 = Ebean.find(Order.class)
  *     .select("id, totalAmount")
  *     .setId(1).findUnique();
- * 
+ *
  * // find list ... using totalAmount in the where clause
  * List<Order> list = Ebean.find(Order.class)
  *     .select("id, totalAmount")
@@ -53,7 +52,7 @@ import com.avaje.ebean.Query;
  *     .eq("status", Order.Status.NEW)
  *     .gt("totalAmount", 10)
  *     .findList();
- * 
+ *
  * // as a join from customer
  * List<Customer> l0 = Ebean.find(Customer.class)
  *     .select("id, name")
@@ -62,10 +61,10 @@ import com.avaje.ebean.Query;
  *     .gt("id", 0)
  *     .gt("orders.totalAmount", 10)
  *     .findList();
- * 
+ *
  * }</pre>
  */
-@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Formula {
 
@@ -84,7 +83,6 @@ public @interface Formula {
    * <p>
    * The join string should start with either "left join" or "join".
    * </p>
-   * 
    * <p>
    * You will almost certainly use the "${ta}" as a place holder for the table
    * alias of the table you are joining back to (the "base table" of the entity
@@ -94,7 +92,7 @@ public @interface Formula {
    * The example below is used to support a total count of topics created by a
    * user.
    * </p>
-   * 
+   * <p>
    * <pre>{@code
    *
    * join (select user_id, count(*) as topic_count from f_topic group by user_id) as _tc on _tc.user_id = ${ta}.id

src/main/java/com/avaje/ebean/annotation/History.java

@@ -12,7 +12,7 @@ import java.lang.annotation.Target;
  * typically automatically populated via database triggers.
  * </p>
  */
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface History {
 

src/main/java/com/avaje/ebean/annotation/HistoryExclude.java

@@ -18,7 +18,7 @@ import java.lang.annotation.Target;
  * support.
  * </p>
  */
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface HistoryExclude {
 

src/main/java/com/avaje/ebean/annotation/Index.java

@@ -29,7 +29,7 @@ public @interface Index {
   /**
    * When placed on the class (rather than field) you can specify the columns
    * to include in the index in order.
-   * 
+   * <p>
    * Wnen placed on a field, and columnNames are specified, the field-column has to be included.
    * You can use "${fa}" for alias
    */

src/main/java/com/avaje/ebean/annotation/Indices.java

@@ -4,9 +4,10 @@ import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+
 /**
  * An annotation for declaring multiple indices at class or field level.
- * 
+ *
  * @author Roland Praml, FOCONIS AG
  */
 @Target({ElementType.TYPE, ElementType.FIELD})

src/main/java/com/avaje/ebean/annotation/JsonIgnore.java

@@ -8,8 +8,8 @@ import java.lang.annotation.Target;
 /**
  * Similar to Jackson JsonIgnore but provides the option to just ignore serialize or deserialize.
  * <p>
- *   This provides the same features as Expose but from the opposite perspective which is probably
- *   more common and more familiar to Jackson users.
+ * This provides the same features as Expose but from the opposite perspective which is probably
+ * more common and more familiar to Jackson users.
  * </p>
  */
 @Retention(RetentionPolicy.RUNTIME)
@@ -29,4 +29,4 @@ public @interface JsonIgnore {
    * Defaults to {@code false}.
    */
   boolean deserialize() default false;
-}
+}

src/main/java/com/avaje/ebean/annotation/PrivateOwned.java

@@ -18,7 +18,7 @@ import java.lang.annotation.Target;
  * in that they are no longer associated/linked to their parent bean.
  * </p>
  */
-@Target({ ElementType.FIELD, ElementType.METHOD })
+@Target({ElementType.FIELD, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface PrivateOwned {
 

src/main/java/com/avaje/ebean/annotation/Sql.java

@@ -11,7 +11,7 @@ import java.lang.annotation.Target;
  * This means the entity bean has no base table specified (via @Table).
  * </p>
  */
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Sql {
 

src/main/java/com/avaje/ebean/annotation/Transactional.java

@@ -1,14 +1,14 @@
 package com.avaje.ebean.annotation;
 
+import com.avaje.ebean.TxIsolation;
+import com.avaje.ebean.TxType;
+import com.avaje.ebean.config.PersistBatch;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-import com.avaje.ebean.TxIsolation;
-import com.avaje.ebean.TxType;
-import com.avaje.ebean.config.PersistBatch;
-
 /**
  * Specify transaction scoping for a method.
  * <p>
@@ -33,22 +33,22 @@ import com.avaje.ebean.config.PersistBatch;
  * to set the default behaviour to rollback on any exception and optionally
  * change the setting to be consistent with EJB/Spring if people wish to do so.
  * </p>
- * 
+ * <p>
  * <pre>{@code
  *
  *  // a normal class
  *  public class MySimpleUserService {
- * 
+ *
  *    // this method is transactional automatically handling
  *    // transaction begin, commit and rollback etc
  *    @Transactional
  *    public void runInTrans() throws IOException {
- * 
+ *
  *      // tasks performed within the transaction
  *      ...
  *      // find some objects
  *      Customer cust = ebeanServer.find(Customer.class, 42);
- *    
+ *
  *      Order order = ...;
  *      ...
  *      // save some objects
@@ -58,7 +58,7 @@ import com.avaje.ebean.config.PersistBatch;
  *
  * }</pre>
  */
-@Target({ ElementType.METHOD, ElementType.TYPE })
+@Target({ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Transactional {
 

src/main/java/com/avaje/ebean/annotation/UpdateMode.java

@@ -14,13 +14,13 @@ import java.lang.annotation.Target;
  * <p>
  * Note that the default can be set via ebean.properties.
  * </p>
- * 
+ * <p>
  * <pre>
  * ## Set to update all loaded properties
  * ebean.updateChangesOnly=false
  * </pre>
  */
-@Target({ ElementType.TYPE })
+@Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface UpdateMode {
 

src/main/java/com/avaje/ebean/annotation/UpdatedTimestamp.java

@@ -13,7 +13,7 @@ import java.lang.annotation.Target;
  * towards a better naming convention (WhenCreated, WhenModified).
  * </p>
  */
-@Target({ ElementType.FIELD, ElementType.METHOD })
+@Target({ElementType.FIELD, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface UpdatedTimestamp {
 

src/main/java/com/avaje/ebean/annotation/WhenCreated.java

@@ -22,7 +22,7 @@ import java.lang.annotation.Target;
  * timestamp value after the insert has occurred. You need to fetch the entity
  * back to get the inserted timestamp if you want to used it.
  * </p>
- *
+ * <p>
  * <h3>Example:</h3>
  * <pre>{@code
  *
@@ -31,7 +31,7 @@ import java.lang.annotation.Target;
  *
  * }</pre>
  */
-@Target({ ElementType.FIELD, ElementType.METHOD })
+@Target({ElementType.FIELD, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface WhenCreated {
 

src/main/java/com/avaje/ebean/annotation/WhenModified.java

@@ -12,7 +12,7 @@ import java.lang.annotation.Target;
  * towards a better naming convention (WhenCreated, WhenModified).
  * </p>
  */
-@Target({ ElementType.FIELD, ElementType.METHOD })
+@Target({ElementType.FIELD, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface WhenModified {
 

src/main/java/com/avaje/ebean/annotation/Where.java

@@ -8,37 +8,33 @@ import java.lang.annotation.Target;
 /**
  * Add an Literal to add to the where clause when a many property (List, Set or
  * Map) is loaded or refreshed.
- * 
  * <pre>{@code
  *
  * // on a OneToMany property...
- * 
+ *
  * @OneToMany
  * @Where(clause = "deleted='y'")
  * List<Topic> topics;
  *
  * }</pre>
- * 
  * <p>
  * Note that you can include "${ta}" as a place holder for the table alias if
  * you need to include the table alias in the clause.
  * </p>
- * 
  * <pre>{@code
  * // ... including the ${ta} table alias placeholder...
- * 
+ *
  * @OneToMany
  * @Where(clause = "${ta}.deleted='y'")
  * List<Topic> topics;
  *
  * }</pre>
- * 
  * <p>
  * This will be added to the where clause when lazy loading the OneToMany
  * property or when there is a join to that OneToMany property.
  * </p>
  */
-@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Where {
 

src/main/java/com/avaje/ebean/annotation/WhoCreated.java

@@ -12,8 +12,7 @@ import java.lang.annotation.Target;
  * To use this annotation you need to implement CurrentUserProvider.
  * The type of the bean property should match the type returned by
  * CurrentUserProvider.
- *</p>
-
+ * </p>
  * <h3>Example:</h3>
  * <pre>{@code
  *
@@ -22,7 +21,7 @@ import java.lang.annotation.Target;
  *
  * }</pre>
  */
-@Target({ ElementType.FIELD, ElementType.METHOD })
+@Target({ElementType.FIELD, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface WhoCreated {
 

src/main/java/com/avaje/ebean/annotation/WhoModified.java

@@ -13,7 +13,6 @@ import java.lang.annotation.Target;
  * The type of the bean property should match the type returned by
  * CurrentUserProvider.
  * </p>
- *
  * <h3>Example:</h3>
  * <pre>{@code
  *

src/main/java/com/avaje/ebean/annotation/package.html

@@ -1,14 +1,14 @@
 <HTML>
 <HEAD>
-	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
-	<TITLE>Extra deployment annotations</TITLE>
+  <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
+  <TITLE>Extra deployment annotations</TITLE>
 </HEAD>
 <Body BGCOLOR="#ffffff">
 Extra deployment annotations
 
 <p>
-Extra deployment annotations for entity beans.
+  Extra deployment annotations for entity beans.
 </p>
 
 </Body>
-</HTML>
+</HTML>