Author: simonetripodi
Date: Tue Apr 5 16:03:01 2011
New Revision: 1089099
URL: http://svn.apache.org/viewvc?rev=1089099&view=rev
Log:
added missing javadoc
made javadoc inherited where possible
Modified:
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK11Hooks.java
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK12Hooks.java
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDKHooks.java
Modified:
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK11Hooks.java
URL:
http://svn.apache.org/viewvc/commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK11Hooks.java?rev=1089099&r1=1089098&r2=1089099&view=diff
==============================================================================
---
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK11Hooks.java
(original)
+++
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK11Hooks.java
Tue Apr 5 16:03:01 2011
@@ -22,17 +22,14 @@ import java.util.Enumeration;
/**
- *
+ * JDK 1.1 Style Hooks implementation.
*/
public class JDK11Hooks extends JDKHooks {
private static final ClassLoader systemClassLoader
= new PsuedoSystemClassLoader();
/**
- * Get the system property
- *
- * @param propName name of the property
- * @return value of the property
+ * {@inheritDoc}
*/
@Override
public String getSystemProperty(final String propName) {
@@ -40,11 +37,7 @@ public class JDK11Hooks extends JDKHooks
}
/**
- * The thread context class loader is available for JDK 1.2
- * or later, if certain security conditions are met.
- *
- * @return The thread context class loader, if available.
- * Otherwise return null.
+ * {@inheritDoc}
*/
@Override
public ClassLoader getThreadContextClassLoader() {
@@ -52,11 +45,7 @@ public class JDK11Hooks extends JDKHooks
}
/**
- * The system class loader is available for JDK 1.2
- * or later, if certain security conditions are met.
- *
- * @return The system class loader, if available.
- * Otherwise return null.
+ * {@inheritDoc}
*/
@Override
public ClassLoader getSystemClassLoader() {
@@ -64,11 +53,7 @@ public class JDK11Hooks extends JDKHooks
}
/**
- * Implement ClassLoader.getResources for JDK 1.1
- *
- * On JDK1.1 there is no getResources() method. We emulate this by
- * using introspection and doing the lookup ourself, using the list
- * of URLs, via getURLs().
+ * {@inheritDoc}
*/
@Override
public Enumeration<URL> getResources(ClassLoader loader,
Modified:
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK12Hooks.java
URL:
http://svn.apache.org/viewvc/commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK12Hooks.java?rev=1089099&r1=1089098&r2=1089099&view=diff
==============================================================================
---
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK12Hooks.java
(original)
+++
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDK12Hooks.java
Tue Apr 5 16:03:01 2011
@@ -27,7 +27,7 @@ import org.apache.commons.logging.LogFac
/**
- *
+ * JDK 1.2 Style Hooks implementation.
*/
public class JDK12Hooks extends JDKHooks {
@@ -48,10 +48,7 @@ public class JDK12Hooks extends JDKHooks
}
/**
- * Get the system property
- *
- * @param propName name of the property
- * @return value of the property
+ * {@inheritDoc}
*/
@Override
public String getSystemProperty(final String propName) {
@@ -68,11 +65,7 @@ public class JDK12Hooks extends JDKHooks
}
/**
- * The thread context class loader is available for JDK 1.2
- * or later, if certain security conditions are met.
- *
- * @return The thread context class loader, if available.
- * Otherwise return null.
+ * {@inheritDoc}
*/
@Override
public ClassLoader getThreadContextClassLoader() {
@@ -100,11 +93,7 @@ public class JDK12Hooks extends JDKHooks
}
/**
- * The system class loader is available for JDK 1.2
- * or later, if certain security conditions are met.
- *
- * @return The system class loader, if available.
- * Otherwise return null.
+ * {@inheritDoc}
*/
@Override
public ClassLoader getSystemClassLoader() {
@@ -112,7 +101,7 @@ public class JDK12Hooks extends JDKHooks
}
/**
- * Implement ClassLoader.getResources for JDK 1.2
+ * {@inheritDoc}
*/
@Override
public Enumeration<URL> getResources(ClassLoader loader,
Modified:
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDKHooks.java
URL:
http://svn.apache.org/viewvc/commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDKHooks.java?rev=1089099&r1=1089098&r2=1089099&view=diff
==============================================================================
---
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDKHooks.java
(original)
+++
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/jdk/JDKHooks.java
Tue Apr 5 16:03:01 2011
@@ -22,7 +22,7 @@ import java.util.Enumeration;
/**
- *
+ * JDK Hooks to extract properties/resources.
*/
public abstract class JDKHooks {
private static final JDKHooks jdkHooks;
@@ -37,6 +37,8 @@ public abstract class JDKHooks {
* Return singleton object representing JVM hooks/tools.
*
* TODO: add logic to detect JDK level.
+ *
+ * @return The detected {@code JDKHooks}
*/
public static final JDKHooks getJDKHooks() {
return jdkHooks;
@@ -68,6 +70,15 @@ public abstract class JDKHooks {
*/
public abstract ClassLoader getSystemClassLoader();
+ /**
+ * Resolve resource with given names and make them available in
+ * the returned iterator.
+ *
+ * @param loader The class loader used to resolve resources
+ * @param resourceName The resource name to resolve
+ * @return The iterator over the URL resolved resources
+ * @throws IOException
+ */
public abstract Enumeration<URL> getResources(ClassLoader loader,
String resourceName)
throws IOException;
