update javadoc comments

git-svn-id: svn+ssh://svn.sourceforge.jp/svnroot/stigmata/digger/trunk@307 acee48c3-7b26-0410-bdac-b3d0e5314bbc

diff --git a/src/main/java/jp/sourceforge/stigmata/digger/ClassFileArchive.java b/src/main/java/jp/sourceforge/stigmata/digger/ClassFileArchive.java
index adb306c..291abee 100644 (file)
--- a/src/main/java/jp/sourceforge/stigmata/digger/ClassFileArchive.java
+++ b/src/main/java/jp/sourceforge/stigmata/digger/ClassFileArchive.java
@@ -10,21 +10,40 @@ import java.net.URL;
 import java.util.Iterator;
 
 /**
- * abstract presentation of class file archive's location.
+ * This interface is for the class manages the location of an archive,
+ * and the set of a class file included in the archive.
  *
  * @author Haruaki TAMADA
  * @version $Revision$ 
  */
 public interface ClassFileArchive extends Iterable<ClassFileEntry>{
+    /**
+     * returns the location of this archive.
+     */
     public URL getLocation();
 
+    /**
+     * returns the InputStream object from given entry.
+     */
     public InputStream getInputStream(ClassFileEntry entry) throws IOException;
 
+    /**
+     * returns an entries of this archive.
+     */
     public Iterator<ClassFileEntry> iterator();
 
+    /**
+     * returns this archive has given class entry or not.
+     */
     public boolean hasEntry(String className);
 
+    /**
+     * returns an entry of given class name.
+     */
     public ClassFileEntry getEntry(String className) throws ClassNotFoundException;
 
+    /**
+     * returns the name of this archive.
+     */
     public String getName();
 }

diff --git a/src/main/java/jp/sourceforge/stigmata/digger/ClassFileEntry.java b/src/main/java/jp/sourceforge/stigmata/digger/ClassFileEntry.java
index 62bc686..07859a7 100644 (file)
--- a/src/main/java/jp/sourceforge/stigmata/digger/ClassFileEntry.java
+++ b/src/main/java/jp/sourceforge/stigmata/digger/ClassFileEntry.java
@@ -4,10 +4,12 @@ package jp.sourceforge.stigmata.digger;
  * $Id$
  */
 
+import java.io.IOException;
+import java.io.InputStream;
 import java.net.URL;
 
 /**
- * 
+ * This class manages class name and its location.
  *
  * @author Haruaki TAMADA
  * @version $Revision$ 
@@ -32,4 +34,8 @@ public class ClassFileEntry{
     public URL getLocation(){
         return location;
     }
+
+    public InputStream openStream() throws IOException{
+        return getLocation().openStream();
+    }
 }

diff --git a/src/main/java/jp/sourceforge/stigmata/digger/ClasspathContext.java b/src/main/java/jp/sourceforge/stigmata/digger/ClasspathContext.java
index ab71437..6008549 100644 (file)
--- a/src/main/java/jp/sourceforge/stigmata/digger/ClasspathContext.java
+++ b/src/main/java/jp/sourceforge/stigmata/digger/ClasspathContext.java
@@ -12,6 +12,8 @@ import java.util.List;
 import jp.sourceforge.stigmata.digger.util.WarClassLoader;
 
 /**
+ * Context object of Classpath.
+ * 
  * @author Haruaki TAMADA
  * @version $Revision$ 
  */
@@ -74,7 +76,7 @@ public class ClasspathContext implements Iterable<URL>{
     /**
      * returns a size of classpath list, which this context and parent context have.
      */
-    public int getClasspathSize(){
+    public synchronized int getClasspathSize(){
         int count = classpath.size();
         if(parent != null){
             count += parent.getClasspathSize();
@@ -98,21 +100,24 @@ public class ClasspathContext implements Iterable<URL>{
      * If you want to clear this context and parent context, use {@link #clearAll <code>clearAll</code>} method.
      * @see clearAll
      */
-    public void clear(){
+    public synchronized void clear(){
         classpath.clear();
     }
 
     /**
      * clears all of classpathes of this context and parent context.
      */
-    public void clearAll(){
+    public synchronized void clearAll(){
         clear();
         if(parent != null){
             parent.clearAll();
         }
     }
 
-    public Iterator<URL> iterator(){
+    /**
+     * returns an iterator of classpath list.
+     */
+    public synchronized Iterator<URL> iterator(){
         if(parent == null){
             return classpath.iterator();
         }
@@ -143,6 +148,10 @@ public class ClasspathContext implements Iterable<URL>{
         }
     }
 
+
+    /**
+     * construct and returns a ClassLoader object which loads from classpath list.
+     */
     public synchronized ClassLoader createClassLoader(){
         if(loader == null){
             List<URL> list = new ArrayList<URL>();
@@ -150,12 +159,22 @@ public class ClasspathContext implements Iterable<URL>{
                 list.add(url);
             }
 
-            loader = new WarClassLoader(list.toArray(new URL[list.size()]), getClass().getClassLoader());
+            ClassLoader parentClassLoader = null;
+            if(parent != null){
+                parentClassLoader = parent.createClassLoader();
+            }
+            loader = new WarClassLoader(list.toArray(new URL[list.size()]), parentClassLoader);
         }
         return loader;
     }
 
-    public ClassFileEntry find(String className) throws ClassNotFoundException{
+    /**
+     * returns a {@link ClassFileEntry <code>ClassFileEntry</code>} object
+     * which is named given className.
+     * 
+     * @return ClassFileEntry object, if not found given class, then returns null.
+     */
+    public synchronized ClassFileEntry findEntry(String className){
         ClassLoader loader = createClassLoader();
 
         URL resource = loader.getResource(className.replace('.', '/') + ".class");
@@ -165,7 +184,19 @@ public class ClasspathContext implements Iterable<URL>{
         return null;
     }
 
-    public Class<?> findClass(String className) throws ClassNotFoundException{
+    /**
+     * returns this context has given class entry or not.
+     */
+    public synchronized boolean hasEntry(String className){
+        ClassLoader loader = createClassLoader();
+        return loader.getResource(className.replace('.', '/') + ".class") != null;
+    }
+
+    /**
+     * finds and returns a {@link Class <code>Class</code>} object
+     * which is named given className.
+     */
+    public synchronized Class<?> findClass(String className) throws ClassNotFoundException{
         try{
             ClassLoader loader = createClassLoader();