#61 - Tidy internals - use accessor methods instead of getters

Author: rbygrave

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

@@ -46,7 +46,7 @@ public String toString() {
     return Arrays.toString(slots);
   }
 
-  int getCapacity() {
+  int capacity() {
     return slots.length;
   }
 
@@ -70,10 +70,10 @@ int add(PooledConnection pc) {
   }
 
   boolean remove(PooledConnection pc) {
-    int slotId = pc.getSlotId();
+    int slotId = pc.slotId();
     if (slots[slotId] != pc) {
       PooledConnection heldBy = slots[slotId];
-      Log.warn("Failed to remove from slot[{0}] PooledConnection[{1}] - HeldBy[{2}]", pc.getSlotId(), pc, heldBy);
+      Log.warn("Failed to remove from slot[{0}] PooledConnection[{1}] - HeldBy[{2}]", pc.slotId(), pc, heldBy);
       return false;
     }
     slots[slotId] = null;
@@ -92,7 +92,7 @@ void closeBusyConnections(long leakTimeMinutes) {
         //tmp.add(slots[i]);
         PooledConnection pc = slots[i];
         //noinspection StatementWithEmptyBody
-        if (pc.getLastUsedTime() > olderThanTime) {
+        if (pc.lastUsedTime() > olderThanTime) {
           // PooledConnection has been used recently or
           // expected to be longRunning so not closing...
         } else {
@@ -106,28 +106,28 @@ void closeBusyConnections(long leakTimeMinutes) {
 
   private void closeBusyConnection(PooledConnection pc) {
     try {
-      Log.warn("DataSourcePool closing busy connection? {0}", pc.getFullDescription());
-      System.out.println("CLOSING busy connection: " + pc.getFullDescription());
+      Log.warn("DataSourcePool closing busy connection? {0}", pc.fullDescription());
+      System.out.println("CLOSING busy connection: " + pc.fullDescription());
       pc.closeConnectionFully(false);
     } catch (Exception ex) {
-      Log.error("Error when closing potentially leaked connection " + pc.getDescription(), ex);
+      Log.error("Error when closing potentially leaked connection " + pc.description(), ex);
     }
   }
 
   /**
    * Returns information describing connections that are currently being used.
    */
-  String getBusyConnectionInformation(boolean toLogger) {
+  String busyConnectionInformation(boolean toLogger) {
     if (toLogger) {
       Log.info("Dumping [{0}] busy connections: (Use datasource.xxx.capturestacktrace=true  ... to get stackTraces)", size());
     }
     StringBuilder sb = new StringBuilder();
     for (PooledConnection pc : slots) {
       if (pc != null) {
         if (toLogger) {
-          Log.info("Busy Connection - {0}", pc.getFullDescription());
+          Log.info("Busy Connection - {0}", pc.fullDescription());
         } else {
-          sb.append(pc.getFullDescription()).append("\r\n");
+          sb.append(pc.fullDescription()).append("\r\n");
         }
       }
     }

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

@@ -1,7 +1,6 @@
 package io.ebean.datasource.pool;
 
 import java.sql.*;
-import java.util.Map;
 import java.util.Properties;
 import java.util.concurrent.Executor;
 
@@ -17,7 +16,7 @@ abstract class ConnectionDelegator implements Connection {
   /**
    * Return the underlying connection.
    */
-  Connection getDelegate() {
+  Connection delegate() {
     return delegate;
   }
 
@@ -47,58 +46,71 @@ public final int getNetworkTimeout() throws SQLException {
     return delegate.getNetworkTimeout();
   }
 
+  @Override
   public final Clob createClob() throws SQLException {
     return delegate.createClob();
   }
 
+  @Override
   public final Blob createBlob() throws SQLException {
     return delegate.createBlob();
   }
 
+  @Override
   public final NClob createNClob() throws SQLException {
     return delegate.createNClob();
   }
 
+  @Override
   public final SQLXML createSQLXML() throws SQLException {
     return delegate.createSQLXML();
   }
 
+  @Override
   public final boolean isValid(int timeout) throws SQLException {
     return delegate.isValid(timeout);
   }
 
+  @Override
   public final void setClientInfo(String name, String value) throws SQLClientInfoException {
     delegate.setClientInfo(name, value);
   }
 
+  @Override
   public final void setClientInfo(Properties properties) throws SQLClientInfoException {
     delegate.setClientInfo(properties);
   }
 
+  @Override
   public final String getClientInfo(String name) throws SQLException {
     return delegate.getClientInfo(name);
   }
 
+  @Override
   public final Properties getClientInfo() throws SQLException {
     return delegate.getClientInfo();
   }
 
+  @Override
   public final Array createArrayOf(String typeName, Object[] elements) throws SQLException {
     return delegate.createArrayOf(typeName, elements);
   }
 
+  @Override
   public final Struct createStruct(String typeName, Object[] attributes) throws SQLException {
     return delegate.createStruct(typeName, attributes);
   }
 
   @SuppressWarnings("unchecked")
+  @Override
   public final <T> T unwrap(Class<T> iface) throws SQLException {
     if (iface.equals(java.sql.Connection.class)) {
       return (T) delegate;
     }
     return delegate.unwrap(iface);
   }
 
+  @Override
   public final boolean isWrapperFor(Class<?> iface) throws SQLException {
     return delegate.isWrapperFor(iface);
   }

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

@@ -560,7 +560,7 @@ boolean validateConnection(PooledConnection conn) {
     try {
       return testConnection(conn);
     } catch (Exception e) {
-      Log.warn("Heartbeat test failed on connection:{0} message: {1}", conn.getName(), e.getMessage());
+      Log.warn("Heartbeat test failed on connection:{0} message: {1}", conn.name(), e.getMessage());
       return false;
     }
   }

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

@@ -51,17 +51,10 @@ ExtendedPreparedStatement reset() {
   /**
    * Return the key used to cache this on the Connection.
    */
-  String getCacheKey() {
+  String cacheKey() {
     return cacheKey;
   }
 
-  /**
-   * Return the SQL used to create this PreparedStatement.
-   */
-  public String getSql() {
-    return sql;
-  }
-
   /**
    * Fully close the underlying PreparedStatement. After this we can no longer
    * reuse the PreparedStatement.

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

@@ -135,7 +135,7 @@ final class PooledConnection extends ConnectionDelegator {
   /**
    * Return the slot position in the busy buffer.
    */
-  int getSlotId() {
+  int slotId() {
     return slotId;
   }
 
@@ -149,25 +149,25 @@ void setSlotId(int slotId) {
   /**
    * Return a string to identify the connection.
    */
-  String getName() {
+  String name() {
     return name;
   }
 
   @Override
   public String toString() {
-    return getDescription();
+    return description();
   }
 
-  private long getBusySeconds() {
+  private long busySeconds() {
     return (System.currentTimeMillis() - startUseTime) / 1000;
   }
 
-  String getDescription() {
-    return "name[" + name + "] startTime[" + getStartUseTime() + "] busySeconds[" + getBusySeconds() + "] createdBy[" + getCreatedByMethod() + "] stmt[" + getLastStatement() + "]";
+  String description() {
+    return "name[" + name + "] startTime[" + startUseTime() + "] busySeconds[" + busySeconds() + "] createdBy[" + createdByMethod() + "] stmt[" + lastStatement() + "]";
   }
 
-  String getFullDescription() {
-    return "name[" + name + "] startTime[" + getStartUseTime() + "] busySeconds[" + getBusySeconds() + "] stackTrace[" + getStackTraceAsString() + "] stmt[" + getLastStatement() + "]";
+  String fullDescription() {
+    return "name[" + name + "] startTime[" + startUseTime() + "] busySeconds[" + busySeconds() + "] stackTrace[" + stackTraceAsString() + "] stmt[" + lastStatement() + "]";
   }
 
   /**
@@ -212,7 +212,7 @@ void closeConnectionFully(boolean logErrors) {
       pool.dec();
     } catch (SQLException ex) {
       if (logErrors || Log.isLoggable(System.Logger.Level.DEBUG)) {
-        Log.error("Error when fully closing connection [" + getFullDescription() + "]", ex);
+        Log.error("Error when fully closing connection [" + fullDescription() + "]", ex);
       }
     }
   }
@@ -471,7 +471,7 @@ boolean shouldTrim(long usedSince, long createdSince) {
    * <p>
    * Used to detect busy connections that could be leaks.
    */
-  private long getStartUseTime() {
+  private long startUseTime() {
     return startUseTime;
   }
 
@@ -480,14 +480,14 @@ private long getStartUseTime() {
    * <p>
    * Used to close connections that have been idle for some time. Typically 5 minutes.
    */
-  long getLastUsedTime() {
+  long lastUsedTime() {
     return lastUseTime;
   }
 
   /**
    * Returns the last sql statement executed.
    */
-  private String getLastStatement() {
+  private String lastStatement() {
     return lastStatement;
   }
 
@@ -804,7 +804,7 @@ public CallableStatement prepareCall(String s, int i, int x, int y) throws SQLEx
    * Used to help finding connection pool leaks.
    * </p>
    */
-  private String getCreatedByMethod() {
+  private String createdByMethod() {
     if (createdByMethod != null) {
       return createdByMethod;
     }
@@ -839,8 +839,8 @@ void setStackTrace(StackTraceElement[] stackTrace) {
   /**
    * Return the stackTrace as a String for logging purposes.
    */
-  private String getStackTraceAsString() {
-    StackTraceElement[] stackTrace = getStackTrace();
+  private String stackTraceAsString() {
+    StackTraceElement[] stackTrace = stackTrace();
     if (stackTrace == null) {
       return "";
     }
@@ -851,7 +851,7 @@ private String getStackTraceAsString() {
    * Return the full stack trace that got the connection from the pool. You
    * could use this if getCreatedByMethod() doesn't work for you.
    */
-  private StackTraceElement[] getStackTrace() {
+  private StackTraceElement[] stackTrace() {
     if (stackTrace == null) {
       return null;
     }

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

@@ -234,7 +234,7 @@ private PooledConnection _obtainConnection() throws InterruptedException, SQLExc
           PooledConnection c = pool.createConnectionForQueue(connectionId++);
           int busySize = registerBusyConnection(c);
           if (Log.isLoggable(Level.DEBUG)) {
-            Log.debug("DataSourcePool [{0}] grow; id[{1}] busy[{2}] max[{3}]", name, c.getName(), busySize, maxSize);
+            Log.debug("DataSourcePool [{0}] grow; id[{1}] busy[{2}] max[{3}]", name, c.name(), busySize, maxSize);
           }
           checkForWarningSize();
           return c;
@@ -402,14 +402,12 @@ void closeBusyConnections(long leakTimeMinutes) {
    * This is called whenever the pool grows in size (towards the max limit).
    */
   private void checkForWarningSize() {
-    // the the total number of connections that we can add
+    // the total number of connections that we can add
     // to the pool before it hits the maximum
     int availableGrowth = (maxSize - totalConnections());
-
     if (availableGrowth < warningSize) {
       closeBusyConnections(leakTimeMinutes);
-      String msg = "DataSourcePool [" + name + "] is [" + availableGrowth + "] connections from its maximum size.";
-      pool.notifyWarning(msg);
+      pool.notifyWarning("DataSourcePool [" + name + "] is [" + availableGrowth + "] connections from its maximum size.");
     }
   }
 
@@ -427,7 +425,7 @@ void dumpBusyConnectionInformation() {
   private String getBusyConnectionInformation(boolean toLogger) {
     lock.lock();
     try {
-      return busyList.getBusyConnectionInformation(toLogger);
+      return busyList.busyConnectionInformation(toLogger);
     } finally {
       lock.unlock();
     }

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

@@ -63,14 +63,14 @@ long putCount() {
    * the statement to the cache and return true.
    */
   boolean returnStatement(ExtendedPreparedStatement stmt) {
-    ExtendedPreparedStatement alreadyInCache = super.get(stmt.getCacheKey());
+    ExtendedPreparedStatement alreadyInCache = super.get(stmt.cacheKey());
     if (alreadyInCache != null) {
       return false;
     }
     // add the returning prepared statement to the cache.
     // Note that the LRUCache will automatically close fully old unused
     // statements when the cache has hit its maximum size.
-    put(stmt.getCacheKey(), stmt);
+    put(stmt.cacheKey(), stmt);
     return true;
   }