diff --git a/src/main/java/io/ebean/DocumentStore.java b/src/main/java/io/ebean/DocumentStore.java index cecacbec9..d96b8d430 100644 --- a/src/main/java/io/ebean/DocumentStore.java +++ b/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. *

- * Typically this is called indirectly by findUnique() on the query. + * Typically this is called indirectly by findOne() on the query. *

*
{@code
    *
@@ -64,7 +64,7 @@ public interface DocumentStore {
    *   server.find(Customer.class)
    *     .setUseDocStore(true)
    *     .setId(42)
-   *     .findUnique();
+   *     .findOne();
    *
    * }
*/ diff --git a/src/main/java/io/ebean/Ebean.java b/src/main/java/io/ebean/Ebean.java index 016250d67..e05caa93d 100644 --- a/src/main/java/io/ebean/Ebean.java +++ b/src/main/java/io/ebean/Ebean.java @@ -822,7 +822,7 @@ public final class Ebean { * } *

* If you want more control over the query then you can use createQuery() and - * Query.findUnique(); + * Query.findOne(); *

*
{@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 details = order.getDetails();
@@ -959,7 +960,7 @@ public final class Ebean {
    * predicates, order by, limits etc.
    * 

*

- * 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. *

*

@@ -991,7 +992,7 @@ public final class Ebean { * Query 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(); * * }

* diff --git a/src/main/java/io/ebean/EbeanServer.java b/src/main/java/io/ebean/EbeanServer.java index 769518ca8..e19a8d13e 100644 --- a/src/main/java/io/ebean/EbeanServer.java +++ b/src/main/java/io/ebean/EbeanServer.java @@ -238,7 +238,7 @@ public interface EbeanServer { * Query 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(); * * } * @@ -265,7 +265,7 @@ public interface EbeanServer { * predicates, order by, limits etc. *

*

- * 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. *

*

@@ -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 orders = @@ -694,7 +694,7 @@ public interface EbeanServer { *

*

* If you want more control over the query then you can use createQuery() and - * Query.findUnique(); + * Query.findOne(); *

*

*

{@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 {
    Optional findOneOrEmpty(Query query, Transaction transaction);
 
   /**
-   * Synonym for findOne().
+   * Deprecated - please migrate to findOne().
    * 

* This proceeded findOne which was introduced to better match spring data. * This will be deprecated at some future point. *

*/ + @Deprecated @Nullable T findUnique(Query query, Transaction transaction); @@ -1166,7 +1167,7 @@ public interface EbeanServer { * result. *

*

- * 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. *

@@ -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(). *

* This proceeded findOne which was introduced to better match spring data. * This will be deprecated at some future point. *

*/ + @Deprecated @Nullable SqlRow findUnique(SqlQuery query, Transaction transaction); diff --git a/src/main/java/io/ebean/ExpressionList.java b/src/main/java/io/ebean/ExpressionList.java index af6ae8bcf..205741cbc 100644 --- a/src/main/java/io/ebean/ExpressionList.java +++ b/src/main/java/io/ebean/ExpressionList.java @@ -264,7 +264,7 @@ public interface ExpressionList { *

* * @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 { Optional findOneOrEmpty(); /** - * Synonym for findOne(). + * Deprecated - please migrate to findOne(). *

* This proceeded findOne which was introduced to better match spring data. * This will be deprecated at some future point. *

*/ + @Deprecated @Nullable T findUnique(); diff --git a/src/main/java/io/ebean/Finder.java b/src/main/java/io/ebean/Finder.java index 5efe0d50e..28ead360e 100644 --- a/src/main/java/io/ebean/Finder.java +++ b/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 findNew() { diff --git a/src/main/java/io/ebean/Query.java b/src/main/java/io/ebean/Query.java index b98da082d..039bc9e47 100644 --- a/src/main/java/io/ebean/Query.java +++ b/src/main/java/io/ebean/Query.java @@ -831,7 +831,7 @@ public interface Query { * Product product = * ebeanServer.find(Product.class) * .where().eq("sku", "aa113") - * .findUnique(); + * .findOne(); * ... * }
*

@@ -845,7 +845,7 @@ public interface Query { * ebeanServer.find(Order.class) * .setId(1) * .fetch("details") - * .findUnique(); + * .findOne(); * * // the order details were eagerly loaded * List details = order.getDetails(); @@ -863,12 +863,13 @@ public interface Query { Optional findOneOrEmpty(); /** - * Synonym for findOne(). + * Deprecated - please migrate to findOne(). *

* This proceeded findOne which was introduced to better match spring data. * This will be deprecated at some future point. *

*/ + @Deprecated @Nullable T findUnique(); @@ -1028,7 +1029,7 @@ public interface Query { Query 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(). *

* You can use this to have further control over the query. For example adding * fetch joins. @@ -1039,7 +1040,7 @@ public interface Query { * ebeanServer.find(Order.class) * .setId(1) * .fetch("details") - * .findUnique(); + * .findOne(); * * // the order details were eagerly fetched * List details = order.getDetails(); diff --git a/src/main/java/io/ebean/SqlQuery.java b/src/main/java/io/ebean/SqlQuery.java index e264268c2..dc2e24efd 100644 --- a/src/main/java/io/ebean/SqlQuery.java +++ b/src/main/java/io/ebean/SqlQuery.java @@ -79,8 +79,9 @@ public interface SqlQuery extends Serializable { Optional findOneOrEmpty(); /** - * Synonym for findOne(). + * Deprecated - please migrate to findOne(). */ + @Deprecated SqlRow findUnique(); /** diff --git a/src/main/java/io/ebean/overview.html b/src/main/java/io/ebean/overview.html index 7f85d3c41..0c0a17139 100644 --- a/src/main/java/io/ebean/overview.html +++ b/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(); diff --git a/src/main/java/io/ebean/package.html b/src/main/java/io/ebean/package.html index 0c825cc56..e3b4f6a25 100644 --- a/src/main/java/io/ebean/package.html +++ b/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(); diff --git a/src/main/java/io/ebeaninternal/server/core/DefaultBeanLoader.java b/src/main/java/io/ebeaninternal/server/core/DefaultBeanLoader.java index a672cc8d1..105e0aa6c 100644 --- a/src/main/java/io/ebeaninternal/server/core/DefaultBeanLoader.java +++ b/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); diff --git a/src/main/java/io/ebeaninternal/server/core/DefaultServer.java b/src/main/java/io/ebeaninternal/server/core/DefaultServer.java index 1e1747ec1..fb4acf006 100644 --- a/src/main/java/io/ebeaninternal/server/core/DefaultServer.java +++ b/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 diff --git a/src/main/java/io/ebeaninternal/server/expression/DefaultExpressionList.java b/src/main/java/io/ebeaninternal/server/expression/DefaultExpressionList.java index cf8f63c45..98b91cc46 100644 --- a/src/main/java/io/ebeaninternal/server/expression/DefaultExpressionList.java +++ b/src/main/java/io/ebeaninternal/server/expression/DefaultExpressionList.java @@ -409,7 +409,7 @@ public class DefaultExpressionList implements SpiExpressionList { @Override public T findUnique() { - return query.findUnique(); + return query.findOne(); } @Override diff --git a/src/main/java/io/ebeaninternal/server/expression/FilterExpressionList.java b/src/main/java/io/ebeaninternal/server/expression/FilterExpressionList.java index 598fbf224..f06a56516 100644 --- a/src/main/java/io/ebeaninternal/server/expression/FilterExpressionList.java +++ b/src/main/java/io/ebeaninternal/server/expression/FilterExpressionList.java @@ -83,7 +83,7 @@ public class FilterExpressionList extends DefaultExpressionList { @Override public T findUnique() { - return rootQuery.findUnique(); + return rootQuery.findOne(); } @Override diff --git a/src/main/java/io/ebeaninternal/server/expression/JunctionExpression.java b/src/main/java/io/ebeaninternal/server/expression/JunctionExpression.java index acd5cf838..bb1c48e90 100644 --- a/src/main/java/io/ebeaninternal/server/expression/JunctionExpression.java +++ b/src/main/java/io/ebeaninternal/server/expression/JunctionExpression.java @@ -406,7 +406,7 @@ class JunctionExpression implements SpiJunction, SpiExpression, Expression @Override public T findUnique() { - return exprList.findUnique(); + return exprList.findOne(); } @Override diff --git a/src/main/java/io/ebeaninternal/server/persist/DefaultPersister.java b/src/main/java/io/ebeaninternal/server/persist/DefaultPersister.java index 31444b024..aa27d8502 100644 --- a/src/main/java/io/ebeaninternal/server/persist/DefaultPersister.java +++ b/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 { diff --git a/src/main/java/io/ebeaninternal/server/persist/DeleteUnloadedForeignKeys.java b/src/main/java/io/ebeaninternal/server/persist/DeleteUnloadedForeignKeys.java index f570c27b6..2c5c70073 100644 --- a/src/main/java/io/ebeaninternal/server/persist/DeleteUnloadedForeignKeys.java +++ b/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); } /** diff --git a/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java b/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java index 5f4c32eeb..68d275c9e 100644 --- a/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java +++ b/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java @@ -1257,7 +1257,7 @@ public class DefaultOrmQuery implements SpiQuery { @Override public T findOne() { - return server.findUnique(this, null); + return server.findOne(this, null); } @Override