From a5f9beabdffa7cb4f87d954885e999c6647abba9 Mon Sep 17 00:00:00 2001 From: rbygrave Date: Fri, 3 Sep 2021 09:31:16 +1200 Subject: [PATCH] #2349 - Rename Database.getBeanId() to beanId() with deprecation --- ebean-api/src/main/java/io/ebean/DB.java | 2 +- .../src/main/java/io/ebean/Database.java | 20 +++++++++++++++++-- .../server/core/DefaultServer.java | 4 ++-- .../ebeaninternal/api/TDSpiEbeanServer.java | 4 ++-- .../org/tests/basic/TestExplicitInsert.java | 6 +++--- .../TestBatchSaveWithGetBeanId.java | 2 +- .../bothsides/TestInheritanceBothSides.java | 4 ++-- 7 files changed, 29 insertions(+), 13 deletions(-) diff --git a/ebean-api/src/main/java/io/ebean/DB.java b/ebean-api/src/main/java/io/ebean/DB.java index 619a6ecc2..6851a6129 100644 --- a/ebean-api/src/main/java/io/ebean/DB.java +++ b/ebean-api/src/main/java/io/ebean/DB.java @@ -1239,7 +1239,7 @@ public final class DB { * Return the value of the Id property for a given bean. */ public static Object getBeanId(Object bean) { - return getDefault().getBeanId(bean); + return getDefault().beanId(bean); } /** diff --git a/ebean-api/src/main/java/io/ebean/Database.java b/ebean-api/src/main/java/io/ebean/Database.java index be89f86c2..d113cf041 100644 --- a/ebean-api/src/main/java/io/ebean/Database.java +++ b/ebean-api/src/main/java/io/ebean/Database.java @@ -248,7 +248,15 @@ public interface Database { /** * Return the value of the Id property for a given bean. */ - Object getBeanId(Object bean); + Object beanId(Object bean); + + /** + * Deprecated migrate to beanId(). + */ + @Deprecated + default Object getBeanId(Object bean) { + return beanId(bean); + } /** * Set the Id value onto the bean converting the type of the id value if necessary. @@ -260,7 +268,15 @@ public interface Database { * @param bean The entity bean to set the id value on. * @param id The id value to set. */ - Object setBeanId(Object bean, Object id); + Object beanId(Object bean, Object id); + + /** + * Deprecated migrate to beanId(). + */ + @Deprecated + default Object setBeanId(Object bean, Object id) { + return beanId(bean, id); + } /** * Return a map of the differences between two objects of the same type. 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 0cee2236b..f6916bbe4 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 @@ -2079,7 +2079,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer { } @Override - public Object setBeanId(Object bean, Object id) { + public Object beanId(Object bean, Object id) { EntityBean eb = checkEntityBean(bean); BeanDescriptor desc = getBeanDescriptor(bean.getClass()); if (desc == null) { @@ -2089,7 +2089,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer { } @Override - public Object getBeanId(Object bean) { + public Object beanId(Object bean) { EntityBean eb = checkEntityBean(bean); BeanDescriptor desc = getBeanDescriptor(bean.getClass()); if (desc == null) { 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 648744ca8..df747b1d0 100644 --- a/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java +++ b/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java @@ -368,12 +368,12 @@ public class TDSpiEbeanServer implements SpiEbeanServer { } @Override - public Object setBeanId(Object bean, Object id) { + public Object beanId(Object bean, Object id) { return id; } @Override - public Object getBeanId(Object bean) { + public Object beanId(Object bean) { return null; } diff --git a/ebean-core/src/test/java/org/tests/basic/TestExplicitInsert.java b/ebean-core/src/test/java/org/tests/basic/TestExplicitInsert.java index c6f8fb287..3dae9111d 100644 --- a/ebean-core/src/test/java/org/tests/basic/TestExplicitInsert.java +++ b/ebean-core/src/test/java/org/tests/basic/TestExplicitInsert.java @@ -22,7 +22,7 @@ public class TestExplicitInsert extends BaseTestCase { EbeanServer server = Ebean.getDefaultServer(); Customer cust = new Customer(); - Object returnId = server.setBeanId(cust, "42"); + Object returnId = server.beanId(cust, "42"); assertThat(returnId).isEqualTo(42); assertThat(cust.getId()).isEqualTo(42); @@ -34,7 +34,7 @@ public class TestExplicitInsert extends BaseTestCase { EbeanServer server = Ebean.getDefaultServer(); Customer customer = new Customer(); - Object returnId = server.setBeanId(customer, 42); + Object returnId = server.beanId(customer, 42); assertThat(returnId).isEqualTo(42); assertThat(customer.getId()).isEqualTo(42); @@ -57,7 +57,7 @@ public class TestExplicitInsert extends BaseTestCase { Assert.assertNotNull(b.getId()); - Assert.assertEquals(b.getId(), server.getBeanId(b)); + Assert.assertEquals(b.getId(), server.beanId(b)); EBasic b2 = server.find(EBasic.class, b.getId()); diff --git a/ebean-core/src/test/java/org/tests/batchinsert/TestBatchSaveWithGetBeanId.java b/ebean-core/src/test/java/org/tests/batchinsert/TestBatchSaveWithGetBeanId.java index a83aa13ae..c92440fa6 100644 --- a/ebean-core/src/test/java/org/tests/batchinsert/TestBatchSaveWithGetBeanId.java +++ b/ebean-core/src/test/java/org/tests/batchinsert/TestBatchSaveWithGetBeanId.java @@ -31,7 +31,7 @@ public class TestBatchSaveWithGetBeanId extends BaseTestCase { // should invoke a flush which then means the // insert occurs and the bean has an Id value - Object beanId = server.getBeanId(model); + Object beanId = server.beanId(model); assertNotNull(beanId); Ebean.delete(Customer.class, beanId); diff --git a/ebean-core/src/test/java/org/tests/inheritance/bothsides/TestInheritanceBothSides.java b/ebean-core/src/test/java/org/tests/inheritance/bothsides/TestInheritanceBothSides.java index 788e9cf28..df7a28462 100644 --- a/ebean-core/src/test/java/org/tests/inheritance/bothsides/TestInheritanceBothSides.java +++ b/ebean-core/src/test/java/org/tests/inheritance/bothsides/TestInheritanceBothSides.java @@ -57,8 +57,8 @@ public class TestInheritanceBothSides extends BaseTestCase { final Database db = DB.getDefault(); - final SourceBase foundA = DB.find(SourceBase.class, db.getBeanId(sourceA)); - final SourceBase foundB = DB.find(SourceBase.class, db.getBeanId(sourceB)); + final SourceBase foundA = DB.find(SourceBase.class, db.beanId(sourceA)); + final SourceBase foundB = DB.find(SourceBase.class, db.beanId(sourceB)); assertSourceBaseEqual(foundA, sourceA); assertThat(foundA).isInstanceOf(SourceA.class);