[wicket] 08/15: Added Javadocs

[ad...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

adelbene pushed a commit to branch WICKET-6662
in repository https://gitbox.apache.org/repos/asf/wicket.git

commit 99b1a9874c10956e6cf1202243c4b48e6ac9403f
Author: Andrea Del Bene <ad...@apache.org>
AuthorDate: Sun Apr 28 17:03:29 2019 +0200

    Added Javadocs
---
 .../main/java/org/apache/wicket/util/time/Durations.java  | 11 +++++++++++
 .../main/java/org/apache/wicket/util/time/Instants.java   | 15 +++++++++++++--
 2 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/wicket-util/src/main/java/org/apache/wicket/util/time/Durations.java b/wicket-util/src/main/java/org/apache/wicket/util/time/Durations.java
index e8fc15d..53fa703 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/time/Durations.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/time/Durations.java
@@ -22,6 +22,11 @@ import java.util.Locale;
 
 import org.apache.wicket.util.string.StringValue;
 
+/**
+ * 
+ * Utility class for {@link Duration}
+ *
+ */
 public class Durations
 {
 
@@ -73,6 +78,12 @@ public class Durations
 		return StringValue.valueOf(value, locale) + " " + units + ((value > 1.0) ? "s" : "");
 	}
 
+	/**
+	 * Calculates the duration between a given {@link Instant} and the current one.
+	 * @param start 
+	 * 			a given instant
+	 * @return the duration between a given Instant and the current one
+	 */
 	public static Duration elapsedSince(Instant start)
 	{
 	    return Duration.between(start, Instant.now());
diff --git a/wicket-util/src/main/java/org/apache/wicket/util/time/Instants.java b/wicket-util/src/main/java/org/apache/wicket/util/time/Instants.java
index e17f228..23bbe90 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/time/Instants.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/time/Instants.java
@@ -21,17 +21,28 @@ import java.time.ZoneId;
 import java.time.format.DateTimeFormatter;
 import java.util.Locale;
 
+/**
+ * 
+ * Utility class for {@link Instant}
+ *
+ */
 public class Instants
 {
 
-	public static final DateTimeFormatter RFC7231Formatter = DateTimeFormatter
+	public static final DateTimeFormatter RFC7231DateFormatter = DateTimeFormatter
 		.ofPattern("EEE, dd MMM yyyy HH:mm:ss O").withZone(ZoneId.of("UTC"));
 
 	public static final DateTimeFormatter localDateFormatter = DateTimeFormatter
 		.ofPattern("yyyy.MM.dd", Locale.ENGLISH);
 
+	/**
+	 * Formats a given {@link Instant} as required by RFC7231 for dates.
+	 * 
+	 * @param instant
+	 * @return the instant properly formatted
+	 */
 	public static String toRFC7231Format(final Instant instant)
 	{
-		return RFC7231Formatter.format(instant);
+		return RFC7231DateFormatter.format(instant);
 	}
 }