Repository: incubator-tamaya-sandbox Updated Branches: refs/heads/master aa371660c -> cac421bda
Fix javadocs issues Addresses TAMAYA-154 Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/commit/cac421bd Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/tree/cac421bd Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/diff/cac421bd Branch: refs/heads/master Commit: cac421bda9aafc28e8171c8a3d2eb581586e5a13 Parents: aa37166 Author: Aaron Coburn <[email protected]> Authored: Mon Apr 30 08:52:02 2018 -0400 Committer: Phil Ottlinger <[email protected]> Committed: Mon Apr 30 22:38:03 2018 +0200 ---------------------------------------------------------------------- .../org/apache/tamaya/hazelcast/HazelcastPropertySource.java | 4 ++-- .../src/main/java/org/apache/tamaya/metamodel/MetaContext.java | 3 ++- .../apache/tamaya/metamodel/ext/RefreshablePropertySource.java | 4 ++-- .../org/apache/tamaya/metamodel/internal/ComponentFactory.java | 2 ++ 4 files changed, 8 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/blob/cac421bd/hazelcast/src/main/java/org/apache/tamaya/hazelcast/HazelcastPropertySource.java ---------------------------------------------------------------------- diff --git a/hazelcast/src/main/java/org/apache/tamaya/hazelcast/HazelcastPropertySource.java b/hazelcast/src/main/java/org/apache/tamaya/hazelcast/HazelcastPropertySource.java index 9f63a0e..7821651 100644 --- a/hazelcast/src/main/java/org/apache/tamaya/hazelcast/HazelcastPropertySource.java +++ b/hazelcast/src/main/java/org/apache/tamaya/hazelcast/HazelcastPropertySource.java @@ -108,8 +108,8 @@ implements MutablePropertySource{ /** * Creates a new instance, hereby using the given property source name and the * hazelcast instance. - * @param name - * @param hazelcastInstance + * @param name the property source name, not null. + * @param hazelcastInstance the hazelcast instance, not null. */ public HazelcastPropertySource(String name, HazelcastInstance hazelcastInstance){ super(name); http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/blob/cac421bd/metamodel/src/main/java/org/apache/tamaya/metamodel/MetaContext.java ---------------------------------------------------------------------- diff --git a/metamodel/src/main/java/org/apache/tamaya/metamodel/MetaContext.java b/metamodel/src/main/java/org/apache/tamaya/metamodel/MetaContext.java index c890148..737f707 100644 --- a/metamodel/src/main/java/org/apache/tamaya/metamodel/MetaContext.java +++ b/metamodel/src/main/java/org/apache/tamaya/metamodel/MetaContext.java @@ -55,7 +55,7 @@ public final class MetaContext { /** * Get the context's id. - * @return + * @return the context's id */ public String getId() { return getProperty("_id", "N/A"); @@ -97,6 +97,7 @@ public final class MetaContext { /** * Combine this context with the other contexts given. + * @param baseContext the base context with which the other contexts will be merged * @param contexts the context to merge with this context. * @return the newly created Context. */ http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/blob/cac421bd/metamodel/src/main/java/org/apache/tamaya/metamodel/ext/RefreshablePropertySource.java ---------------------------------------------------------------------- diff --git a/metamodel/src/main/java/org/apache/tamaya/metamodel/ext/RefreshablePropertySource.java b/metamodel/src/main/java/org/apache/tamaya/metamodel/ext/RefreshablePropertySource.java index efd046d..eb2b8d3 100644 --- a/metamodel/src/main/java/org/apache/tamaya/metamodel/ext/RefreshablePropertySource.java +++ b/metamodel/src/main/java/org/apache/tamaya/metamodel/ext/RefreshablePropertySource.java @@ -93,8 +93,8 @@ public final class RefreshablePropertySource /** * Set the refresh period. This will be immediately applied from now. No explicit * refresh will be triggered now. - * @param units - * @param timeUnit + * @param units the time duration in the given timeUnit + * @param timeUnit the unit of measurement for the units argument */ public void setRefreshPeriod(long units, TimeUnit timeUnit){ this.refreshPeriod.set(timeUnit.toMillis(units)); http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/blob/cac421bd/metamodel/src/main/java/org/apache/tamaya/metamodel/internal/ComponentFactory.java ---------------------------------------------------------------------- diff --git a/metamodel/src/main/java/org/apache/tamaya/metamodel/internal/ComponentFactory.java b/metamodel/src/main/java/org/apache/tamaya/metamodel/internal/ComponentFactory.java index 906b704..e51fbde 100644 --- a/metamodel/src/main/java/org/apache/tamaya/metamodel/internal/ComponentFactory.java +++ b/metamodel/src/main/java/org/apache/tamaya/metamodel/internal/ComponentFactory.java @@ -62,6 +62,8 @@ public final class ComponentFactory<T> { * </ul> * @param identifier the configured type * @return the component found, or null. + * @throws IllegalAccessException if the given type lacks a publicly accessible constructor + * @throws InstantiationException if the given type lacks a nullary constructor */ public T getComponent(String identifier) throws IllegalAccessException, InstantiationException {
