Refactor internal methods from getters to accessors (plus some finals)

Author: rob-bygrave

ebean-migration/src/main/java/io/ebean/migration/MigrationRunner.java

@@ -101,7 +101,7 @@ protected void run(Connection connection, boolean checkStateOnly) {
       MigrationTable table = new MigrationTable(migrationConfig, connection, checkStateOnly, platform);
       table.createIfNeededAndLock();
       try {
-        List<LocalMigrationResource> migrations = resources.getVersions();
+        List<LocalMigrationResource> migrations = resources.versions();
         runMigrations(migrations, table, checkStateOnly);
         connection.commit();
         if (!checkStateOnly) {
@@ -152,7 +152,7 @@ private void runMigrations(List<LocalMigrationResource> localVersions, Migration
   private LocalMigrationResource getInitVersion() {
     LocalMigrationResources initResources = new LocalMigrationResources(migrationConfig);
     if (initResources.readInitResources()) {
-      List<LocalMigrationResource> initVersions = initResources.getVersions();
+      List<LocalMigrationResource> initVersions = initResources.versions();
       if (!initVersions.isEmpty()) {
         return initVersions.get(initVersions.size() - 1);
       }

ebean-migration/src/main/java/io/ebean/migration/runner/LocalMigrationResources.java

@@ -16,7 +16,7 @@
 /**
  * Loads the DB migration resources and sorts them into execution order.
  */
-public class LocalMigrationResources {
+public final class LocalMigrationResources {
 
   private static final System.Logger log = MigrationSchema.log;
 
@@ -134,11 +134,10 @@ private LocalMigrationResource createScriptMigration(Resource resource, String f
   /**
    * Return the list of migration resources in version order.
    */
-  public List<LocalMigrationResource> getVersions() {
+  public List<LocalMigrationResource> versions() {
     return versions;
   }
 
-
   /**
    * Filter used to find the migration scripts.
    */

ebean-migration/src/main/java/io/ebean/migration/runner/MigrationMetaRow.java

@@ -58,25 +58,25 @@ public String toString() {
   /**
    * Return the id for this migration.
    */
-  int getId() {
+  int id() {
     return id;
   }
 
   /**
    * Return the normalised version for this migration.
    */
-  String getVersion() {
+  String version() {
     return version;
   }
 
   /**
    * Return the checksum for this migration.
    */
-  int getChecksum() {
+  int checksum() {
     return checksum;
   }
 
-  String getType() {
+  String type() {
     return type;
   }
 

ebean-migration/src/main/java/io/ebean/migration/runner/MigrationScriptRunner.java

@@ -10,7 +10,7 @@
 /**
  * Runs the DDL migration scripts.
  */
-class MigrationScriptRunner {
+final class MigrationScriptRunner {
 
   private final Connection connection;
 

ebean-migration/src/main/java/io/ebean/migration/runner/MigrationTable.java

@@ -121,7 +121,7 @@ public int size() {
   /**
    * Returns the versions that are already applied.
    */
-  public Set<String> getVersions() {
+  public Set<String> versions() {
     return migrations.keySet();
   }
 
@@ -188,7 +188,7 @@ public void unlockMigrationTable() throws SQLException {
    */
   private void readExistingMigrations() throws SQLException {
     for (MigrationMetaRow metaRow : platform.readExistingMigrations(sqlTable, connection)) {
-      addMigration(metaRow.getVersion(), metaRow);
+      addMigration(metaRow.version(), metaRow);
     }
   }
 
@@ -207,14 +207,14 @@ void createTable() throws IOException, SQLException {
    * Return the create table script.
    */
   String createTableDdl() throws IOException {
-    String script = ScriptTransform.replace("${table}", sqlTable, getCreateTableScript());
+    String script = ScriptTransform.replace("${table}", sqlTable, createTableScript());
     return ScriptTransform.replace("${pk_table}", sqlPrimaryKey(), script);
   }
 
   /**
    * Return the create table script.
    */
-  private String getCreateTableScript() throws IOException {
+  private String createTableScript() throws IOException {
     // supply a script to override the default table create script
     String script = readResource("migration-support/create-table.sql");
     if (script == null && platformName != null && !platformName.isEmpty()) {
@@ -233,15 +233,15 @@ private String getCreateTableScript() throws IOException {
   }
 
   private String readResource(String location) throws IOException {
-    Enumeration<URL> resources = getClassLoader().getResources(location);
+    Enumeration<URL> resources = classLoader().getResources(location);
     if (resources.hasMoreElements()) {
       URL url = resources.nextElement();
       return IOUtils.readUtf8(url);
     }
     return null;
   }
 
-  private ClassLoader getClassLoader() {
+  private ClassLoader classLoader() {
     return Thread.currentThread().getContextClassLoader();
   }
 
@@ -331,7 +331,7 @@ private boolean patchInsertMigration(LocalMigrationResource local, int checksum)
    * Return true if the migration should be skipped.
    */
   boolean skipMigration(int checksum, LocalMigrationResource local, MigrationMetaRow existing) throws SQLException {
-    boolean matchChecksum = (existing.getChecksum() == checksum);
+    boolean matchChecksum = (existing.checksum() == checksum);
     if (matchChecksum) {
       log.log(TRACE, "skip unchanged migration {0}", local.location());
       return true;
@@ -352,7 +352,7 @@ boolean skipMigration(int checksum, LocalMigrationResource local, MigrationMetaR
    * Return true if the checksum is reset on the existing migration.
    */
   private boolean patchResetChecksum(MigrationMetaRow existing, int newChecksum) throws SQLException {
-    if (isResetOnVersion(existing.getVersion())) {
+    if (isResetOnVersion(existing.version())) {
       if (!checkStateOnly) {
         existing.resetChecksum(newChecksum, connection, updateChecksumSql);
       }
@@ -428,16 +428,13 @@ private MigrationMetaRow createInitMetaRow() {
    * Create the MigrationMetaRow for this migration.
    */
   private MigrationMetaRow createMetaRow(LocalMigrationResource migration, int checksum, long exeMillis) {
-
     int nextId = 1;
     if (lastMigration != null) {
-      nextId = lastMigration.getId() + 1;
+      nextId = lastMigration.id() + 1;
     }
-
     String type = migration.type();
     String runVersion = migration.key();
     String comment = migration.comment();
-
     return new MigrationMetaRow(nextId, type, runVersion, comment, checksum, envUserName, runOn, exeMillis);
   }
 
@@ -464,17 +461,17 @@ private void addMigration(String key, MigrationMetaRow metaRow) {
       return;
     }
     lastMigration = metaRow;
-    if (metaRow.getVersion() == null) {
+    if (metaRow.version() == null) {
       throw new IllegalStateException("No runVersion in db migration table row? " + metaRow);
     }
 
     migrations.put(key, metaRow);
-    if (VERSION_TYPE.equals(metaRow.getType()) || BOOTINIT_TYPE.equals(metaRow.getType())) {
-      MigrationVersion rowVersion = MigrationVersion.parse(metaRow.getVersion());
+    if (VERSION_TYPE.equals(metaRow.type()) || BOOTINIT_TYPE.equals(metaRow.type())) {
+      MigrationVersion rowVersion = MigrationVersion.parse(metaRow.version());
       if (currentVersion == null || rowVersion.compareTo(currentVersion) > 0) {
         currentVersion = rowVersion;
       }
-      if (BOOTINIT_TYPE.equals(metaRow.getType())) {
+      if (BOOTINIT_TYPE.equals(metaRow.type())) {
         dbInitVersion = rowVersion;
       }
     }
@@ -555,6 +552,9 @@ public int runNonTransactional() {
     return scriptRunner.runNonTransactional();
   }
 
+  /**
+   * Return the count of migrations that were run.
+   */
   public int count() {
     return executionCount;
   }

ebean-migration/src/test/java/io/ebean/migration/MigrationTableTest.java

@@ -52,7 +52,7 @@ public void testMigrationTableBase() throws Exception {
     try (Connection conn = dataSource.getConnection()) {
       MigrationTable table = new MigrationTable(config, conn, false, platform);
       table.createIfNeededAndLock();
-      assertThat(table.getVersions()).containsExactly("hello", "1.1", "1.2", "1.2.1", "m2_view");
+      assertThat(table.versions()).containsExactly("hello", "1.1", "1.2", "1.2.1", "m2_view");
 
       List<String> rawVersions = new ArrayList<>();
       try (PreparedStatement stmt = conn.prepareStatement("select mversion from db_migration order by id")) {
@@ -79,7 +79,7 @@ public void testMigrationTableRepeatableOk() throws Exception {
     try (Connection conn = dataSource.getConnection()) {
       MigrationTable table = new MigrationTable(config, conn, false, platform);
       table.createIfNeededAndLock();
-      assertThat(table.getVersions()).containsExactly("1.1");
+      assertThat(table.versions()).containsExactly("1.1");
       table.unlockMigrationTable();
       conn.rollback();
     }
@@ -92,7 +92,7 @@ public void testMigrationTableRepeatableOk() throws Exception {
     try (Connection conn = dataSource.getConnection()) {
       MigrationTable table = new MigrationTable(config, conn, false, platform);
       table.createIfNeededAndLock();
-      assertThat(table.getVersions()).containsExactly("1.1", "1.2", "m2_view");
+      assertThat(table.versions()).containsExactly("1.1", "1.2", "m2_view");
       table.unlockMigrationTable();
       conn.rollback();
     }
@@ -110,7 +110,7 @@ public void testMigrationTableRepeatableFail() throws Exception {
     try (Connection conn = dataSource.getConnection()) {
       MigrationTable table = new MigrationTable(config, conn, false, platform);
       table.createIfNeededAndLock();
-      assertThat(table.getVersions()).containsExactly("1.1");
+      assertThat(table.versions()).containsExactly("1.1");
       table.unlockMigrationTable();
       conn.rollback();
     }
@@ -143,7 +143,7 @@ public void testMigrationTableRepeatableFail() throws Exception {
       // we expect, that 1.1 and 1.2 is executed (but not the R__ script)
       MigrationTable table = new MigrationTable(config, conn, false, platform);
       table.createIfNeededAndLock();
-      assertThat(table.getVersions()).containsExactly("1.1", "1.2");
+      assertThat(table.versions()).containsExactly("1.1", "1.2");
       conn.rollback();
     }
   }