#2351 - Rename Database.getReference() to reference() with deprecation

ebean-api/src/main/java/io/ebean/BeanFinder.java

@@ -79,11 +79,11 @@ public abstract class BeanFinder<I,T> {
   /**
    * Creates an entity reference for this ID.
    * <p>
-   * 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);
   }
 
   /**

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> T getReference(Class<T> beanType, Object id) {
-    return getDefault().getReference(beanType, id);
+    return getDefault().reference(beanType, id);
   }
 
   /**

ebean-api/src/main/java/io/ebean/Database.java

@@ -950,7 +950,15 @@ public interface Database {
    * @param id       the id value
    */
   @Nonnull
-  <T> T getReference(Class<T> beanType, Object id);
+  <T> T reference(Class<T> beanType, Object id);
+
+  /**
+   * Deprecated migrate to reference().
+   */
+  @Deprecated
+  default <T> T getReference(Class<T> beanType, Object id) {
+    return reference(beanType, id);
+  }
 
   /**
    * Return the extended API for Database.

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> T getReference(Class<T> beanType, Object id) {
-    return getDefault().getReference(beanType, id);
+    return getDefault().reference(beanType, id);
   }
 
   /**

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

@@ -137,11 +137,11 @@ public class Finder<I, T> {
   /**
    * Creates an entity reference for this ID.
    * <p>
-   * 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);
   }
 
   /**

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> T getReference(Class<T> type, Object id) {
+  public <T> T reference(Class<T> type, Object id) {
     if (id == null) {
       throw new NullPointerException("The id is null");
     }

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<Customer> update = server.update(Customer.class);
     Query<Customer> 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();
 

ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java

@@ -660,7 +660,7 @@ public class TDSpiEbeanServer implements SpiEbeanServer {
   }
 
   @Override
-  public <T> T getReference(Class<T> beanType, Object id) {
+  public <T> T reference(Class<T> beanType, Object id) {
     return null;
   }
 

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);
 

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);
 

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));

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 customer = server().reference(Customer.class, 1);
-    Customer friend1 = server().getReference(Customer.class, 2);
+    Customer friend1 = server().reference(Customer.class, 2);
-    Customer friend2 = server().getReference(Customer.class, 3);
+    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");

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());
 

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);
   }