Refactor MigrationVersion methods from getters to accessors with deprecation

Author: rob-bygrave

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

@@ -7,7 +7,7 @@
 /**
  * The version of a migration used so that migrations are processed in order.
  */
-public class MigrationVersion implements Comparable<MigrationVersion> {
+public final class MigrationVersion implements Comparable<MigrationVersion> {
 
   public static final String BOOTINIT_TYPE = "B";
   private static final String INIT_TYPE = "I";
@@ -73,8 +73,9 @@ public boolean isRepeatableLast() {
   }
 
   /**
-   * Return the full version.
+   * Deprecated migrate to raw().
    */
+  @Deprecated
   public String getFull() {
     return raw;
   }
@@ -86,17 +87,33 @@ public String toString() {
   /**
    * Return the version comment.
    */
+  public String comment() {
+    return comment;
+  }
+
+  /**
+   * Deprecated migrate to comment();
+   */
+  @Deprecated
   public String getComment() {
     return comment;
   }
 
   /**
    * Return the version in raw form.
    */
-  public String getRaw() {
+  public String raw() {
     return raw;
   }
 
+  /**
+   * Deprecated migrate to raw().
+   */
+  @Deprecated
+  public String getRaw() {
+    return raw();
+  }
+
   /**
    * Return the trimmed version excluding version comment and un-parsable string.
    */
@@ -126,7 +143,7 @@ public String nextVersion() {
    */
   private String formattedVersion(boolean normalised, boolean nextVersion) {
     if (isRepeatable()) {
-      return getType();
+      return type();
     }
     StringBuilder sb = new StringBuilder();
     for (int i = 0; i < ordering.length; i++) {
@@ -226,7 +243,7 @@ public static MigrationVersion parse(String raw) {
   /**
    * Return the version type (I, R or V).
    */
-  public String getType() {
+  public String type() {
     if (ordering == REPEAT_ORDERING_MIN) {
       return INIT_TYPE;
 
@@ -237,4 +254,12 @@ public String getType() {
       return VERSION_TYPE;
     }
   }
+
+  /**
+   * Deprecated migrate to type().
+   */
+  @Deprecated
+  public String getType() {
+    return type();
+  }
 }

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

@@ -19,7 +19,7 @@ public abstract class LocalMigrationResource implements Comparable<LocalMigratio
   public LocalMigrationResource(MigrationVersion version, String location) {
     this.version = version;
     this.location = location;
-    this.type = version.getType();
+    this.type = version.type();
   }
 
   public String toString() {
@@ -52,7 +52,7 @@ public boolean isRepeatableLast() {
    */
   public String key() {
     if (isRepeatable()) {
-      return version.getComment().toLowerCase();
+      return version.comment().toLowerCase();
     } else {
       return version.normalised();
     }
@@ -62,7 +62,7 @@ public String key() {
    * Return the migration comment.
    */
   public String getComment() {
-    String comment = version.getComment();
+    String comment = version.comment();
     return (comment == null || comment.isEmpty()) ? "-" : comment;
   }
 

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

@@ -23,11 +23,11 @@ void sort() {
 
     Collections.sort(list);
 
-    assertThat(list.get(0).getComment()).isEqualTo("init");
-    assertThat(list.get(1).getComment()).isEqualTo("point");
-    assertThat(list.get(2).getComment()).isEqualTo("three");
-    assertThat(list.get(3).getComment()).isEqualTo("alpha");
-    assertThat(list.get(4).getComment()).isEqualTo("beta");
+    assertThat(list.get(0).comment()).isEqualTo("init");
+    assertThat(list.get(1).comment()).isEqualTo("point");
+    assertThat(list.get(2).comment()).isEqualTo("three");
+    assertThat(list.get(3).comment()).isEqualTo("alpha");
+    assertThat(list.get(4).comment()).isEqualTo("beta");
   }
 
   @Test
@@ -44,68 +44,68 @@ void test_parse_hyphenSnapshot() {
 
     MigrationVersion version = MigrationVersion.parse("0.1.1-SNAPSHOT");
     assertThat(version.normalised()).isEqualTo("0.1.1");
-    assertThat(version.getComment()).isEqualTo("");
-    assertThat(version.getType()).isEqualTo("V");
+    assertThat(version.comment()).isEqualTo("");
+    assertThat(version.type()).isEqualTo("V");
   }
 
   @Test
   void test_parse_hyphenSnapshot_when_underscores() {
 
     MigrationVersion version = MigrationVersion.parse("0_1_1-SNAPSHOT__Foo");
     assertThat(version.normalised()).isEqualTo("0.1.1");
-    assertThat(version.getComment()).isEqualTo("Foo");
+    assertThat(version.comment()).isEqualTo("Foo");
   }
 
   @Test
   void test_parse_when_repeatable() {
 
     MigrationVersion version = MigrationVersion.parse("R__Foo");
-    assertThat(version.getComment()).isEqualTo("Foo");
+    assertThat(version.comment()).isEqualTo("Foo");
     assertThat(version.isRepeatable()).isTrue();
     assertThat(version.normalised()).isEqualTo("R");
-    assertThat(version.getType()).isEqualTo("R");
+    assertThat(version.type()).isEqualTo("R");
   }
 
   @Test
   void test_parse_when_init() {
 
     MigrationVersion version = MigrationVersion.parse("I__Foo");
-    assertThat(version.getComment()).isEqualTo("Foo");
+    assertThat(version.comment()).isEqualTo("Foo");
     assertThat(version.isRepeatable()).isTrue();
     assertThat(version.normalised()).isEqualTo("I");
-    assertThat(version.getType()).isEqualTo("I");
+    assertThat(version.type()).isEqualTo("I");
   }
 
   @Test
   void test_parse_when_repeatable_R1() {
 
     MigrationVersion version = MigrationVersion.parse("R1__Foo");
-    assertThat(version.getComment()).isEqualTo("Foo");
+    assertThat(version.comment()).isEqualTo("Foo");
     assertThat(version.normalised()).isEqualTo("R");
     assertThat(version.isRepeatable()).isTrue();
-    assertThat(version.getType()).isEqualTo("R");
+    assertThat(version.type()).isEqualTo("R");
   }
 
   @Test
   void test_parse_when_repeatable_case() {
 
     MigrationVersion version = MigrationVersion.parse("r__Foo");
     assertThat(version.isRepeatable()).isTrue();
-    assertThat(version.getComment()).isEqualTo("Foo");
+    assertThat(version.comment()).isEqualTo("Foo");
     assertThat(version.normalised()).isEqualTo("R");
-    assertThat(version.getType()).isEqualTo("R");
+    assertThat(version.type()).isEqualTo("R");
   }
 
   @Test
   void test_parse_when_v_prefix() {
 
     MigrationVersion version = MigrationVersion.parse("v1_0__Foo");
     assertThat(version.isRepeatable()).isFalse();
-    assertThat(version.getComment()).isEqualTo("Foo");
+    assertThat(version.comment()).isEqualTo("Foo");
     assertThat(version.normalised()).isEqualTo("1.0");
     assertThat(version.asString()).isEqualTo("1_0");
-    assertThat(version.getRaw()).isEqualTo("1_0__Foo");
-    assertThat(version.getType()).isEqualTo("V");
+    assertThat(version.raw()).isEqualTo("1_0__Foo");
+    assertThat(version.type()).isEqualTo("V");
   }
 
   @Test
@@ -143,12 +143,12 @@ void repeatable_compareTo_when_caseDifferent() {
   @Test
   void test_parse_getComment(){
 
-    assertThat(MigrationVersion.parse("1.1.1_2__Foo").getComment()).isEqualTo("Foo");
-    assertThat(MigrationVersion.parse("1.1.1.2__junk").getComment()).isEqualTo("junk");
-    assertThat(MigrationVersion.parse("1.1_1.2_foo").getComment()).isEqualTo("");
-    assertThat(MigrationVersion.parse("1.1_1.2_d").getComment()).isEqualTo("");
-    assertThat(MigrationVersion.parse("1.1_1.2_").getComment()).isEqualTo("");
-    assertThat(MigrationVersion.parse("1.1_1.2").getComment()).isEqualTo("");
+    assertThat(MigrationVersion.parse("1.1.1_2__Foo").comment()).isEqualTo("Foo");
+    assertThat(MigrationVersion.parse("1.1.1.2__junk").comment()).isEqualTo("junk");
+    assertThat(MigrationVersion.parse("1.1_1.2_foo").comment()).isEqualTo("");
+    assertThat(MigrationVersion.parse("1.1_1.2_d").comment()).isEqualTo("");
+    assertThat(MigrationVersion.parse("1.1_1.2_").comment()).isEqualTo("");
+    assertThat(MigrationVersion.parse("1.1_1.2").comment()).isEqualTo("");
   }
 
   @Test