#58 - Rename methods with deprecation: getName() -> name(), getStatus() -> status() etc

Author: rbygrave

ebean-datasource-api/src/main/java/io/ebean/datasource/DataSourcePool.java

@@ -11,7 +11,15 @@ public interface DataSourcePool extends DataSource {
   /**
    * Return the dataSource name.
    */
-  String getName();
+  String name();
+
+  /**
+   * Deprecated migate to name().
+   */
+  @Deprecated
+  default String getName() {
+    return name();
+  }
 
   /**
    * Return the current size of the pool. This includes both busy and idle connections.
@@ -30,6 +38,13 @@ public interface DataSourcePool extends DataSource {
    */
   boolean isOnline();
 
+  /**
+   * Returns false when the dataSource is down.
+   * <p>
+   * Effectively the same as (synonym for) {@link #isOnline()}.
+   */
+  boolean isDataSourceUp();
+
   /**
    * Bring the DataSource online ensuring min connections and start heart beat checking.
    */
@@ -44,7 +59,7 @@ public interface DataSourcePool extends DataSource {
    * Shutdown the pool.
    * <p>
    * This is functionally the same as {@link #offline()} but generally we expect to only
-   * shutdown the pool once where as we can expect to making many calls to offline() and
+   * shutdown the pool once whereas we can expect to make many calls to offline() and
    * online().
    */
   void shutdown();
@@ -57,37 +72,46 @@ public interface DataSourcePool extends DataSource {
    * <p>
    * If you pass reset = true then the counters are reset.
    */
-  PoolStatus getStatus(boolean reset);
+  PoolStatus status(boolean reset);
 
   /**
-   * Returns false when the dataSource is down.
-   * <p>
-   * Effectively the same as (synonym for) {@link #isOnline()}.
+   * Deprecated migrate to status().
    */
-  boolean isDataSourceUp();
+  @Deprecated
+  default PoolStatus getStatus(boolean reset) {
+    return status(reset);
+  }
 
   /**
    * Returns the reason, why the dataSource is down.
    */
-  SQLException getDataSourceDownReason();
+  SQLException dataSourceDownReason();
+
+  /**
+   * Deprecated migrate to dataSourceDownReason().
+   */
+  @Deprecated
+  default SQLException getDataSourceDownReason() {
+    return dataSourceDownReason();
+  }
 
   /**
    * Set a new maximum size. The pool should respect this new maximum
-   * immediately and not require a restart. You may want to increase the
+   * immediately and not require a restart. We may want to increase the
    * maxConnections if the pool gets large and hits the warning level.
    */
   void setMaxSize(int max);
 
   /**
-   * Set a new maximum size. The pool should respect this new maximum immediately
-   * and not require a restart. You may want to increase the maxConnections if the
-   * pool gets large and hits the warning and or alert levels.
+   * Set a new maximum size. The pool should respect this new warning level immediately
+   * and not require a restart. We may want to increase the maxConnections if the
+   * pool gets large and hits the warning levels.
    */
   void setWarningSize(int warningSize);
 
   /**
    * Return the warning size. When the pool hits this size it can send a
-   * notify message to an administrator.
+   * warning message to an administrator.
    */
   int getWarningSize();
 

ebean-datasource/src/main/java/io/ebean/datasource/pool/ConnectionPool.java

@@ -273,7 +273,7 @@ public <T> T unwrap(Class<T> arg0) throws SQLException {
    * Return the dataSource name.
    */
   @Override
-  public String getName() {
+  public String name() {
     return name;
   }
 
@@ -306,16 +306,8 @@ int getMaxStackTraceSize() {
     return maxStackTraceSize;
   }
 
-  /**
-   * Returns false when the dataSource is down.
-   */
-  @Override
-  public boolean isDataSourceUp() {
-    return dataSourceUp.get();
-  }
-
   @Override
-  public SQLException getDataSourceDownReason() {
+  public SQLException dataSourceDownReason() {
     return dataSourceDownReason;
   }
 
@@ -776,6 +768,11 @@ public boolean isOnline() {
     return dataSourceUp.get();
   }
 
+  @Override
+  public boolean isDataSourceUp() {
+    return dataSourceUp.get();
+  }
+
   private void startHeartBeatIfStopped() {
     heartbeatLock.lock();
     try {
@@ -931,7 +928,7 @@ public void setPstmtCacheSize(int pstmtCacheSize) {
    * </p>
    */
   @Override
-  public PoolStatus getStatus(boolean reset) {
+  public PoolStatus status(boolean reset) {
     return queue.getStatus(reset);
   }
 

ebean-datasource/src/main/java/io/ebean/datasource/pool/PooledConnection.java

@@ -115,7 +115,7 @@ final class PooledConnection extends ConnectionDelegator {
     super(connection);
     this.pool = pool;
     this.connection = connection;
-    this.name = pool.getName() + uniqueId;
+    this.name = pool.name() + uniqueId;
     this.pstmtCache = new PstmtCache(pool.getPstmtCacheSize());
     this.maxStackTrace = pool.getMaxStackTraceSize();
     this.creationTime = System.currentTimeMillis();

ebean-datasource/src/main/java/io/ebean/datasource/pool/PooledConnectionQueue.java

@@ -64,7 +64,7 @@ final class PooledConnectionQueue {
 
   PooledConnectionQueue(ConnectionPool pool) {
     this.pool = pool;
-    this.name = pool.getName();
+    this.name = pool.name();
     this.minSize = pool.getMinSize();
     this.maxSize = pool.getMaxSize();
     this.warningSize = pool.getWarningSize();

ebean-datasource/src/test/java/io/ebean/datasource/pool/ConnectionPoolOfflineTest.java

@@ -41,43 +41,43 @@ public void testOffline() throws InterruptedException, SQLException {
     log.info("pool created ");
 
     waitFor(() -> {
-      assertEquals(0, pool.getStatus(false).getFree());
-      assertEquals(0, pool.getStatus(false).getBusy());
+      assertEquals(0, pool.status(false).getFree());
+      assertEquals(0, pool.status(false).getBusy());
       assertThat(pool.size()).isEqualTo(0);
     });
-    
+
     pool.online();
     log.info("pool online");
     assertThat(pool.isOnline()).isTrue();
-    assertEquals(2, pool.getStatus(false).getFree());
-    assertEquals(0, pool.getStatus(false).getBusy());
+    assertEquals(2, pool.status(false).getFree());
+    assertEquals(0, pool.status(false).getBusy());
     assertThat(pool.size()).isEqualTo(2);
 
     pool.offline();
     log.info("pool offline");
     waitFor(() -> {
       assertThat(pool.isOnline()).isFalse();
-      assertEquals(0, pool.getStatus(false).getFree());
-      assertEquals(0, pool.getStatus(false).getBusy());
+      assertEquals(0, pool.status(false).getFree());
+      assertEquals(0, pool.status(false).getBusy());
       assertThat(pool.size()).isEqualTo(0);
     });
 
     pool.online();
     log.info("pool online");
-    
+
     waitFor(() -> {
       assertThat(pool.isOnline()).isTrue();
-      assertEquals(2, pool.getStatus(false).getFree());
-      assertEquals(0, pool.getStatus(false).getBusy());
+      assertEquals(2, pool.status(false).getFree());
+      assertEquals(0, pool.status(false).getBusy());
       assertThat(pool.size()).isEqualTo(2);
     });
-    
+
     pool.shutdown();
 
     waitFor(() -> {
       assertThat(pool.isOnline()).isFalse();
-      assertEquals(0, pool.getStatus(false).getFree());
-      assertEquals(0, pool.getStatus(false).getBusy());
+      assertEquals(0, pool.status(false).getFree());
+      assertEquals(0, pool.status(false).getBusy());
       assertThat(pool.size()).isEqualTo(0);
     });
   }
@@ -126,19 +126,19 @@ public void offline_whenBusy_allowed() throws SQLException, InterruptedException
 
     Thread.sleep(200);
     System.out.println("-- taking pool offline (with a busy connection)");
-    assertEquals(1, pool.getStatus(false).getBusy());
+    assertEquals(1, pool.status(false).getBusy());
     assertThat(pool.size()).isEqualTo(2);
 
     pool.offline();
-    assertEquals(0, pool.getStatus(false).getFree());
-    assertEquals(1, pool.getStatus(false).getBusy()); // still 1 busy connection
+    assertEquals(0, pool.status(false).getFree());
+    assertEquals(1, pool.status(false).getBusy()); // still 1 busy connection
     assertThat(pool.size()).isEqualTo(1);
 
     // wait to let busy connection finish and close
     waitFor(() -> {
       // all done now
-      assertEquals(0, pool.getStatus(false).getFree());
-      assertEquals(0, pool.getStatus(false).getBusy());
+      assertEquals(0, pool.status(false).getFree());
+      assertEquals(0, pool.status(false).getBusy());
       assertThat(pool.size()).isEqualTo(0);
     });
   }

ebean-datasource/src/test/java/io/ebean/datasource/pool/ConnectionPoolTest.java

@@ -42,28 +42,28 @@ public void getConnection_expect_poolGrowsAboveMin() throws SQLException {
     Connection con1 = pool.getConnection();
     Connection con2 = pool.getConnection();
 
-    assertThat(pool.getStatus(false).getBusy()).isEqualTo(2);
-    assertThat(pool.getStatus(false).getFree()).isEqualTo(0);
+    assertThat(pool.status(false).getBusy()).isEqualTo(2);
+    assertThat(pool.status(false).getFree()).isEqualTo(0);
     assertThat(pool.size()).isEqualTo(2);
 
     Connection con3 = pool.getConnection();
-    assertThat(pool.getStatus(false).getBusy()).isEqualTo(3);
-    assertThat(pool.getStatus(false).getFree()).isEqualTo(0);
+    assertThat(pool.status(false).getBusy()).isEqualTo(3);
+    assertThat(pool.status(false).getFree()).isEqualTo(0);
     assertThat(pool.size()).isEqualTo(3);
 
     con2.close();
-    assertThat(pool.getStatus(false).getBusy()).isEqualTo(2);
-    assertThat(pool.getStatus(false).getFree()).isEqualTo(1);
+    assertThat(pool.status(false).getBusy()).isEqualTo(2);
+    assertThat(pool.status(false).getFree()).isEqualTo(1);
     assertThat(pool.size()).isEqualTo(3);
 
     con3.close();
-    assertThat(pool.getStatus(false).getBusy()).isEqualTo(1);
-    assertThat(pool.getStatus(false).getFree()).isEqualTo(2);
+    assertThat(pool.status(false).getBusy()).isEqualTo(1);
+    assertThat(pool.status(false).getFree()).isEqualTo(2);
     assertThat(pool.size()).isEqualTo(3);
 
     con1.close();
-    assertThat(pool.getStatus(false).getBusy()).isEqualTo(0);
-    assertThat(pool.getStatus(false).getFree()).isEqualTo(3);
+    assertThat(pool.status(false).getBusy()).isEqualTo(0);
+    assertThat(pool.status(false).getFree()).isEqualTo(3);
     assertThat(pool.size()).isEqualTo(3);
   }
 

ebean-datasource/src/test/java/io/ebean/datasource/pool/ConnectionPoolTrimIdleTest.java

@@ -45,10 +45,10 @@ public void test() throws SQLException, InterruptedException {
       con3.close();
       con4.close();
       assertThat(pool.size()).isEqualTo(4);
-      assertThat(pool.getStatus(false).getFree()).isEqualTo(4);
+      assertThat(pool.status(false).getFree()).isEqualTo(4);
 
       waitFor(() -> {
-        assertThat(pool.getStatus(false).getFree()).isEqualTo(1);
+        assertThat(pool.status(false).getFree()).isEqualTo(1);
         assertThat(pool.size()).isEqualTo(1);
       });
     } finally {
@@ -71,28 +71,28 @@ public void test_withDecreasingActivity_expect_trimToActivityLevel() throws SQLE
       }
 
       // start at 10 connections
-      assertThat(pool.getStatus(false).getFree()).isEqualTo(10);
+      assertThat(pool.status(false).getFree()).isEqualTo(10);
       assertThat(pool.size()).isEqualTo(10);
 
       // keep 4 connections busy
       Timer timer0 = createTimer(pool, 4);
 
       waitFor(() -> {
-        assertThat(pool.getStatus(false).getFree()).isEqualTo(4);
+        assertThat(pool.status(false).getFree()).isEqualTo(4);
       });
       timer0.cancel();
 
       // keep 2 connections busy
       Timer timer1 = createTimer(pool, 2);
 
       waitFor(() -> {
-        assertThat(pool.getStatus(false).getFree()).isEqualTo(2);
+        assertThat(pool.status(false).getFree()).isEqualTo(2);
       });
       timer1.cancel();
 
       // Go Idle
       waitFor(() -> {
-        assertThat(pool.getStatus(false).getFree()).isEqualTo(1);
+        assertThat(pool.status(false).getFree()).isEqualTo(1);
         assertThat(pool.size()).isEqualTo(1);
       });
     } finally {