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/03 16:19:55 UTC
incubator-tamaya git commit: TAMAYA-72 Started to add documentation
for the Joda-Time support module.
Repository: incubator-tamaya
Updated Branches:
refs/heads/master e687e2b6a -> 5d61215c6
TAMAYA-72 Started to add documentation for the Joda-Time support module.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/5d61215c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/5d61215c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/5d61215c
Branch: refs/heads/master
Commit: 5d61215c6cc8ffc88ba062f5c96d659a946f5235
Parents: e687e2b
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Fri Apr 3 16:19:32 2015 +0200
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Fri Apr 3 16:19:32 2015 +0200
----------------------------------------------------------------------
docs/mod_jodatime.adoc | 89 +++++++++++++++++++++++++++++++++++++++++++++
docs/modules.adoc | 6 ++-
2 files changed, 94 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/5d61215c/docs/mod_jodatime.adoc
----------------------------------------------------------------------
diff --git a/docs/mod_jodatime.adoc b/docs/mod_jodatime.adoc
new file mode 100644
index 0000000..38deae2
--- /dev/null
+++ b/docs/mod_jodatime.adoc
@@ -0,0 +1,89 @@
+= Apache Tamaya -- Extension: JodaTime
+
+:name: Tamaya
+:rootpackage: org.apache.tamaya.ext.jodatime
+:title: Apache Tamaya Extension: JodaTime
+:revnumber: 0.1.1
+:revremark: Incubator
+:revdate: April 2015
+:longversion: {revnumber} ({revremark}) {revdate}
+:authorinitials: OBF
+:author: Oliver B. Fischer
+:email: <pl...@apache.org>
+:source-highlighter: coderay
+:website: http://tamaya.incubator.apache.org/
+:iconsdir: {imagesdir}/icons
+:toc:
+:toc-placement: manual
+:icons:
+:encoding: UTF-8
+:numbered:
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+'''
+
+<<<
+
+toc::[]
+
+<<<
+:numbered!:
+<<<
+[[Core]]
+== Tamaya JodaTime (Extension Module)
+
+=== Overview
+
+Tamaya JodaTime is an extension module to support the usage of http://www.joda.org/joda-time/[Joda-Time]
+in conjunction with Tamaya. Tamaya JodaTime defines some additional property
+converters to retrieve Joda-Time types from a given configuration.
+
+Refer to the link:modules.html[extensions documentation] for further details
+about modules.
+
+tools to locate resources in your classpath or file system based on descriptive
+ant-styled resource patterns. To use this module add the following dependency:
+
+[source, listing]
+-----------------------------------------------
+<dependency>
+ <grooupId>org.apache.tamaya.ext</groupId>
+ <artifactId>tamaya-jodatime</artifactId>
+ <version>CURRENT_VERSION</version>
+</dependency>
+-----------------------------------------------
+
+After adding this dependency to your project you can retrieve
+Joda-Time based values directly from a given configuration.
+
+[source,java]
+-----------------------------------------------
+Configuration configuration = ConfigurationProvider.getConfiguration();
+
+DateTime pit = configuration.get("pointInTime", DateTime.class)
+-----------------------------------------------
+
+=== Specifying date and time values
+
+To be written.
+
+=== Specifing periods and durations
+
+To be written.
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/5d61215c/docs/modules.adoc
----------------------------------------------------------------------
diff --git a/docs/modules.adoc b/docs/modules.adoc
index 1f52d9f..e8e58a5 100644
--- a/docs/modules.adoc
+++ b/docs/modules.adoc
@@ -55,4 +55,8 @@ N/A
== Extensions in Experimental Stage
-tbd
\ No newline at end of file
+[width="100%",frame="1",options="header",grid="all"]
+|=======
+|_Artifact_ |_Description_ |_Links_
+|+org.apache.tamaya.ext:tamaya-jodatime+ |Provides support for JodaTime. | link:mod_jodatime.html[Documentation]
+|=======