aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/javassist/Translator.java
diff options
context:
space:
mode:
authorchiba <chiba@30ef5769-5b8d-40dd-aea6-55b5d6557bb3>2004-09-08 13:58:03 +0000
committerchiba <chiba@30ef5769-5b8d-40dd-aea6-55b5d6557bb3>2004-09-08 13:58:03 +0000
commit7bb9f61c4dd0e02f2a65bd4fa843ffd3b93a0ee2 (patch)
tree4c55561731f275f66cc00e1b1724a6a25c56af38 /src/main/javassist/Translator.java
parent51ab670ccf46e3d26648d0b55cc725db6a4ad0c7 (diff)
downloadjavassist-7bb9f61c4dd0e02f2a65bd4fa843ffd3b93a0ee2.tar.gz
javassist-7bb9f61c4dd0e02f2a65bd4fa843ffd3b93a0ee2.zip
updated javadoc comments.
git-svn-id: http://anonsvn.jboss.org/repos/javassist/trunk@133 30ef5769-5b8d-40dd-aea6-55b5d6557bb3
Diffstat (limited to 'src/main/javassist/Translator.java')
-rw-r--r--src/main/javassist/Translator.java17
1 files changed, 14 insertions, 3 deletions
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;