tamaya-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pottlin...@apache.org
Subject incubator-tamaya-extensions git commit: Fix javadoc warnings
Date Mon, 30 Apr 2018 20:27:02 GMT
Repository: incubator-tamaya-extensions
Updated Branches:
  refs/heads/master ce09622b4 -> 339bab3bf


Fix javadoc warnings

Addresses TAMAYA-154

This adds some missing javadoc parameters.


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

Branch: refs/heads/master
Commit: 339bab3bf7f8f6fe3ae992125064ea3346bfc2ad
Parents: ce09622
Author: Aaron Coburn <acoburn@apache.org>
Authored: Mon Apr 30 12:05:29 2018 -0400
Committer: Aaron Coburn <acoburn@apache.org>
Committed: Mon Apr 30 12:05:29 2018 -0400

----------------------------------------------------------------------
 .../src/main/java/org/apache/tamaya/features/Features.java        | 1 +
 .../main/java/org/apache/tamaya/format/ConfigurationFormat.java   | 1 +
 .../main/java/org/apache/tamaya/format/ConfigurationFormats.java  | 1 +
 .../src/main/java/org/apache/tamaya/json/JSONPropertySource.java  | 3 +++
 .../src/main/java/org/apache/tamaya/osgi/ConfigHistory.java       | 2 +-
 5 files changed, 7 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/339bab3b/modules/features/src/main/java/org/apache/tamaya/features/Features.java
----------------------------------------------------------------------
diff --git a/modules/features/src/main/java/org/apache/tamaya/features/Features.java b/modules/features/src/main/java/org/apache/tamaya/features/Features.java
index 32834fa..fffdf8b 100644
--- a/modules/features/src/main/java/org/apache/tamaya/features/Features.java
+++ b/modules/features/src/main/java/org/apache/tamaya/features/Features.java
@@ -175,6 +175,7 @@ public final class Features {
     /**
      * Checks if the given class canm be loaded, using {@code Class.forName(classname)}.
      * @param classname the fully qualified classname.
+     * @param classLoader class loader from which the class must be loaded.
      * @return true, if the given class canm be loaded.
      */
     public static boolean checkClassIsLoadable(String classname, ClassLoader classLoader)
{

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/339bab3b/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormat.java
----------------------------------------------------------------------
diff --git a/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormat.java
b/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormat.java
index e8e48a2..79c0bf9 100644
--- a/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormat.java
+++ b/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormat.java
@@ -95,6 +95,7 @@ public interface ConfigurationFormat {
      * @param resource the resource id, not null.
      * @return the corresponding {@link ConfigurationData} containing sections/properties
read, never {@code null}.
      * @throws org.apache.tamaya.ConfigException if parsing of the input fails.
+     * @throws IOException if reading the input fails.
      */
     ConfigurationData readConfiguration(String resource, InputStream inputStream) throws
IOException;
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/339bab3b/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormats.java
----------------------------------------------------------------------
diff --git a/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormats.java
b/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormats.java
index f08e967..3ec6c01 100644
--- a/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormats.java
+++ b/modules/formats/base/src/main/java/org/apache/tamaya/format/ConfigurationFormats.java
@@ -200,6 +200,7 @@ public final class ConfigurationFormats {
      * @param formats     the formats to try.
      * @return the ConfigurationData read, or null.
      * @throws ConfigException if the resource cannot be read.
+     * @throws IOException if reading the input fails.
      */
     public static ConfigurationData readConfigurationData(String resource, InputStream inputStream,
                                                           Collection<ConfigurationFormat>
formats) throws IOException {

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/339bab3b/modules/formats/json/src/main/java/org/apache/tamaya/json/JSONPropertySource.java
----------------------------------------------------------------------
diff --git a/modules/formats/json/src/main/java/org/apache/tamaya/json/JSONPropertySource.java
b/modules/formats/json/src/main/java/org/apache/tamaya/json/JSONPropertySource.java
index 5934210..50f82a2 100644
--- a/modules/formats/json/src/main/java/org/apache/tamaya/json/JSONPropertySource.java
+++ b/modules/formats/json/src/main/java/org/apache/tamaya/json/JSONPropertySource.java
@@ -66,6 +66,7 @@ public class JSONPropertySource implements PropertySource {
     /**
      * Constructor, hereby using 0 as the default ordinal.
      * @param resource the resource modelled as URL, not null.
+     * @throws IOException if reading the resource fails.
      */
     public JSONPropertySource(URL resource)throws IOException {
         this(resource, 0);
@@ -75,6 +76,7 @@ public class JSONPropertySource implements PropertySource {
      * Constructor.
      * @param resource the resource modelled as URL, not null.
      * @param defaultOrdinal the defaultOrdinal to be used.
+     * @throws IOException if reading the resource fails.
      */
     public JSONPropertySource(URL resource, int defaultOrdinal)throws IOException {
         urlResource = Objects.requireNonNull(resource);
@@ -123,6 +125,7 @@ public class JSONPropertySource implements PropertySource {
      * @param urlResource soure of the configuration.
      * @return the configuration read from the given resource URL.
      * @throws ConfigException if resource URL cannot be read.
+     * @throws IOException if reading the urlResource fails.
      */
     protected Map<String, PropertyValue> readConfig(URL urlResource) throws IOException{
         try (InputStream is = urlResource.openStream()) {

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-extensions/blob/339bab3b/modules/osgi/common/src/main/java/org/apache/tamaya/osgi/ConfigHistory.java
----------------------------------------------------------------------
diff --git a/modules/osgi/common/src/main/java/org/apache/tamaya/osgi/ConfigHistory.java b/modules/osgi/common/src/main/java/org/apache/tamaya/osgi/ConfigHistory.java
index e988a42..81d2534 100644
--- a/modules/osgi/common/src/main/java/org/apache/tamaya/osgi/ConfigHistory.java
+++ b/modules/osgi/common/src/main/java/org/apache/tamaya/osgi/ConfigHistory.java
@@ -162,7 +162,7 @@ public final class ConfigHistory implements Serializable{
     /**
      * Get the history for a PID.
      * @param pid the pid, null returns the full history.
-     * @return
+     * @return the history, never null.
      */
     public static List<ConfigHistory> getHistory(String pid) {
         if(pid==null || pid.isEmpty()){


Mime
View raw message