From: chiba <chiba@30ef5769-5b8d-40dd-aea6-55b5d6557bb3>
Date: Wed, 8 Sep 2004 13:58:03 +0000 (+0000)
Subject: updated javadoc comments.
X-Git-Tag: rel_3_17_1_ga~481
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=7bb9f61c4dd0e02f2a65bd4fa843ffd3b93a0ee2;p=javassist.git

updated javadoc comments.


git-svn-id: http://anonsvn.jboss.org/repos/javassist/trunk@133 30ef5769-5b8d-40dd-aea6-55b5d6557bb3
---

diff --git a/src/main/javassist/Loader.java b/src/main/javassist/Loader.java
index 91ae21bb..ea0284db 100644
--- a/src/main/javassist/Loader.java
+++ b/src/main/javassist/Loader.java
@@ -210,6 +210,8 @@ public class Loader extends ClassLoader {
      * @param cp        the <code>ClassPool</code> object for obtaining
      *                  a class file.
      * @param t         a translator.
+     * @throws NotFoundException        if <code>t.start()</code> throws an exception.
+     * @throws CannotCompileException   if <code>t.start()</code> throws an exception.
      */
     public void addTranslator(ClassPool cp, Translator t)
         throws NotFoundException, CannotCompileException {
diff --git a/src/main/javassist/Translator.java b/src/main/javassist/Translator.java
index a673b0b0..db5a95c9 100644
--- a/src/main/javassist/Translator.java
+++ b/src/main/javassist/Translator.java
@@ -28,10 +28,16 @@ public interface Translator {
     /**
      * Is invoked by a <code>Loader</code> for initialization
      * when the object is attached to the <code>Loader</code> object.
+     * This method can be used for getting (for caching) some
+     * <code>CtClass</code> objects that will be accessed
+     * in <code>onLoad()</code> in <code>Translator</code>.
      *
      * @param pool      the <code>ClassPool</code> that this translator
      *                          should use.
      * @see Loader
+     * @throws NotFoundException    if a <code>CtClass</code> cannot be found.
+     * @throws CannotCompileException   if the initialization by this method
+     *                                  fails.
      */
     void start(ClassPool pool)
         throws NotFoundException, CannotCompileException;
@@ -45,14 +51,19 @@ public interface Translator {
      *
      * to read the class file after <code>onLoad()</code> returns.
      *
-     * <p>The class specified by <code>classname</code> may not exist.
-     * If so, <code>onLoad()</code> should create that class so that
-     * the <code>Loader</code> can read it.
+     * <p><code>classname</code> may be the name of a class
+     * that has not been created yet.
+     * If so, <code>onLoad()</code> must create that class so that
+     * the <code>Loader</code> can read it after <code>onLoad()</code>
+     * returns.
      *
      * @param pool      the <code>ClassPool</code> that this translator
      *                          should use.
      * @param classname     the name of the class being loaded.
      * @see Loader
+     * @throws NotFoundException    if a <code>CtClass</code> cannot be found.
+     * @throws CannotCompileException   if the code transformation
+     *                                  by this method fails.
      */
     void onLoad(ClassPool pool, String classname)
         throws NotFoundException, CannotCompileException;