You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by pl...@apache.org on 2015/04/13 21:21:09 UTC
[5/6] incubator-tamaya git commit: TAMAYA-72 Added JavaDoc
TAMAYA-72 Added JavaDoc
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/7b55b5c5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/7b55b5c5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/7b55b5c5
Branch: refs/heads/master
Commit: 7b55b5c54f9e793b2d865aa99925499de279815d
Parents: e208507
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Mon Apr 6 20:24:47 2015 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Mon Apr 6 20:24:47 2015 +0200
----------------------------------------------------------------------
.../apache/tamaya/jodatime/DateTimeConverter.java | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/7b55b5c5/sandbox/jodatime/src/main/java/org/apache/tamaya/jodatime/DateTimeConverter.java
----------------------------------------------------------------------
diff --git a/sandbox/jodatime/src/main/java/org/apache/tamaya/jodatime/DateTimeConverter.java b/sandbox/jodatime/src/main/java/org/apache/tamaya/jodatime/DateTimeConverter.java
index 03c28e5..6912108 100644
--- a/sandbox/jodatime/src/main/java/org/apache/tamaya/jodatime/DateTimeConverter.java
+++ b/sandbox/jodatime/src/main/java/org/apache/tamaya/jodatime/DateTimeConverter.java
@@ -27,6 +27,24 @@ import org.joda.time.format.DateTimeParser;
import java.util.Objects;
+/**
+ * Converter, converting from {@code String} to Joda-Time's
+ * {@code DateTime}.
+ *
+ * The converter supports the following formats for the provided
+ * time information:
+ *
+ * <ul>
+ * <li>{@code yyyy-MM-dd'T'HH:mm:ss.SSSZ}</li>
+ * <li>{@code yyyy-MM-dd'T'HH:mm:ss.SSSz}</li>
+ * <li>{@code yyyy-MM-dd'T'HH:mm:ssZ}</li>
+ * <li>{@code yyyy-MM-dd'T'HH:mm:ssz}</li>
+ * <li>{@code yyyy-MM-dd'T'HH:mmZ}</li>
+ * <li>{@code yyyy-MM-dd'T'HH:mmz}</li>
+ * <li>{@code yyyy-MM-dd'T'HHZ}</li>
+ * <li>{@code yyyy-MM-dd'T'HHz}</li>
+ * </ul>
+ */
public class DateTimeConverter implements PropertyConverter<DateTime> {
// The DateTimeFormatter returned by ISODateTimeFormat are thread safe
// according to the JavaDoc of JodaTime