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 2016/09/25 21:35:48 UTC
[08/23] incubator-tamaya-sandbox git commit: Fixed all Javadoc
problems for now...
Fixed all Javadoc problems for now...
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/f4f89d37
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/tree/f4f89d37
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/diff/f4f89d37
Branch: refs/heads/master
Commit: f4f89d370c76c9b0b59f352a088154dcee935e66
Parents: 03a58b6
Author: Oliver B. Fischer <pl...@apache.org>
Authored: Fri Jan 1 23:58:57 2016 +0100
Committer: Oliver B. Fischer <pl...@apache.org>
Committed: Fri Jan 1 23:58:57 2016 +0100
----------------------------------------------------------------------
.../clsupport/AbstractClassloaderAwareItemLoader.java | 13 +++++++------
.../tamaya/clsupport/CLAwareServiceContext.java | 14 ++++++++------
2 files changed, 15 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/blob/f4f89d37/src/main/java/org/apache/tamaya/clsupport/AbstractClassloaderAwareItemLoader.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/tamaya/clsupport/AbstractClassloaderAwareItemLoader.java b/src/main/java/org/apache/tamaya/clsupport/AbstractClassloaderAwareItemLoader.java
index 0c90653..775d778 100644
--- a/src/main/java/org/apache/tamaya/clsupport/AbstractClassloaderAwareItemLoader.java
+++ b/src/main/java/org/apache/tamaya/clsupport/AbstractClassloaderAwareItemLoader.java
@@ -30,13 +30,15 @@ import java.util.logging.Logger;
/**
- * This class implements an abstract base class, which basically provides a loading mechanism that supports
+ * <p>This class implements an abstract base class, which basically provides a loading mechanism that supports
* loading and managing resources along the classloader hierarchies individually. It ensures resources are loaded
* and stored related to the each target classloader within the hierarchy individually. Additionally it enables
- * mechanisms to ensure an item T is not loaded multiple times, when traversing up the classloader hierarchy.<p/>
- * Finally classloaders are not stored by reference by this class, to ensure they still can be garbage collected.
+ * mechanisms to ensure an item T is not loaded multiple times, when traversing up the classloader hierarchy.</p>
+ *
+ * <p>Finally classloaders are not stored by reference by this class, to ensure they still can be garbage collected.
* Instead this class uses the fully qualified class name of the loader and the corresponsing hashCode as returned
- * by {@link Objects#hashCode(Object)}.
+ * by {@link Objects#hashCode(Object)}.</p>
+ *
* @param <T> the managed item type.
*/
public abstract class AbstractClassloaderAwareItemLoader<T> {
@@ -122,7 +124,6 @@ public abstract class AbstractClassloaderAwareItemLoader<T> {
*
* @param currentItemSet the current found ItemContainer instance to be updated.
* @param classLoader the classloader, not null.
- * @return
*/
protected abstract void updateItem(T currentItemSet, ClassLoader classLoader);
@@ -131,7 +132,7 @@ public abstract class AbstractClassloaderAwareItemLoader<T> {
* This prevents the storage of classloader references as keys and therefore enables classloaders not used anymore
* to be garbage collected.
*
- * @param classLoader
+ * @param classLoader {@link ClassLoader} to be identified, must not be {@code null}.
* @return the unique key for the given classloader
*/
public static String getClassLoaderID(ClassLoader classLoader) {
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-sandbox/blob/f4f89d37/src/main/java/org/apache/tamaya/clsupport/CLAwareServiceContext.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/tamaya/clsupport/CLAwareServiceContext.java b/src/main/java/org/apache/tamaya/clsupport/CLAwareServiceContext.java
index 392d8b1..a5d1700 100644
--- a/src/main/java/org/apache/tamaya/clsupport/CLAwareServiceContext.java
+++ b/src/main/java/org/apache/tamaya/clsupport/CLAwareServiceContext.java
@@ -32,16 +32,18 @@ import java.util.logging.Logger;
/**
- * This class implements a {@link ServiceContext}, which basically provides a similar loading mechanism as used
+ * <p>This class implements a {@link ServiceContext}, which basically provides a similar loading mechanism as used
* by the {@link java.util.ServiceLoader}. Whereas the {@link java.util.ServiceLoader} only loads configurations
* and instances from one classloader, this loader manages configs found and the related instances for each
* classloader along the classloader hierarchies individually. It ensures instances are loaded on the classloader
* level, where they first are visible. Additionally it ensures the same configuration resource (and its
- * declared services) are loaded multiple times, when going up the classloader hierarchy.<p/>
- * Finally classloaders are not stored by reference by this class, to ensure they still can be garbage collected.
- * Refer also the inherited parent class for further details.<p/>
- * This class uses an ordinal of {@code 10}, so it overrides any default {@link ServiceContext} implementations
- * provided with the Tamaya core modules.
+ * declared services) are loaded multiple times, when going up the classloader hierarchy.</p>
+ *
+ * <p>Finally classloaders are not stored by reference by this class, to ensure they still can be garbage collected.
+ * Refer also the inherited parent class for further details.</p>
+ *
+ * <p>This class uses an ordinal of {@code 10}, so it overrides any default {@link ServiceContext} implementations
+ * provided with the Tamaya core modules.</p>
*/
@Priority(10)
public class CLAwareServiceContext extends AbstractClassloaderAwareItemLoader<ServiceContainer>