From 57c0bceb6348449a669052081506900295acda59 Mon Sep 17 00:00:00 2001 From: rbygrave Date: Fri, 3 Sep 2021 10:47:56 +1200 Subject: [PATCH] #2351 - Rename Database.getReference() to reference() with deprecation --- .../src/main/java/io/ebean/BeanFinder.java | 4 +- ebean-api/src/main/java/io/ebean/DB.java | 2 +- .../src/main/java/io/ebean/Database.java | 10 +++- ebean-api/src/main/java/io/ebean/Ebean.java | 2 +- ebean-api/src/main/java/io/ebean/Finder.java | 4 +- .../server/core/DefaultServer.java | 2 +- .../test/java/io/ebean/UpdateQueryTest.java | 4 +- .../ebeaninternal/api/TDSpiEbeanServer.java | 2 +- .../server/cache/CacheBeanDataTest.java | 2 +- .../server/core/TestDiffHelpSimple.java | 8 ++-- .../deploy/TestDiffHelpInsertSimple.java | 2 +- .../tests/docstore/CustomerReportTest.java | 46 ++++++++----------- .../inheritance/TestInheritanceRefBean.java | 4 +- .../org/tests/readaudit/TestReadAudit.java | 2 +- 14 files changed, 48 insertions(+), 46 deletions(-) diff --git a/ebean-api/src/main/java/io/ebean/BeanFinder.java b/ebean-api/src/main/java/io/ebean/BeanFinder.java index 2c8e04eec..aab61b572 100644 --- a/ebean-api/src/main/java/io/ebean/BeanFinder.java +++ b/ebean-api/src/main/java/io/ebean/BeanFinder.java @@ -79,11 +79,11 @@ public abstract class BeanFinder { /** * Creates an entity reference for this ID. *

- * Equivalent to {@link Database#getReference(Class, Object)} + * Equivalent to {@link Database#reference(Class, Object)} */ @Nonnull public T ref(I id) { - return db().getReference(type, id); + return db().reference(type, id); } /** diff --git a/ebean-api/src/main/java/io/ebean/DB.java b/ebean-api/src/main/java/io/ebean/DB.java index ab719b7da..636889b4e 100644 --- a/ebean-api/src/main/java/io/ebean/DB.java +++ b/ebean-api/src/main/java/io/ebean/DB.java @@ -659,7 +659,7 @@ public final class DB { * @param id the id value */ public static T getReference(Class beanType, Object id) { - return getDefault().getReference(beanType, id); + return getDefault().reference(beanType, id); } /** diff --git a/ebean-api/src/main/java/io/ebean/Database.java b/ebean-api/src/main/java/io/ebean/Database.java index 7bc21364a..594644c62 100644 --- a/ebean-api/src/main/java/io/ebean/Database.java +++ b/ebean-api/src/main/java/io/ebean/Database.java @@ -950,7 +950,15 @@ public interface Database { * @param id the id value */ @Nonnull - T getReference(Class beanType, Object id); + T reference(Class beanType, Object id); + + /** + * Deprecated migrate to reference(). + */ + @Deprecated + default T getReference(Class beanType, Object id) { + return reference(beanType, id); + } /** * Return the extended API for Database. diff --git a/ebean-api/src/main/java/io/ebean/Ebean.java b/ebean-api/src/main/java/io/ebean/Ebean.java index 53d76811f..eabc3c5b4 100644 --- a/ebean-api/src/main/java/io/ebean/Ebean.java +++ b/ebean-api/src/main/java/io/ebean/Ebean.java @@ -642,7 +642,7 @@ public final class Ebean { * @param id the id value */ public static T getReference(Class beanType, Object id) { - return getDefault().getReference(beanType, id); + return getDefault().reference(beanType, id); } /** diff --git a/ebean-api/src/main/java/io/ebean/Finder.java b/ebean-api/src/main/java/io/ebean/Finder.java index 3c9318e7d..cc5ef87f6 100644 --- a/ebean-api/src/main/java/io/ebean/Finder.java +++ b/ebean-api/src/main/java/io/ebean/Finder.java @@ -137,11 +137,11 @@ public class Finder { /** * Creates an entity reference for this ID. *

- * Equivalent to {@link Database#getReference(Class, Object)} + * Equivalent to {@link Database#reference(Class, Object)} */ @Nonnull public T ref(I id) { - return db().getReference(type, id); + return db().reference(type, id); } /** diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java b/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java index cd25b08c5..469cc148f 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java @@ -687,7 +687,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer { */ @Override @SuppressWarnings({"unchecked", "rawtypes"}) - public T getReference(Class type, Object id) { + public T reference(Class type, Object id) { if (id == null) { throw new NullPointerException("The id is null"); } diff --git a/ebean-core/src/test/java/io/ebean/UpdateQueryTest.java b/ebean-core/src/test/java/io/ebean/UpdateQueryTest.java index 5b9c42991..bcbdd103b 100644 --- a/ebean-core/src/test/java/io/ebean/UpdateQueryTest.java +++ b/ebean-core/src/test/java/io/ebean/UpdateQueryTest.java @@ -174,7 +174,7 @@ public class UpdateQueryTest extends BaseTestCase { EbeanServer server = server(); - Country nz = server.getReference(Country.class, "NZ"); + Country nz = server.reference(Country.class, "NZ"); UpdateQuery update = server.update(Customer.class); Query query = update @@ -198,7 +198,7 @@ public class UpdateQueryTest extends BaseTestCase { EbeanServer server = server(); - Country nz = server.getReference(Country.class, "NZ"); + Country nz = server.reference(Country.class, "NZ"); LoggedSqlCollector.start(); diff --git a/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java b/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java index 6c5d929cd..7dc5a0b63 100644 --- a/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java +++ b/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java @@ -660,7 +660,7 @@ public class TDSpiEbeanServer implements SpiEbeanServer { } @Override - public T getReference(Class beanType, Object id) { + public T reference(Class beanType, Object id) { return null; } diff --git a/ebean-core/src/test/java/io/ebeaninternal/server/cache/CacheBeanDataTest.java b/ebean-core/src/test/java/io/ebeaninternal/server/cache/CacheBeanDataTest.java index 957515f80..d7ab3ea5e 100644 --- a/ebean-core/src/test/java/io/ebeaninternal/server/cache/CacheBeanDataTest.java +++ b/ebean-core/src/test/java/io/ebeaninternal/server/cache/CacheBeanDataTest.java @@ -39,7 +39,7 @@ public class CacheBeanDataTest extends BaseTestCase { Address billingAddress = new Address(); billingAddress.setId(12); billingAddress.setCity("Auckland"); - billingAddress.setCountry(server.getReference(Country.class, "NZ")); + billingAddress.setCountry(server.reference(Country.class, "NZ")); billingAddress.setLine1("92 Someplace Else"); c.setBillingAddress(billingAddress); diff --git a/ebean-core/src/test/java/io/ebeaninternal/server/core/TestDiffHelpSimple.java b/ebean-core/src/test/java/io/ebeaninternal/server/core/TestDiffHelpSimple.java index 5ab4b56ee..7d14d858c 100644 --- a/ebean-core/src/test/java/io/ebeaninternal/server/core/TestDiffHelpSimple.java +++ b/ebean-core/src/test/java/io/ebeaninternal/server/core/TestDiffHelpSimple.java @@ -35,7 +35,7 @@ public class TestDiffHelpSimple extends BaseTestCase { Order order1 = new Order(); order1.setId(12); order1.setCretime(new Timestamp(firstTime)); - order1.setCustomer(server.getReference(Customer.class, 1234)); + order1.setCustomer(server.reference(Customer.class, 1234)); order1.setStatus(Status.NEW); order1.setShipDate(new Date(firstTime)); order1.setOrderDate(new Date(firstTime)); @@ -51,7 +51,7 @@ public class TestDiffHelpSimple extends BaseTestCase { Order order2 = new Order(); order2.setId(14); order2.setCretime(new Timestamp(secondTime)); - order2.setCustomer(server.getReference(Customer.class, 2133)); + order2.setCustomer(server.reference(Customer.class, 2133)); order2.setStatus(Status.COMPLETE); order2.setShipDate(new Date(secondTime)); order2.setOrderDate(new Date(secondTime)); @@ -77,7 +77,7 @@ public class TestDiffHelpSimple extends BaseTestCase { Order order2 = new Order(); order2.setId(14); order2.setCretime(new Timestamp(secondTime)); - order2.setCustomer(server.getReference(Customer.class, 2133)); + order2.setCustomer(server.reference(Customer.class, 2133)); order2.setStatus(Status.COMPLETE); order2.setShipDate(new Date(secondTime)); order2.setOrderDate(new Date(secondTime)); @@ -114,7 +114,7 @@ public class TestDiffHelpSimple extends BaseTestCase { Order order1 = createBaseOrder(server); Order order2 = createBaseOrder(server); - order2.setCustomer(server.getReference(Customer.class, 2133)); + order2.setCustomer(server.reference(Customer.class, 2133)); order2.setStatus(Status.COMPLETE); order2.setShipDate(null); diff --git a/ebean-core/src/test/java/io/ebeaninternal/server/deploy/TestDiffHelpInsertSimple.java b/ebean-core/src/test/java/io/ebeaninternal/server/deploy/TestDiffHelpInsertSimple.java index 4e7704a02..58cdd45ee 100644 --- a/ebean-core/src/test/java/io/ebeaninternal/server/deploy/TestDiffHelpInsertSimple.java +++ b/ebean-core/src/test/java/io/ebeaninternal/server/deploy/TestDiffHelpInsertSimple.java @@ -37,7 +37,7 @@ public class TestDiffHelpInsertSimple extends BaseTestCase { Order order1 = new Order(); order1.setId(12); order1.setCretime(new Timestamp(firstTime)); - order1.setCustomer(server.getReference(Customer.class, 1234)); + order1.setCustomer(server.reference(Customer.class, 1234)); order1.setStatus(Status.NEW); //order1.setShipDate(new Date(firstTime)); order1.setOrderDate(new Date(firstTime)); diff --git a/ebean-core/src/test/java/org/tests/docstore/CustomerReportTest.java b/ebean-core/src/test/java/org/tests/docstore/CustomerReportTest.java index 3668d833f..e7047cc37 100644 --- a/ebean-core/src/test/java/org/tests/docstore/CustomerReportTest.java +++ b/ebean-core/src/test/java/org/tests/docstore/CustomerReportTest.java @@ -16,53 +16,47 @@ import io.ebean.BaseTestCase; import io.ebean.text.json.JsonReadOptions; public class CustomerReportTest extends BaseTestCase { - - - + @Test public void testToJson() throws Exception { ResetBasicData.reset(); - - + + String json = server().json().toJson(getCustomerReport()); - - assertThat(json).isEqualTo("{\"dtype\":\"CR\",\"friends\":[{\"id\":2},{\"id\":3}],\"customer\":{\"id\":1}}"); } - - @Test public void testFromJson() throws Exception { ResetBasicData.reset(); String json = "{\"dtype\":\"CR\",\"friends\":[{\"id\":2},{\"id\":3}],\"customer\":{\"id\":1}}"; - + JsonReadOptions opts = new JsonReadOptions(); opts.setEnableLazyLoading(true); CustomerReport report = server().json().toBean(CustomerReport.class, json, opts); - + assertThat(report.getCustomer().getName()).isEqualTo("Rob"); - + assertThat(report.getFriends().get(0).getName()).isEqualTo("Cust NoAddress"); assertThat(report.getFriends().get(1).getName()).isEqualTo("Fiona"); } - + @Test public void testEmbeddedDocs() throws Exception { ResetBasicData.reset(); - + CustomerReport report = getCustomerReport(); report.getEmbeddedReports().add(getProductReport()); - + String json = server().json().toJson(report); - + assertThat(json).isEqualTo("{\"dtype\":\"CR\"," + "\"embeddedReports\":[{\"dtype\":\"PR\",\"title\":\"This is a good product\",\"product\":{\"id\":1}}]," + "\"friends\":[{\"id\":2},{\"id\":3}]," + "\"customer\":{\"id\":1}}"); - + JsonReadOptions opts = new JsonReadOptions(); opts.setEnableLazyLoading(true); report = server().json().toBean(CustomerReport.class, json, opts); @@ -70,22 +64,22 @@ public class CustomerReportTest extends BaseTestCase { assertThat(ar.getTitle()).isEqualTo("This is a good product"); assertThat(ar.getProduct().getName()).isEqualTo("Chair"); } - - + + private CustomerReport getCustomerReport() { - Customer customer = server().getReference(Customer.class, 1); - Customer friend1 = server().getReference(Customer.class, 2); - Customer friend2 = server().getReference(Customer.class, 3); - + Customer customer = server().reference(Customer.class, 1); + Customer friend1 = server().reference(Customer.class, 2); + Customer friend2 = server().reference(Customer.class, 3); + CustomerReport report = new CustomerReport(); - + report.setCustomer(customer); report.setFriends(Arrays.asList(friend1, friend2)); return report; } - + private ProductReport getProductReport() { - Product product = server().getReference(Product.class, 1); + Product product = server().reference(Product.class, 1); ProductReport report = new ProductReport(); report.setTitle("This is a good product"); diff --git a/ebean-core/src/test/java/org/tests/inheritance/TestInheritanceRefBean.java b/ebean-core/src/test/java/org/tests/inheritance/TestInheritanceRefBean.java index 520e84866..f38000825 100644 --- a/ebean-core/src/test/java/org/tests/inheritance/TestInheritanceRefBean.java +++ b/ebean-core/src/test/java/org/tests/inheritance/TestInheritanceRefBean.java @@ -26,12 +26,12 @@ public class TestInheritanceRefBean extends BaseTestCase { Parent test; LoggedSqlCollector.start(); - test = server().getReference(ChildA.class, idA); + test = server().reference(ChildA.class, idA); assertTrue(test instanceof ChildA); assertEquals(0, LoggedSqlCollector.stop().size()); LoggedSqlCollector.start(); - test = server().getReference(Parent.class, idB); + test = server().reference(Parent.class, idB); assertTrue(test instanceof ChildB); assertEquals(1, LoggedSqlCollector.stop().size()); diff --git a/ebean-core/src/test/java/org/tests/readaudit/TestReadAudit.java b/ebean-core/src/test/java/org/tests/readaudit/TestReadAudit.java index f2e74e4f5..2f202d83c 100644 --- a/ebean-core/src/test/java/org/tests/readaudit/TestReadAudit.java +++ b/ebean-core/src/test/java/org/tests/readaudit/TestReadAudit.java @@ -134,7 +134,7 @@ public class TestReadAudit extends BaseTestCase { assertThat(readAuditLogger.beans).hasSize(2); - Country ref = server.getReference(Country.class, "AR"); + Country ref = server.reference(Country.class, "AR"); assertThat(readAuditLogger.beans).hasSize(3); assertThat(ref).isSameAs(found2); }