You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by st...@apache.org on 2018/04/04 10:34:10 UTC

deltaspike git commit: DELTASPIKE-1325 add documentation

Repository: deltaspike
Updated Branches:
  refs/heads/master 06e9a160f -> 1e5003f92


DELTASPIKE-1325 add documentation


Project: http://git-wip-us.apache.org/repos/asf/deltaspike/repo
Commit: http://git-wip-us.apache.org/repos/asf/deltaspike/commit/1e5003f9
Tree: http://git-wip-us.apache.org/repos/asf/deltaspike/tree/1e5003f9
Diff: http://git-wip-us.apache.org/repos/asf/deltaspike/diff/1e5003f9

Branch: refs/heads/master
Commit: 1e5003f92816ad6a55e57c81de9c0b2a1f9fe092
Parents: 06e9a16
Author: Mark Struberg <st...@apache.org>
Authored: Wed Apr 4 12:33:41 2018 +0200
Committer: Mark Struberg <st...@apache.org>
Committed: Wed Apr 4 12:33:41 2018 +0200

----------------------------------------------------------------------
 .../org/apache/deltaspike/core/api/config/ConfigResolver.java    | 4 +++-
 .../java/org/apache/deltaspike/core/spi/config/ConfigSource.java | 3 +++
 2 files changed, 6 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/deltaspike/blob/1e5003f9/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java
index 23cdd2f..1d92163 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/ConfigResolver.java
@@ -408,6 +408,9 @@ public final class ConfigResolver
 
     /**
      * A very simple interface for conversion of configuration values from String to any Java type.
+     *
+     * <p>If a Converter implements the {@link java.lang.AutoCloseable} interface it will automatically
+     * be released when the Config is shut down.</p>
      * @param <T> The target type of the configuration entry
      */
     public interface Converter<T>
@@ -419,7 +422,6 @@ public final class ConfigResolver
          * @return Converted value
          */
         T convert(String value);
-
     }
 
     /**

http://git-wip-us.apache.org/repos/asf/deltaspike/blob/1e5003f9/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/ConfigSource.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/ConfigSource.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/ConfigSource.java
index 10fe39d..bd18772 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/ConfigSource.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/ConfigSource.java
@@ -34,6 +34,9 @@ import java.util.function.Consumer;
  * <i>META-INF/services/org.apache.deltaspike.core.spi.config.ConfigSource</i>
  * file and adding the fully qualified class name of your ConfigSource
  * implementation into it. </p>
+ *
+ * <p>If a ConfigSource implements the {@link java.lang.AutoCloseable} interface it will automatically
+ * be released when the Config is shut down.</p>
  */
 public interface ConfigSource
 {