You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by an...@apache.org on 2015/01/24 21:06:39 UTC

[9/9] incubator-tamaya git commit: TAMAYA-8: Added javadocs. TAMAYA-62: Adaptions in modules.

TAMAYA-8: Added javadocs.
TAMAYA-62: Adaptions in modules.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/4929d3cd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/4929d3cd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/4929d3cd

Branch: refs/heads/master
Commit: 4929d3cd29171b7417cc58f1c27e5bfb4e388697
Parents: 2f2dbd1
Author: anatole <an...@apache.org>
Authored: Sat Jan 24 21:05:45 2015 +0100
Committer: anatole <an...@apache.org>
Committed: Sat Jan 24 21:06:19 2015 +0100

----------------------------------------------------------------------
 .../org/apache/tamaya/inject/DynamicValue.java  |  1 +
 .../tamaya/modules/json/FileBasedResource.java  |  3 +++
 .../tamaya/modules/json/InputResource.java      |  3 +++
 .../tamaya/modules/json/JSONPropertySource.java |  3 +++
 .../apache/tamaya/modules/json/JSONVisitor.java |  6 +++++
 .../JSONPropertySourceConfigurationTest.java    | 10 ++++----
 .../resolver/internal/ConfigResolver.java       |  1 -
 .../tamaya/resolver/ConfigResolutionTest.java   | 24 ++++++++++----------
 8 files changed, 33 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4929d3cd/modules/injection/src/main/java/org/apache/tamaya/inject/DynamicValue.java
----------------------------------------------------------------------
diff --git a/modules/injection/src/main/java/org/apache/tamaya/inject/DynamicValue.java b/modules/injection/src/main/java/org/apache/tamaya/inject/DynamicValue.java
index 95dd6a6..6075666 100644
--- a/modules/injection/src/main/java/org/apache/tamaya/inject/DynamicValue.java
+++ b/modules/injection/src/main/java/org/apache/tamaya/inject/DynamicValue.java
@@ -47,6 +47,7 @@ import java.util.logging.Logger;
  *     <li>Serializable, when also the item stored is serializable</li>
  *     <li>Thread safe</li>
  * </ul>
+ * @param <T> The type of the value.
  */
 public final class DynamicValue<T> implements Serializable {
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4929d3cd/modules/json/src/main/java/org/apache/tamaya/modules/json/FileBasedResource.java
----------------------------------------------------------------------
diff --git a/modules/json/src/main/java/org/apache/tamaya/modules/json/FileBasedResource.java b/modules/json/src/main/java/org/apache/tamaya/modules/json/FileBasedResource.java
index 38dfcaa..6684145 100644
--- a/modules/json/src/main/java/org/apache/tamaya/modules/json/FileBasedResource.java
+++ b/modules/json/src/main/java/org/apache/tamaya/modules/json/FileBasedResource.java
@@ -25,6 +25,9 @@ import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 
+/**
+ * Implements an InputResource based on a file.
+ */
 public class FileBasedResource implements InputResource {
     private final File sourceFile;
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4929d3cd/modules/json/src/main/java/org/apache/tamaya/modules/json/InputResource.java
----------------------------------------------------------------------
diff --git a/modules/json/src/main/java/org/apache/tamaya/modules/json/InputResource.java b/modules/json/src/main/java/org/apache/tamaya/modules/json/InputResource.java
index 2138c47..46bfa0c 100644
--- a/modules/json/src/main/java/org/apache/tamaya/modules/json/InputResource.java
+++ b/modules/json/src/main/java/org/apache/tamaya/modules/json/InputResource.java
@@ -20,6 +20,9 @@ package org.apache.tamaya.modules.json;
 
 import java.io.InputStream;
 
+/**
+ * Simple Resource Abstraction.
+ */
 public interface InputResource {
     InputStream getInputStream();
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4929d3cd/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONPropertySource.java
----------------------------------------------------------------------
diff --git a/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONPropertySource.java b/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONPropertySource.java
index 3daa9e2..f18f138 100644
--- a/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONPropertySource.java
+++ b/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONPropertySource.java
@@ -36,6 +36,9 @@ import java.util.concurrent.locks.StampedLock;
 
 import static java.lang.String.format;
 
+/**
+ * Property source based on a JSON file.
+ */
 public class JSONPropertySource
     implements PropertySource {
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4929d3cd/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONVisitor.java
----------------------------------------------------------------------
diff --git a/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONVisitor.java b/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONVisitor.java
index f52afbf..25b6be3 100644
--- a/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONVisitor.java
+++ b/modules/json/src/main/java/org/apache/tamaya/modules/json/JSONVisitor.java
@@ -25,6 +25,9 @@ import org.apache.tamaya.ConfigException;
 
 import java.util.*;
 
+/**
+ * Visitor implementation to read a JSON formatted input source.
+ */
 public class JSONVisitor {
     private final ObjectNode rootNode;
     private final HashMap<String, String> targetStore;
@@ -66,6 +69,9 @@ public class JSONVisitor {
         }
     }
 
+    /**
+     * Context for a sub context visited.
+     */
     private static class VisitingContext {
         private String namespace;
         private final ObjectNode node;

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4929d3cd/modules/json/src/test/java/org/apache/tamaya/modules/json/JSONPropertySourceConfigurationTest.java
----------------------------------------------------------------------
diff --git a/modules/json/src/test/java/org/apache/tamaya/modules/json/JSONPropertySourceConfigurationTest.java b/modules/json/src/test/java/org/apache/tamaya/modules/json/JSONPropertySourceConfigurationTest.java
index 5d77489..1dd20d7 100644
--- a/modules/json/src/test/java/org/apache/tamaya/modules/json/JSONPropertySourceConfigurationTest.java
+++ b/modules/json/src/test/java/org/apache/tamaya/modules/json/JSONPropertySourceConfigurationTest.java
@@ -18,6 +18,7 @@
  */
 package org.apache.tamaya.modules.json;
 
+import org.apache.tamaya.ConfigurationProvider;
 import org.apache.tamaya.spi.ConfigurationContext;
 import org.hamcrest.CoreMatchers;
 import org.junit.Test;
@@ -28,6 +29,9 @@ import java.net.URL;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.hasSize;
 
+/**
+ * Tests for {@link org.apache.tamaya.modules.json.JSONPropertySource}.
+ */
 public class JSONPropertySourceConfigurationTest {
 
 
@@ -36,15 +40,11 @@ public class JSONPropertySourceConfigurationTest {
         URL configURL = JSONPropertySourceTest.class.getResource("/configs/valid/simple-flat-string-only-config.json");
 
         assertThat(configURL, CoreMatchers.notNullValue());
-
         File configFile = new File(configURL.toURI());
-
         JSONPropertySource source = new JSONPropertySource(configFile, 10);
-
         assertThat(source.getProperties().keySet(), hasSize(3));
 
-        ConfigurationContext context = ConfigurationContext.context();
-
+        ConfigurationContext context = ConfigurationProvider.getConfigurationContext();
         context.addPropertySources(source);
 
         // @todo Finish!

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4929d3cd/modules/resolver/src/main/java/org/apache/tamaya/resolver/internal/ConfigResolver.java
----------------------------------------------------------------------
diff --git a/modules/resolver/src/main/java/org/apache/tamaya/resolver/internal/ConfigResolver.java b/modules/resolver/src/main/java/org/apache/tamaya/resolver/internal/ConfigResolver.java
index bdabc28..4708a39 100644
--- a/modules/resolver/src/main/java/org/apache/tamaya/resolver/internal/ConfigResolver.java
+++ b/modules/resolver/src/main/java/org/apache/tamaya/resolver/internal/ConfigResolver.java
@@ -18,7 +18,6 @@
  */
 package org.apache.tamaya.resolver.internal;
 
-import org.apache.tamaya.Configuration;
 import org.apache.tamaya.ConfigurationProvider;
 import org.apache.tamaya.resolver.spi.ExpressionResolver;
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4929d3cd/modules/resolver/src/test/java/org/apache/tamaya/resolver/ConfigResolutionTest.java
----------------------------------------------------------------------
diff --git a/modules/resolver/src/test/java/org/apache/tamaya/resolver/ConfigResolutionTest.java b/modules/resolver/src/test/java/org/apache/tamaya/resolver/ConfigResolutionTest.java
index 23fc42b..7e3db08 100644
--- a/modules/resolver/src/test/java/org/apache/tamaya/resolver/ConfigResolutionTest.java
+++ b/modules/resolver/src/test/java/org/apache/tamaya/resolver/ConfigResolutionTest.java
@@ -18,7 +18,7 @@
  */
 package org.apache.tamaya.resolver;
 
-import org.apache.tamaya.Configuration;
+import org.apache.tamaya.ConfigurationProvider;
 import org.junit.Test;
 
 import static org.junit.Assert.assertEquals;
@@ -33,57 +33,57 @@ public class ConfigResolutionTest {
 
     @Test
     public void test_Prefix_Resolution() {
-        assertEquals(Configuration.current().get("Before Text (prefixed)"), "My Java version is " + System.getProperty("java.version"));
+        assertEquals(ConfigurationProvider.getConfiguration().get("Before Text (prefixed)"), "My Java version is " + System.getProperty("java.version"));
     }
 
     @Test
     public void test_Midfix_Resolution() {
-        assertEquals(Configuration.current().get("Before and After Text (prefixed)"), "My Java version is " + System.getProperty("java.version") + ".");
+        assertEquals(ConfigurationProvider.getConfiguration().get("Before and After Text (prefixed)"), "My Java version is " + System.getProperty("java.version") + ".");
     }
 
     @Test
     public void test_Prefix_ExpressionOnly_Resolution() {
-        assertEquals(Configuration.current().get("Expression Only"), System.getProperty("java.version"));
+        assertEquals(ConfigurationProvider.getConfiguration().get("Expression Only"), System.getProperty("java.version"));
     }
 
     @Test
     public void testConfig_Refs() {
-        assertEquals(Configuration.current().get("config-ref"), "Expression Only -> " + System.getProperty("java.version"));
-        assertEquals(Configuration.current().get("config-ref3"), "Config Ref 3 -> Ref 2: Config Ref 2 -> Ref 1: Expression Only -> " + System.getProperty("java.version"));
-        assertEquals(Configuration.current().get("config-ref2"), "Config Ref 2 -> Ref 1: Expression Only -> " + System.getProperty("java.version"));
+        assertEquals(ConfigurationProvider.getConfiguration().get("config-ref"), "Expression Only -> " + System.getProperty("java.version"));
+        assertEquals(ConfigurationProvider.getConfiguration().get("config-ref3"), "Config Ref 3 -> Ref 2: Config Ref 2 -> Ref 1: Expression Only -> " + System.getProperty("java.version"));
+        assertEquals(ConfigurationProvider.getConfiguration().get("config-ref2"), "Config Ref 2 -> Ref 1: Expression Only -> " + System.getProperty("java.version"));
     }
 
     @Test
     public void testClasspath_Refs() {
-        String value = Configuration.current().get("cp-ref");
+        String value = ConfigurationProvider.getConfiguration().get("cp-ref");
         assertNotNull(value);
         assertTrue(value.contains("This content comes from Testresource.txt!"));
     }
 
     @Test
     public void testResource_Refs() {
-        String value = Configuration.current().get("res-ref");
+        String value = ConfigurationProvider.getConfiguration().get("res-ref");
         assertNotNull(value);
         assertTrue(value.contains("This content comes from Testresource.txt!"));
     }
 
     @Test
     public void testFile_Refs() {
-        String value = Configuration.current().get("file-ref");
+        String value = ConfigurationProvider.getConfiguration().get("file-ref");
         assertNotNull(value);
         assertTrue(value.contains("This content comes from Testresource2.txt!"));
     }
 
     @Test
     public void testURL_Refs() {
-        String value = Configuration.current().get("url-ref");
+        String value = ConfigurationProvider.getConfiguration().get("url-ref");
         assertNotNull(value);
         assertTrue(value.contains("doctype html"));
     }
 
     @Test
     public void testEscaping(){
-        assertEquals(Configuration.current().get("escaped"),
+        assertEquals(ConfigurationProvider.getConfiguration().get("escaped"),
                 "Config Ref 3 -> Ref 2: \\${conf:config-ref2 will not be evaluated and will not contain\\t tabs \\n " +
                 "newlines or \\r returns...YEP!");
     }