Renamed ChangeFile time methods

Niklas Schultz · Niklas Schultz · commit c1fe5272ba8b · 2018-05-25T18:09:05.000+02:00
Also fixed small typo in JavaDoc
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ class Example implements DirectoryWatchable {
         // what file is the event referring to:
         System.out.println(changedFile.getAbsolutePath());
         // when did it happen:
-        System.out.println(changedFile.whenAsString());
+        System.out.println(changedFile.getChangeTime());
         // you could also call the toString method to get all of the information above:
         System.out.println(changedFile.toString());
   }
diff --git a/src/main/java/nschultz/watcher/core/ChangedFile.java b/src/main/java/nschultz/watcher/core/ChangedFile.java
@@ -60,7 +60,7 @@ public class ChangedFile {
      *
      * @return the time of change
      */
-    public final Date when() {
+    public final Date getChangeTime() {
         return changeTime;
     }
 
@@ -70,8 +70,8 @@ public final Date when() {
      *
      * @return the time when this file was changed
      */
-    public final String whenAsString() {
-        return whenAsString("yyyy-MM-dd HH:mm:ss");
+    public final String getChangeTimeFormatted() {
+        return getChangeTimeFormatted("yyyy-MM-dd HH:mm:ss");
     }
 
     /**
@@ -80,7 +80,7 @@ public final String whenAsString() {
      * @param format the way the time will be formatted before it gets returned
      * @return the time when this file was changed
      */
-    public final String whenAsString(final String format) {
+    public final String getChangeTimeFormatted(final String format) {
         return new SimpleDateFormat(format).format(changeTime);
     }
 
diff --git a/src/main/java/nschultz/watcher/core/DirectoryWatchable.java b/src/main/java/nschultz/watcher/core/DirectoryWatchable.java
@@ -50,7 +50,7 @@ public interface DirectoryWatchable {
      * the set error stream.
      *
      * @param ex an instance of the {@code {@link IOException}} that occurred
-     *           while trying to watch the director for changes
+     *           while trying to watch the directory for changes
      */
     default void failed(IOException ex) {
         ex.printStackTrace(System.err);

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class Example implements DirectoryWatchable {`
`20`	`20`	`// what file is the event referring to:`
`21`	`21`	`System.out.println(changedFile.getAbsolutePath());`
`22`	`22`	`// when did it happen:`
`23`		`- System.out.println(changedFile.whenAsString());`
	`23`	`+ System.out.println(changedFile.getChangeTime());`
`24`	`24`	`// you could also call the toString method to get all of the information above:`
`25`	`25`	`System.out.println(changedFile.toString());`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public class ChangedFile {`
`60`	`60`	`*`
`61`	`61`	`* @return the time of change`
`62`	`62`	`*/`
`63`		`- public final Date when() {`
	`63`	`+ public final Date getChangeTime() {`
`64`	`64`	`return changeTime;`
`65`	`65`	`}`
`66`	`66`
`@@ -70,8 +70,8 @@ public final Date when() {`
`70`	`70`	`*`
`71`	`71`	`* @return the time when this file was changed`
`72`	`72`	`*/`
`73`		`- public final String whenAsString() {`
`74`		`- return whenAsString("yyyy-MM-dd HH:mm:ss");`
	`73`	`+ public final String getChangeTimeFormatted() {`
	`74`	`+ return getChangeTimeFormatted("yyyy-MM-dd HH:mm:ss");`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`/**`
`@@ -80,7 +80,7 @@ public final String whenAsString() {`
`80`	`80`	`* @param format the way the time will be formatted before it gets returned`
`81`	`81`	`* @return the time when this file was changed`
`82`	`82`	`*/`
`83`		`- public final String whenAsString(final String format) {`
	`83`	`+ public final String getChangeTimeFormatted(final String format) {`
`84`	`84`	`return new SimpleDateFormat(format).format(changeTime);`
`85`	`85`	`}`
`86`	`86`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public interface DirectoryWatchable {`
`50`	`50`	`* the set error stream.`
`51`	`51`	`*`
`52`	`52`	`* @param ex an instance of the {@code {@link IOException}} that occurred`
`53`		`- * while trying to watch the director for changes`
	`53`	`+ * while trying to watch the directory for changes`
`54`	`54`	`*/`
`55`	`55`	`default void failed(IOException ex) {`
`56`	`56`	`ex.printStackTrace(System.err);`