From f770b66f429bd07aa1b52334f6258d699ed26f07 Mon Sep 17 00:00:00 2001 From: Rob Bygrave Date: Thu, 2 Sep 2021 22:41:51 +1200 Subject: [PATCH] #2342 - Rename Database.getName() to Database.name() with deprecation --- ebean-api/src/main/java/io/ebean/Database.java | 10 +++++++++- ebean-api/src/main/java/io/ebean/DbContext.java | 2 +- .../src/main/java/io/ebean/bean/SingleBeanLoader.java | 2 +- .../autotune/service/DefaultAutoTuneService.java | 2 +- .../ebeaninternal/server/cluster/ClusterManager.java | 2 +- .../server/core/DefaultQueryPlanListener.java | 2 +- .../io/ebeaninternal/server/core/DefaultServer.java | 2 +- .../java/io/ebeaninternal/server/core/DumpMetrics.java | 2 +- .../io/ebeaninternal/server/core/DumpMetricsJson.java | 2 +- .../server/loadcontext/DLoadBaseContext.java | 2 +- .../server/loadcontext/DLoadManyContext.java | 2 +- .../java/io/ebeaninternal/api/TDSpiEbeanServer.java | 2 +- .../java/org/tests/query/TestQueryFindIterate.java | 2 +- .../org/tests/query/finder/TestCustomerFinder.java | 2 +- .../io/ebeaninternal/dbmigration/DdlGenerator.java | 4 ++-- 15 files changed, 24 insertions(+), 16 deletions(-) diff --git a/ebean-api/src/main/java/io/ebean/Database.java b/ebean-api/src/main/java/io/ebean/Database.java index bd38253de..da4645811 100644 --- a/ebean-api/src/main/java/io/ebean/Database.java +++ b/ebean-api/src/main/java/io/ebean/Database.java @@ -136,7 +136,15 @@ public interface Database { * Return the name. This is used with {@link DB#byName(String)} to get a * Database that was registered with the DB singleton. */ - String getName(); + String name(); + + /** + * Deprecated migrate to name(). + */ + @Deprecated + default String getName() { + return name(); + } /** * Return the ExpressionFactory for this database. diff --git a/ebean-api/src/main/java/io/ebean/DbContext.java b/ebean-api/src/main/java/io/ebean/DbContext.java index 18df2169e..786cfd4bb 100644 --- a/ebean-api/src/main/java/io/ebean/DbContext.java +++ b/ebean-api/src/main/java/io/ebean/DbContext.java @@ -115,7 +115,7 @@ final class DbContext { * Register a server so we can get it by its name. */ void register(Database server, boolean isDefault) { - registerWithName(server.getName(), server, isDefault); + registerWithName(server.name(), server, isDefault); } private void registerWithName(String name, Database server, boolean isDefault) { diff --git a/ebean-api/src/main/java/io/ebean/bean/SingleBeanLoader.java b/ebean-api/src/main/java/io/ebean/bean/SingleBeanLoader.java index ad4a30b95..e196d3c5a 100644 --- a/ebean-api/src/main/java/io/ebean/bean/SingleBeanLoader.java +++ b/ebean-api/src/main/java/io/ebean/bean/SingleBeanLoader.java @@ -20,7 +20,7 @@ public abstract class SingleBeanLoader implements BeanLoader { @Override public String getName() { - return database.getName(); + return database.name(); } @Override diff --git a/ebean-autotune/src/main/java/io/ebeaninternal/server/autotune/service/DefaultAutoTuneService.java b/ebean-autotune/src/main/java/io/ebeaninternal/server/autotune/service/DefaultAutoTuneService.java index be2033695..8ea80d3a6 100644 --- a/ebean-autotune/src/main/java/io/ebeaninternal/server/autotune/service/DefaultAutoTuneService.java +++ b/ebean-autotune/src/main/java/io/ebeaninternal/server/autotune/service/DefaultAutoTuneService.java @@ -59,7 +59,7 @@ public class DefaultAutoTuneService implements AutoTuneService { this.tuningFile = config.getQueryTuningFile(); this.profilingFile = config.getProfilingFile(); this.profilingUpdateFrequency = config.getProfilingUpdateFrequency(); - this.serverName = server.getName(); + this.serverName = server.name(); this.profileManager = new ProfileManager(config, server); this.queryTuner = new BaseQueryTuner(config, server, profileManager); this.skipGarbageCollectionOnShutdown = config.isSkipGarbageCollectionOnShutdown(); diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/cluster/ClusterManager.java b/ebean-core/src/main/java/io/ebeaninternal/server/cluster/ClusterManager.java index d2bdaeda7..a85444486 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/cluster/ClusterManager.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/cluster/ClusterManager.java @@ -56,7 +56,7 @@ public class ClusterManager implements ServerLookup { public void registerServer(EbeanServer server) { lock.lock(); try { - serverMap.put(server.getName(), server); + serverMap.put(server.name(), server); if (!started) { startup(); } diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultQueryPlanListener.java b/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultQueryPlanListener.java index ba2e99bda..5a6196230 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultQueryPlanListener.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultQueryPlanListener.java @@ -15,7 +15,7 @@ final class DefaultQueryPlanListener implements QueryPlanListener { @Override public void process(QueryPlanCapture capture) { // better to log this in JSON form? - String dbName = capture.getDatabase().getName(); + String dbName = capture.getDatabase().name(); for (MetaQueryPlan plan : capture.getPlans()) { log.info("queryPlan db:{} label:{} queryTimeMicros:{} loc:{} sql:{} bind:{} plan:{}", dbName, plan.label(), plan.queryTimeMicros(), plan.profileLocation(), 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 1c77e06a8..c30134f31 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 @@ -499,7 +499,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer { * Return the server name. */ @Override - public String getName() { + public String name() { return serverName; } diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/core/DumpMetrics.java b/ebean-core/src/main/java/io/ebeaninternal/server/core/DumpMetrics.java index 9b5a1afa7..b1f66f7ef 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/core/DumpMetrics.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/core/DumpMetrics.java @@ -73,7 +73,7 @@ final class DumpMetrics { void dump() { - out("-- Dumping metrics for " + server.getName() + " -- "); + out("-- Dumping metrics for " + server.name() + " -- "); ServerMetrics serverMetrics = server.getMetaInfoManager().collectMetrics(); for (MetaTimedMetric metric : serverMetrics.timedMetrics()) { diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/core/DumpMetricsJson.java b/ebean-core/src/main/java/io/ebeaninternal/server/core/DumpMetricsJson.java index 190af0af4..3358a709a 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/core/DumpMetricsJson.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/core/DumpMetricsJson.java @@ -112,7 +112,7 @@ final class DumpMetricsJson implements ServerMetricsAsJson { if (withHeader) { objStart(); key("db"); - val(database.getName()); + val(database.name()); key("metrics"); listStart(); } diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/loadcontext/DLoadBaseContext.java b/ebean-core/src/main/java/io/ebeaninternal/server/loadcontext/DLoadBaseContext.java index 24233cf87..4ab63bec0 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/loadcontext/DLoadBaseContext.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/loadcontext/DLoadBaseContext.java @@ -35,7 +35,7 @@ abstract class DLoadBaseContext { DLoadBaseContext(DLoadContext parent, BeanDescriptor desc, String path, OrmQueryProperties queryProps) { this.parent = parent; - this.serverName = parent.getEbeanServer().getName(); + this.serverName = parent.getEbeanServer().name(); this.desc = desc; this.queryProps = queryProps; this.fullPath = parent.getFullPath(path); diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/loadcontext/DLoadManyContext.java b/ebean-core/src/main/java/io/ebeaninternal/server/loadcontext/DLoadManyContext.java index b830dc96d..5f09de0b3 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/loadcontext/DLoadManyContext.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/loadcontext/DLoadManyContext.java @@ -74,7 +74,7 @@ final class DLoadManyContext extends DLoadBaseContext implements LoadManyContext public String getName() { - return parent.getEbeanServer().getName(); + return parent.getEbeanServer().name(); } public void register(BeanCollection bc) { 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 cb7e613a3..a4ec77ffd 100644 --- a/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java +++ b/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java @@ -348,7 +348,7 @@ public class TDSpiEbeanServer implements SpiEbeanServer { } @Override - public String getName() { + public String name() { return name; } diff --git a/ebean-core/src/test/java/org/tests/query/TestQueryFindIterate.java b/ebean-core/src/test/java/org/tests/query/TestQueryFindIterate.java index 4dea23698..c2d31a851 100644 --- a/ebean-core/src/test/java/org/tests/query/TestQueryFindIterate.java +++ b/ebean-core/src/test/java/org/tests/query/TestQueryFindIterate.java @@ -194,7 +194,7 @@ public class TestQueryFindIterate extends BaseTestCase { }); - if (!DB.getDefault().getName().equals("h2")) { + if (!DB.getDefault().name().equals("h2")) { // MySql allows the query with type conversion? throw new PersistenceException("H2 does expected thing but MySql does not"); } diff --git a/ebean-core/src/test/java/org/tests/query/finder/TestCustomerFinder.java b/ebean-core/src/test/java/org/tests/query/finder/TestCustomerFinder.java index d36e36b51..68b5c627a 100644 --- a/ebean-core/src/test/java/org/tests/query/finder/TestCustomerFinder.java +++ b/ebean-core/src/test/java/org/tests/query/finder/TestCustomerFinder.java @@ -83,7 +83,7 @@ public class TestCustomerFinder extends BaseTestCase { assertThat(customer.getId()).isEqualTo(customer1.getId()); assertThat(customer.getName()).isEqualTo(customer1.getName()); - assertThat(Customer.find.db().getName()).isEqualTo(DB.getDefault().getName()); + assertThat(Customer.find.db().name()).isEqualTo(DB.getDefault().name()); } @Test diff --git a/ebean-ddl-generator/src/main/java/io/ebeaninternal/dbmigration/DdlGenerator.java b/ebean-ddl-generator/src/main/java/io/ebeaninternal/dbmigration/DdlGenerator.java index fe546ab27..4c9ff9320 100644 --- a/ebean-ddl-generator/src/main/java/io/ebeaninternal/dbmigration/DdlGenerator.java +++ b/ebean-ddl-generator/src/main/java/io/ebeaninternal/dbmigration/DdlGenerator.java @@ -321,11 +321,11 @@ public class DdlGenerator implements SpiDdlGenerator { } protected String getDropFileName() { - return server.getName() + "-drop-all.sql"; + return server.name() + "-drop-all.sql"; } protected String getCreateFileName() { - return server.getName() + "-create-all.sql"; + return server.name() + "-create-all.sql"; } protected CurrentModel currentModel() {