#1114 - Deprecate findUnique() - please migrate to findOne()

src/main/java/io/ebean/DocumentStore.java

@@ -56,7 +56,7 @@ public interface DocumentStore {
    * Return the bean by fetching it's content from the document store.
    * If the document is not found null is returned.
    * <p>
-   * Typically this is called indirectly by findUnique() on the query.
+   * Typically this is called indirectly by findOne() on the query.
    * </p>
    * <pre>{@code
    *
@@ -64,7 +64,7 @@ public interface DocumentStore {
    *   server.find(Customer.class)
    *     .setUseDocStore(true)
    *     .setId(42)
-   *     .findUnique();
+   *     .findOne();
    *
    * }</pre>
    */

src/main/java/io/ebean/Ebean.java

@@ -822,7 +822,7 @@ public final class Ebean {
    * }</pre>
    * <p>
    * If you want more control over the query then you can use createQuery() and
-   * Query.findUnique();
+   * Query.findOne();
    * </p>
    * <pre>{@code
    *
@@ -843,7 +843,8 @@ public final class Ebean {
    *
    *   // traverse the object graph...
    *
-   *   Order order = query.findUnique();
+   *   Order order = query.findOne();
+   *
    *   Customer customer = order.getCustomer();
    *   Address shippingAddress = customer.getShippingAddress();
    *   List<OrderDetail> details = order.getDetails();
@@ -959,7 +960,7 @@ public final class Ebean {
    * predicates, order by, limits etc.
    * </p>
    * <p>
-   * You then use findList(), findSet(), findMap() and findUnique() to execute
+   * You then use findList(), findSet(), findMap() and findOne() to execute
    * the query and return the collection or bean.
    * </p>
    * <p>
@@ -991,7 +992,7 @@ public final class Ebean {
    *   Query<Order> query = Ebean.createQuery(Order.class, eql);
    *   query.setParameter("orderId", 2);
    *
-   *   Order order = query.findUnique();
+   *   Order order = query.findOne();
    *
    *   // This is the same as:
    *
@@ -1000,7 +1001,7 @@ public final class Ebean {
    *     .fetch("details")
    *     .fetch("detail.product", "name")
    *     .setId(2)
-   *     .findUnique();
+   *     .findOne();
    *
    * }</pre>
    *

src/main/java/io/ebean/EbeanServer.java

@@ -238,7 +238,7 @@ public interface EbeanServer {
    *   Query<Order> query = Ebean.createQuery(Order.class, ormQuery);
    *   query.setParameter("orderId", 2);
    *
-   *   Order order = query.findUnique();
+   *   Order order = query.findOne();
    *
    *   // This is the same as:
    *
@@ -247,7 +247,7 @@ public interface EbeanServer {
    *     .fetch("details")
    *     .fetch("detail.product", "name")
    *     .setId(2)
-   *     .findUnique();
+   *     .findOne();
    *
    * }</pre>
    *
@@ -265,7 +265,7 @@ public interface EbeanServer {
    * predicates, order by, limits etc.
    * </p>
    * <p>
-   * You then use findList(), findSet(), findMap() and findUnique() to execute
+   * You then use findList(), findSet(), findMap() and findOne() to execute
    * the query and return the collection or bean.
    * </p>
    * <p>
@@ -285,7 +285,7 @@ public interface EbeanServer {
    *     .fetch("details")
    *     .fetch("detail.product", "name")
    *     .setId(2)
-   *     .findUnique();
+   *     .findOne();
    *
    *   // find some new orders ... with firstRow/maxRows
    *   List<Order> orders =
@@ -694,7 +694,7 @@ public interface EbeanServer {
    * <p>
    * <p>
    * If you want more control over the query then you can use createQuery() and
-   * Query.findUnique();
+   * Query.findOne();
    * </p>
    * <p>
    * <pre>{@code
@@ -714,7 +714,7 @@ public interface EbeanServer {
    *   query.fetch("details.product", "name");
    *
    *
-   *   Order order = query.findUnique();
+   *   Order order = query.findOne();
    *
    *   // traverse the object graph...
    *
@@ -1088,12 +1088,13 @@ public interface EbeanServer {
   <T> Optional<T> findOneOrEmpty(Query<T> query, Transaction transaction);
 
   /**
-   * Synonym for findOne().
+   * Deprecated - please migrate to findOne().
    * <p>
    * This proceeded findOne which was introduced to better match spring data.
    * This will be deprecated at some future point.
    * </p>
    */
+  @Deprecated
   @Nullable
   <T> T findUnique(Query<T> query, Transaction transaction);
 
@@ -1166,7 +1167,7 @@ public interface EbeanServer {
    * result.
    * </p>
    * <p>
-   * Generally you are able to use {@link SqlQuery#findUnique()} rather than
+   * Generally you are able to use {@link SqlQuery#findOne()} rather than
    * explicitly calling this method. You could use this method if you wish to
    * explicitly control the transaction used for the query.
    * </p>
@@ -1174,18 +1175,19 @@ public interface EbeanServer {
    * @param query       the query to execute.
    * @param transaction the transaction to use (can be null).
    * @return the fetched MapBean or null if none was found.
-   * @see SqlQuery#findUnique()
+   * @see SqlQuery#findOne()
    */
   @Nullable
   SqlRow findOne(SqlQuery query, Transaction transaction);
 
   /**
-   * Synonym for findOne().
+   * Deprecated - please migrate to findOne().
    * <p>
    * This proceeded findOne which was introduced to better match spring data.
    * This will be deprecated at some future point.
    * </p>
    */
+  @Deprecated
   @Nullable
   SqlRow findUnique(SqlQuery query, Transaction transaction);
 

src/main/java/io/ebean/ExpressionList.java

@@ -264,7 +264,7 @@ public interface ExpressionList<T> {
    * </p>
    *
    * @throws NonUniqueResultException if more than one result was found
-   * @see Query#findUnique()
+   * @see Query#findOne()
    */
   @Nullable
   T findOne();
@@ -275,12 +275,13 @@ public interface ExpressionList<T> {
   Optional<T> findOneOrEmpty();
 
   /**
-   * Synonym for findOne().
+   * Deprecated - please migrate to findOne().
    * <p>
    * This proceeded findOne which was introduced to better match spring data.
    * This will be deprecated at some future point.
    * </p>
    */
+  @Deprecated
   @Nullable
   T findUnique();
 

src/main/java/io/ebean/Finder.java

@@ -27,7 +27,7 @@ import java.util.List;
  *   // Add your customer finder methods ...
  *
  *   public Customer byName(String name) {
- *     return query().eq("name", name).findUnique();
+ *     return query().eq("name", name).findOne();
  *   }
  *
  *   public List<Customer> findNew() {

src/main/java/io/ebean/Query.java

@@ -831,7 +831,7 @@ public interface Query<T> {
    * Product product =
    *     ebeanServer.find(Product.class)
    *         .where().eq("sku", "aa113")
-   *         .findUnique();
+   *         .findOne();
    * ...
    * }</pre>
    * <p>
@@ -845,7 +845,7 @@ public interface Query<T> {
    *     ebeanServer.find(Order.class)
    *       .setId(1)
    *       .fetch("details")
-   *       .findUnique();
+   *       .findOne();
    *
    * // the order details were eagerly loaded
    * List<OrderDetail> details = order.getDetails();
@@ -863,12 +863,13 @@ public interface Query<T> {
   Optional<T> findOneOrEmpty();
 
   /**
-   * Synonym for findOne().
+   * Deprecated - please migrate to findOne().
    * <p>
    * This proceeded findOne which was introduced to better match spring data.
    * This will be deprecated at some future point.
    * </p>
    */
+  @Deprecated
   @Nullable
   T findUnique();
 
@@ -1028,7 +1029,7 @@ public interface Query<T> {
   Query<T> setParameter(int position, Object value);
 
   /**
-   * Set the Id value to query. This is used with findUnique().
+   * Set the Id value to query. This is used with findOne().
    * <p>
    * You can use this to have further control over the query. For example adding
    * fetch joins.
@@ -1039,7 +1040,7 @@ public interface Query<T> {
    *     ebeanServer.find(Order.class)
    *     .setId(1)
    *     .fetch("details")
-   *     .findUnique();
+   *     .findOne();
    *
    * // the order details were eagerly fetched
    * List<OrderDetail> details = order.getDetails();

src/main/java/io/ebean/SqlQuery.java

@@ -79,8 +79,9 @@ public interface SqlQuery extends Serializable {
   Optional<SqlRow> findOneOrEmpty();
 
   /**
-   * Synonym for findOne().
+   * Deprecated - please migrate to findOne().
    */
+  @Deprecated
   SqlRow findUnique();
 
   /**

src/main/java/io/ebean/overview.html

@@ -35,7 +35,7 @@ Customer customer = Ebean.find(Customer.class)
     .fetch("billingAddress");
     .fetch("shippingAddress");
     .setId(7)
-    .findUnique();
+    .findOne();
 
 
 Address billAddr = customer.getBillingAddress();

src/main/java/io/ebean/package.html

@@ -28,7 +28,7 @@ Customer customer =
 		.setId(7)
 		.fetch("billingAddress")
 		.fetch("shippingAddress")
-		.findUnique();
+		.findOne();
 
 Address billAddr = customer.getBillingAddress();
 Address shipAddr = customer.getShippingAddress();

src/main/java/io/ebeaninternal/server/core/DefaultBeanLoader.java

@@ -173,7 +173,7 @@ public class DefaultBeanLoader {
       query.setReadOnly(true);
     }
 
-    server.findUnique(query, t);
+    server.findOne(query, t);
 
     if (beanCollection != null) {
       if (beanCollection.checkEmptyLazyLoad()) {
@@ -316,7 +316,7 @@ public class DefaultBeanLoader {
       query.select("*");
     }
 
-    Object dbBean = query.findUnique();
+    Object dbBean = query.findOne();
     if (dbBean == null) {
       String msg = "Bean not found during lazy load or refresh." + " id[" + id + "] type[" + desc.getBeanType() + "]";
       throw new EntityNotFoundException(msg);

src/main/java/io/ebeaninternal/server/core/DefaultServer.java

@@ -624,7 +624,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
 
     // we actually need to do a query because we don't know the type without the discriminator
     // value, just select the id property and discriminator column (auto added)
-    return find(type).select(idProp.getName()).setId(id).findUnique();
+    return find(type).select(idProp.getName()).setId(id).findOne();
   }
 
   @Override

src/main/java/io/ebeaninternal/server/expression/DefaultExpressionList.java

@@ -409,7 +409,7 @@ public class DefaultExpressionList<T> implements SpiExpressionList<T> {
 
   @Override
   public T findUnique() {
-    return query.findUnique();
+    return query.findOne();
   }
 
   @Override

src/main/java/io/ebeaninternal/server/expression/FilterExpressionList.java

@@ -83,7 +83,7 @@ public class FilterExpressionList<T> extends DefaultExpressionList<T> {
 
   @Override
   public T findUnique() {
-    return rootQuery.findUnique();
+    return rootQuery.findOne();
   }
 
   @Override

src/main/java/io/ebeaninternal/server/expression/JunctionExpression.java

@@ -406,7 +406,7 @@ class JunctionExpression<T> implements SpiJunction<T>, SpiExpression, Expression
 
   @Override
   public T findUnique() {
-    return exprList.findUnique();
+    return exprList.findOne();
   }
 
   @Override

src/main/java/io/ebeaninternal/server/persist/DefaultPersister.java

@@ -630,7 +630,7 @@ public final class DefaultPersister implements Persister {
           if (t.isLogSummary()) {
             t.logSummary("-- DeleteById of " + descriptor.getName() + " id[" + id + "] requires fetch of foreign key values");
           }
-          EntityBean bean = (EntityBean) server.findUnique(q, t);
+          EntityBean bean = (EntityBean) server.findOne(q, t);
           if (bean == null) {
             return 0;
           } else {

src/main/java/io/ebeaninternal/server/persist/DeleteUnloadedForeignKeys.java

@@ -75,7 +75,7 @@ class DeleteUnloadedForeignKeys {
     if (t.isLogSummary()) {
       t.logSummary("-- Ebean fetching foreign key values for delete of " + descriptor.getName() + " id:" + id);
     }
-    beanWithForeignKeys = (EntityBean) server.findUnique(q, t);
+    beanWithForeignKeys = (EntityBean) server.findOne(q, t);
   }
 
   /**

src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java

@@ -1257,7 +1257,7 @@ public class DefaultOrmQuery<T> implements SpiQuery<T> {
 
   @Override
   public T findOne() {
-    return server.findUnique(this, null);
+    return server.findOne(this, null);
   }
 
   @Override