123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236 |
- /*
- * Javassist, a Java-bytecode translator toolkit.
- * Copyright (C) 1999-2006 Shigeru Chiba. All Rights Reserved.
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. Alternatively, the contents of this file may be used under
- * the terms of the GNU Lesser General Public License Version 2.1 or later.
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- */
-
- package javassist;
-
- import java.io.BufferedOutputStream;
- import java.io.ByteArrayOutputStream;
- import java.io.DataOutputStream;
- import java.io.File;
- import java.io.FileOutputStream;
- import java.io.IOException;
- import java.io.OutputStream;
- import java.net.URL;
- import java.util.Collection;
- import javassist.bytecode.ClassFile;
- import javassist.bytecode.Descriptor;
- import javassist.bytecode.Opcode;
- import javassist.expr.ExprEditor;
-
- /* Note:
- *
- * This class is an abstract class and several methods just return null
- * or throw an exception. Those methods are overridden in subclasses
- * of this class. Read the source code of CtClassType if you are
- * interested in the implementation of Javassist.
- *
- * Subclasses of CtClass are CtClassType, CtPrimitiveType, and CtArray.
- */
-
- /**
- * An instance of <code>CtClass</code> represents a class.
- * It is obtained from <code>ClassPool</code>.
- *
- * @see ClassPool#get(String)
- */
- public abstract class CtClass {
- protected String qualifiedName;
-
- /**
- * The version number of this release.
- */
- public static final String version = "3.1RC2";
-
- /**
- * Prints the version number and the copyright notice.
- *
- * <p>The following command invokes this method:
- *
- * <ul><pre>java -jar javassist.jar</pre></ul>
- */
- public static void main(String[] args) {
- System.out.println("Javassist version " + CtClass.version);
- System.out.println("Copyright (C) 1999-2006 Shigeru Chiba."
- + " All Rights Reserved.");
- }
-
- static final String javaLangObject = "java.lang.Object";
-
- /**
- * The <code>CtClass</code> object representing
- * the <code>boolean</code> type.
- */
- public static CtClass booleanType;
-
- /**
- * The <code>CtClass</code> object representing
- * the <code>char</code> type.
- */
- public static CtClass charType;
-
- /**
- * The <code>CtClass</code> object representing
- * the <code>byte</code> type.
- */
- public static CtClass byteType;
-
- /**
- * The <code>CtClass</code> object representing
- * the <code>short</code> type.
- */
- public static CtClass shortType;
-
- /**
- * The <code>CtClass</code> object representing
- * the <code>int</code> type.
- */
- public static CtClass intType;
-
- /**
- * The <code>CtClass</code> object representing
- * the <code>long</code> type.
- */
- public static CtClass longType;
-
- /**
- * The <code>CtClass</code> object representing
- * the <code>float</code> type.
- */
- public static CtClass floatType;
-
- /**
- * The <code>CtClass</code> object representing
- * the <code>double</code> type.
- */
- public static CtClass doubleType;
-
- /**
- * The <code>CtClass</code> object representing
- * the <code>void</code> type.
- */
- public static CtClass voidType;
-
- static CtClass[] primitiveTypes;
-
- static {
- primitiveTypes = new CtClass[9];
-
- booleanType =
- new CtPrimitiveType("boolean", 'Z', "java.lang.Boolean",
- "booleanValue", "()Z", Opcode.IRETURN,
- Opcode.T_BOOLEAN, 1);
- primitiveTypes[0] = booleanType;
-
- charType = new CtPrimitiveType("char", 'C', "java.lang.Character",
- "charValue", "()C", Opcode.IRETURN,
- Opcode.T_CHAR, 1);
- primitiveTypes[1] = charType;
-
- byteType = new CtPrimitiveType("byte", 'B', "java.lang.Byte",
- "byteValue", "()B", Opcode.IRETURN,
- Opcode.T_BYTE, 1);
- primitiveTypes[2] = byteType;
-
- shortType = new CtPrimitiveType("short", 'S', "java.lang.Short",
- "shortValue", "()S", Opcode.IRETURN,
- Opcode.T_SHORT, 1);
- primitiveTypes[3] = shortType;
-
- intType = new CtPrimitiveType("int", 'I', "java.lang.Integer",
- "intValue", "()I", Opcode.IRETURN,
- Opcode.T_INT, 1);
- primitiveTypes[4] = intType;
-
- longType = new CtPrimitiveType("long", 'J', "java.lang.Long",
- "longValue", "()J", Opcode.LRETURN,
- Opcode.T_LONG, 2);
- primitiveTypes[5] = longType;
-
- floatType = new CtPrimitiveType("float", 'F', "java.lang.Float",
- "floatValue", "()F", Opcode.FRETURN,
- Opcode.T_FLOAT, 1);
- primitiveTypes[6] = floatType;
-
- doubleType = new CtPrimitiveType("double", 'D', "java.lang.Double",
- "doubleValue", "()D", Opcode.DRETURN,
- Opcode.T_DOUBLE, 2);
- primitiveTypes[7] = doubleType;
-
- voidType = new CtPrimitiveType("void", 'V', "java.lang.Void",
- null, null, Opcode.RETURN, 0, 0);
- primitiveTypes[8] = voidType;
- }
-
- protected CtClass(String name) {
- qualifiedName = name;
- }
-
- /**
- * Converts the object to a string.
- */
- public String toString() {
- StringBuffer buf = new StringBuffer(getClass().getName());
- buf.append("@");
- buf.append(Integer.toHexString(hashCode()));
- buf.append("[");
- extendToString(buf);
- buf.append("]");
- return buf.toString();
- }
-
- /**
- * Implemented in subclasses to add to the {@link #toString()} result.
- * Subclasses should put a space before each token added to the buffer.
- */
- protected void extendToString(StringBuffer buffer) {
- buffer.append(getName());
- }
-
- /**
- * Returns a <code>ClassPool</code> for this class.
- */
- public ClassPool getClassPool() { return null; }
-
- /**
- * Returns a class file for this class.
- *
- * <p>This method is not available if <code>isFrozen()</code>
- * is true.
- */
- public ClassFile getClassFile() {
- checkModify();
- return getClassFile2();
- }
-
- /**
- * Returns a class file for this class (read only).
- * Normal applications do not need calling this method. Use
- * <code>getClassFile()</code>.
- *
- * <p>The <code>ClassFile</code> object obtained by this method
- * is read only. Changes to this object might not be reflected
- * on a class file generated by <code>toBytecode()</code>,
- * <code>toClass()</code>, etc.
- *
- * <p>This method is available even if <code>isFrozen()</code>
- * is true. However, if the class is frozen, it might be also
- * pruned.
- *
- * @see CtClass#getClassFile()
- * @see CtClass#isFrozen()
- * @see CtClass#prune()
- */
- public ClassFile getClassFile2() { return null; }
-
- /**
- * Undocumented method. Do not use; internal-use only.
- */
- public javassist.compiler.AccessorMaker getAccessorMaker() {
- return null;
- }
-
- /**
- * Returns the uniform resource locator (URL) of the class file.
- */
- public URL getURL() throws NotFoundException {
- throw new NotFoundException(getName());
- }
-
- /**
- * Returns true if the definition of the class has been modified.
- */
- public boolean isModified() { return false; }
-
- /**
- * Returns true if the class has been loaded or written out
- * and thus it cannot be modified any more.
- *
- * @see #defrost()
- * @see #detach()
- */
- public boolean isFrozen() { return true; }
-
- void freeze() {}
-
- /* Note: this method is overridden by CtClassType
- */
- void checkModify() throws RuntimeException {
- if (isFrozen())
- throw new RuntimeException(getName() + " class is frozen");
-
- // isModified() must return true after this method is invoked.
- }
-
- /**
- * Defrosts the class so that the class can be modified again.
- *
- * <p>To avoid changes that will be never reflected,
- * the class is frozen to be unmodifiable if it is loaded or
- * written out. This method should be called only in a case
- * that the class will be reloaded or written out later again.
- *
- * <p>If <code>defrost()</code> will be called later, pruning
- * must be disallowed in advance.
- *
- * @see #isFrozen()
- * @see #stopPruning(boolean)
- * @see #detach()
- */
- public void defrost() {
- throw new RuntimeException("cannot defrost " + getName());
- }
-
- /**
- * Returns <code>true</code> if this object represents a primitive
- * Java type: boolean, byte, char, short, int, long, float, double,
- * or void.
- */
- public boolean isPrimitive() { return false; }
-
- /**
- * Returns <code>true</code> if this object represents an array type.
- */
- public boolean isArray() {
- return false;
- }
-
- /**
- * If this object represents an array, this method returns the component
- * type of the array. Otherwise, it returns <code>null</code>.
- */
- public CtClass getComponentType() throws NotFoundException {
- return null;
- }
-
- /**
- * Returns <code>true</code> if this class extends or implements
- * <code>clazz</code>. It also returns <code>true</code> if
- * this class is the same as <code>clazz</code>.
- */
- public boolean subtypeOf(CtClass clazz) throws NotFoundException {
- return this == clazz || getName().equals(clazz.getName());
- }
-
- /**
- * Obtains the fully-qualified name of the class.
- */
- public String getName() { return qualifiedName; }
-
- /**
- * Obtains the not-qualified class name.
- */
- public final String getSimpleName() {
- String qname = qualifiedName;
- int index = qname.lastIndexOf('.');
- if (index < 0)
- return qname;
- else
- return qname.substring(index + 1);
- }
-
- /**
- * Obtains the package name. It may be <code>null</code>.
- */
- public final String getPackageName() {
- String qname = qualifiedName;
- int index = qname.lastIndexOf('.');
- if (index < 0)
- return null;
- else
- return qname.substring(0, index);
- }
-
- /**
- * Sets the class name
- *
- * @param name fully-qualified name
- */
- public void setName(String name) {
- checkModify();
- if (name != null)
- qualifiedName = name;
- }
-
- /**
- * Substitutes <code>newName</code> for all occurrences of a class
- * name <code>oldName</code> in the class file.
- *
- * @param oldName replaced class name
- * @param newName substituted class name
- */
- public void replaceClassName(String oldName, String newName) {
- checkModify();
- }
-
- /**
- * Changes class names appearing in the class file according to the
- * given <code>map</code>.
- *
- * <p>All the class names appearing in the class file are tested
- * with <code>map</code> to determine whether each class name is
- * replaced or not. Thus this method can be used for collecting
- * all the class names in the class file. To do that, first define
- * a subclass of <code>ClassMap</code> so that <code>get()</code>
- * records all the given parameters. Then, make an instance of
- * that subclass as an empty hash-table. Finally, pass that instance
- * to this method. After this method finishes, that instance would
- * contain all the class names appearing in the class file.
- *
- * @param map the hashtable associating replaced class names
- * with substituted names.
- */
- public void replaceClassName(ClassMap map) {
- checkModify();
- }
-
- /**
- * Returns a collection of the names of all the classes
- * referenced in this class.
- * That collection includes the name of this class.
- *
- * <p>This method may return <code>null</code>.
- */
- public Collection getRefClasses() {
- ClassFile cf = getClassFile2();
- if (cf != null) {
- ClassMap cm = new ClassMap() {
- public void put(String oldname, String newname) {
- put0(oldname, newname);
- }
-
- public Object get(Object jvmClassName) {
- String n = toJavaName((String)jvmClassName);
- put0(n, n);
- return null;
- }
-
- public void fix(String name) {}
- };
- cf.renameClass(cm);
- return cm.values();
- }
- else
- return null;
- }
-
- /**
- * Determines whether this object represents a class or an interface.
- * It returns <code>true</code> if this object represents an interface.
- */
- public boolean isInterface() {
- return false;
- }
-
- /**
- * Returns the modifiers for this class, encoded in an integer.
- * For decoding, use <code>javassist.Modifier</code>.
- *
- * @see Modifier
- */
- public int getModifiers() {
- return 0;
- }
-
- /**
- * Returns the annotations associated with this class.
- * For example, if an annotation <code>@Author</code> is associated
- * with this class, the returned array contains an <code>Author</code>
- * object. The member values can be obtained by calling methods on
- * the <code>Author</code> object.
- *
- * @return an array of annotation-type objects.
- * @since 3.1
- */
- public Object[] getAnnotations() throws ClassNotFoundException {
- return new Object[0];
- }
-
- /**
- * Sets the modifiers.
- *
- * <p>If the class is a nested class, this method also modifies
- * the class declaring that nested class (i.e. the enclosing
- * class is modified).
- *
- * @param mod modifiers encoded by
- * <code>javassist.Modifier</code>
- * @see Modifier
- */
- public void setModifiers(int mod) {
- checkModify();
- }
-
- /**
- * Determines whether the class directly or indirectly extends
- * the given class. If this class extends a class A and
- * the class A extends a class B, then subclassof(B) returns true.
- *
- * <p>This method returns true if the given class is identical to
- * the class represented by this object.
- */
- public boolean subclassOf(CtClass superclass) {
- return false;
- }
-
- /**
- * Obtains the class object representing the superclass of the
- * class.
- * It returns null if this object represents the
- * <code>java.lang.Object</code> class and thus it does not have
- * the super class.
- *
- * <p>If this object represents an interface, this method
- * always returns the <code>java.lang.Object</code> class.
- * To obtain the super interfaces
- * extended by that interface, call <code>getInterfaces()</code>.
- */
- public CtClass getSuperclass() throws NotFoundException {
- return null;
- }
-
- /**
- * Changes a super class unless this object represents an interface.
- * The new super class must be compatible with the old one.
- *
- * <p>If this object represents an interface, this method is equivalent
- * to <code>addInterface()</code>; it appends <code>clazz</code> to
- * the list of the super interfaces extended by that interface.
- * Note that an interface can extend multiple super interfaces.
- */
- public void setSuperclass(CtClass clazz) throws CannotCompileException {
- checkModify();
- }
-
- /**
- * Obtains the class objects representing the interfaces implemented
- * by the class or, if this object represents an interface, the interfaces
- * extended by that interface.
- */
- public CtClass[] getInterfaces() throws NotFoundException {
- return new CtClass[0];
- }
-
- /**
- * Sets implemented interfaces. If this object represents an interface,
- * this method sets the interfaces extended by that interface.
- *
- * @param list a list of the <code>CtClass</code> objects
- * representing interfaces, or
- * <code>null</code> if the class implements
- * no interfaces.
- */
- public void setInterfaces(CtClass[] list) {
- checkModify();
- }
-
- /**
- * Adds an interface.
- *
- * @param anInterface the added interface.
- */
- public void addInterface(CtClass anInterface) {
- checkModify();
- }
-
- /**
- * If this class is a member class or interface of another class,
- * then the class enclosing this class is returned.
- *
- * @return null if this class is a top-level class or an anonymous class.
- */
- public CtClass getDeclaringClass() throws NotFoundException {
- return null;
- }
-
- /**
- * Returns the immediately enclosing method of this class.
- * This method works only with JDK 1.5 or later.
- *
- * @return null if this class is not a local class or an anonymous
- * class.
- */
- public CtMethod getEnclosingMethod() throws NotFoundException {
- return null;
- }
-
- /**
- * Makes a new public nested class. If this method is called,
- * the <code>CtClass</code>, which encloses the nested class, is modified
- * since a class file includes a list of inner classes.
- *
- * <p>The current implementation only supports a static nested class.
- * <code>isStatic</code> must be true.
- *
- * @param name the simple name of the nested class.
- * @param isStatic true if the nested class is static.
- */
- public CtClass makeNestedClass(String name, boolean isStatic) {
- throw new RuntimeException(getName() + " is not a class");
- }
-
- /**
- * Returns an array containing <code>CtField</code> objects
- * representing all the non-private fields of the class.
- * That array includes non-private fields inherited from the
- * superclasses.
- */
- public CtField[] getFields() { return new CtField[0]; }
-
- /**
- * Returns the field with the specified name. The returned field
- * may be a private field declared in a super class or interface.
- */
- public CtField getField(String name) throws NotFoundException {
- throw new NotFoundException(name);
- }
-
- /**
- * @return null if the specified field is not found.
- */
- CtField getField2(String name) { return null; }
-
- /**
- * Gets all the fields declared in the class. The inherited fields
- * are not included.
- *
- * <p>Note: the result does not include inherited fields.
- */
- public CtField[] getDeclaredFields() { return new CtField[0]; }
-
- /**
- * Retrieves the field with the specified name among the fields
- * declared in the class.
- *
- * <p>Note: this method does not search the superclasses.
- */
- public CtField getDeclaredField(String name) throws NotFoundException {
- throw new NotFoundException(name);
- }
-
- /**
- * Gets all the constructors and methods declared in the class.
- */
- public CtBehavior[] getDeclaredBehaviors() {
- return new CtBehavior[0];
- }
-
- /**
- * Returns an array containing <code>CtConstructor</code> objects
- * representing all the non-private constructors of the class.
- */
- public CtConstructor[] getConstructors() {
- return new CtConstructor[0];
- }
-
- /**
- * Returns the constructor with the given signature,
- * which is represented by a character string
- * called method descriptor.
- * For details of the method descriptor, see the JVM specification
- * or <code>javassist.bytecode.Descriptor</code>.
- *
- * @param desc method descriptor
- * @see javassist.bytecode.Descriptor
- */
- public CtConstructor getConstructor(String desc)
- throws NotFoundException
- {
- throw new NotFoundException("no such a constructor");
- }
-
- /**
- * Gets all the constructors declared in the class.
- *
- * @see javassist.CtConstructor
- */
- public CtConstructor[] getDeclaredConstructors() {
- return new CtConstructor[0];
- }
-
- /**
- * Returns a constructor receiving the specified parameters.
- *
- * @param params parameter types.
- */
- public CtConstructor getDeclaredConstructor(CtClass[] params)
- throws NotFoundException
- {
- String desc = Descriptor.ofConstructor(params);
- return getConstructor(desc);
- }
-
- /**
- * Gets the class initializer (static constructor)
- * declared in the class.
- * This method returns <code>null</code> if
- * no class initializer is not declared.
- *
- * @see #makeClassInitializer()
- * @see javassist.CtConstructor
- */
- public CtConstructor getClassInitializer() {
- return null;
- }
-
- /**
- * Returns an array containing <code>CtMethod</code> objects
- * representing all the non-private methods of the class.
- * That array includes pon-private methods inherited from the
- * superclasses.
- */
- public CtMethod[] getMethods() {
- return new CtMethod[0];
- }
-
- /**
- * Returns the method with the given name and signature.
- * The returned method may be declared in a super class.
- * The method signature is represented by a character string
- * called method descriptor,
- * which is defined in the JVM specification.
- *
- * @param name method name
- * @param desc method descriptor
- * @see CtBehavior#getSignature()
- * @see javassist.bytecode.Descriptor
- */
- public CtMethod getMethod(String name, String desc)
- throws NotFoundException
- {
- throw new NotFoundException(name);
- }
-
- /**
- * Gets all methods declared in the class. The inherited methods
- * are not included.
- *
- * @see javassist.CtMethod
- */
- public CtMethod[] getDeclaredMethods() {
- return new CtMethod[0];
- }
-
- /**
- * Retrieves the method with the specified name and parameter types
- * among the methods declared in the class.
- *
- * <p>Note: this method does not search the superclasses.
- *
- * @param name method name
- * @param params parameter types
- * @see javassist.CtMethod
- */
- public CtMethod getDeclaredMethod(String name, CtClass[] params)
- throws NotFoundException
- {
- throw new NotFoundException(name);
- }
-
- /**
- * Retrieves the method with the specified name among the methods
- * declared in the class. If there are multiple methods with
- * the specified name, then this method returns one of them.
- *
- * <p>Note: this method does not search the superclasses.
- *
- * @see javassist.CtMethod
- */
- public CtMethod getDeclaredMethod(String name) throws NotFoundException {
- throw new NotFoundException(name);
- }
-
- /**
- * Makes an empty class initializer (static constructor).
- * If the class already includes a class initializer,
- * this method returns it.
- *
- * @see #getClassInitializer()
- */
- public CtConstructor makeClassInitializer()
- throws CannotCompileException
- {
- throw new CannotCompileException("not a class");
- }
-
- /**
- * Adds a constructor. To add a class initializer (static constructor),
- * call <code>makeClassInitializer()</code>.
- *
- * @see #makeClassInitializer()
- */
- public void addConstructor(CtConstructor c)
- throws CannotCompileException
- {
- checkModify();
- }
-
- /**
- * Removes a constructor declared in this class.
- *
- * @param c removed constructor.
- * @throws NotFoundException if the constructor is not found.
- */
- public void removeConstructor(CtConstructor c) throws NotFoundException {
- checkModify();
- }
-
- /**
- * Adds a method.
- */
- public void addMethod(CtMethod m) throws CannotCompileException {
- checkModify();
- }
-
- /**
- * Removes a method declared in this class.
- *
- * @param m removed method.
- * @throws NotFoundException if the method is not found.
- */
- public void removeMethod(CtMethod m) throws NotFoundException {
- checkModify();
- }
-
- /**
- * Adds a field.
- *
- * <p>The <code>CtField</code> belonging to another
- * <code>CtClass</code> cannot be directly added to this class.
- * Only a field created for this class can be added.
- *
- * @see javassist.CtField#CtField(CtField,CtClass)
- */
- public void addField(CtField f) throws CannotCompileException {
- addField(f, (CtField.Initializer)null);
- }
-
- /**
- * Adds a field with an initial value.
- *
- * <p>The <code>CtField</code> belonging to another
- * <code>CtClass</code> cannot be directly added to this class.
- * Only a field created for this class can be added.
- *
- * <p>The initial value is given as an expression written in Java.
- * Any regular Java expression can be used for specifying the initial
- * value. The followings are examples.
- *
- * <ul><pre>
- * cc.addField(f, "0") // the initial value is 0.
- * cc.addField(f, "i + 1") // i + 1.
- * cc.addField(f, "new Point()"); // a Point object.
- * </pre></ul>
- *
- * <p>Here, the type of variable <code>cc</code> is <code>CtClass</code>.
- * The type of <code>f</code> is <code>CtField</code>.
- *
- * @param init an expression for the initial value.
- *
- * @see javassist.CtField.Initializer#byExpr(String)
- * @see javassist.CtField#CtField(CtField,CtClass)
- */
- public void addField(CtField f, String init)
- throws CannotCompileException
- {
- checkModify();
- }
-
- /**
- * Adds a field with an initial value.
- *
- * <p>The <code>CtField</code> belonging to another
- * <code>CtClass</code> cannot be directly added to this class.
- * Only a field created for this class can be added.
- *
- * <p>For example,
- *
- * <ul><pre>
- * CtClass cc = ...;
- * addField(new CtField(CtClass.intType, "i", cc),
- * CtField.Initializer.constant(1));
- * </pre></ul>
- *
- * <p>This code adds an <code>int</code> field named "i". The
- * initial value of this field is 1.
- *
- * @param init specifies the initial value of the field.
- *
- * @see javassist.CtField#CtField(CtField,CtClass)
- */
- public void addField(CtField f, CtField.Initializer init)
- throws CannotCompileException
- {
- checkModify();
- }
-
- /**
- * Removes a field declared in this class.
- *
- * @param f removed field.
- * @throws NotFoundException if the field is not found.
- */
- public void removeField(CtField f) throws NotFoundException {
- checkModify();
- }
-
- /**
- * Obtains an attribute with the given name.
- * If that attribute is not found in the class file, this
- * method returns null.
- *
- * <p>This is a convenient method mainly for obtaining
- * a user-defined attribute. For dealing with attributes, see the
- * <code>javassist.bytecode</code> package. For example, the following
- * expression returns all the attributes of a class file.
- *
- * <ul><pre>
- * getClassFile().getAttributes()
- * </pre></ul>
- *
- * @param name attribute name
- * @see javassist.bytecode.AttributeInfo
- */
- public byte[] getAttribute(String name) {
- return null;
- }
-
- /**
- * Adds a named attribute.
- * An arbitrary data (smaller than 64Kb) can be saved in the class
- * file. Some attribute name are reserved by the JVM.
- * The attributes with the non-reserved names are ignored when a
- * class file is loaded into the JVM.
- * If there is already an attribute with
- * the same name, this method substitutes the new one for it.
- *
- * <p>This is a convenient method mainly for adding
- * a user-defined attribute. For dealing with attributes, see the
- * <code>javassist.bytecode</code> package. For example, the following
- * expression adds an attribute <code>info</code> to a class file.
- *
- * <ul><pre>
- * getClassFile().addAttribute(info)
- * </pre></ul>
- *
- * @param name attribute name
- * @param data attribute value
- * @see javassist.bytecode.AttributeInfo
- */
- public void setAttribute(String name, byte[] data) {
- checkModify();
- }
-
- /**
- * Applies the given converter to all methods and constructors
- * declared in the class. This method calls <code>instrument()</code>
- * on every <code>CtMethod</code> and <code>CtConstructor</code> object
- * in the class.
- *
- * @param converter specifies how to modify.
- */
- public void instrument(CodeConverter converter)
- throws CannotCompileException
- {
- checkModify();
- }
-
- /**
- * Modifies the bodies of all methods and constructors
- * declared in the class. This method calls <code>instrument()</code>
- * on every <code>CtMethod</code> and <code>CtConstructor</code> object
- * in the class.
- *
- * @param editor specifies how to modify.
- */
- public void instrument(ExprEditor editor)
- throws CannotCompileException
- {
- checkModify();
- }
-
- /**
- * Converts this class to a <code>java.lang.Class</code> object.
- * Once this method is called, further modifications are not
- * allowed any more.
- * To load the class, this method uses the context class loader
- * of the current thread. If the program is running on some application
- * server, the context class loader might be inappropriate to load the
- * class.
- *
- * <p>This method is provided for convenience. If you need more
- * complex functionality, you should write your own class loader.
- *
- * <p>Note: this method calls <code>toClass()</code>
- * in <code>ClassPool</code>.
- *
- * @see #toClass(java.lang.ClassLoader)
- * @see ClassPool#toClass(CtClass)
- */
- public Class toClass() throws CannotCompileException {
- return getClassPool().toClass(this);
- }
-
- /**
- * Converts this class to a <code>java.lang.Class</code> object.
- * Once this method is called, further modifications are not allowed
- * any more.
- *
- * <p>The class file represented by this <code>CtClass</code> is
- * loaded by the given class loader to construct a
- * <code>java.lang.Class</code> object. Since a private method
- * on the class loader is invoked through the reflection API,
- * the caller must have permissions to do that.
- *
- * <p>This method is provided for convenience. If you need more
- * complex functionality, you should write your own class loader.
- *
- * <p>Note: this method calls <code>toClass()</code>
- * in <code>ClassPool</code>.
- *
- * @param loader the class loader used to load this class.
- * @see ClassPool#toClass(CtClass,java.lang.ClassLoader)
- */
- public Class toClass(ClassLoader loader)
- throws CannotCompileException
- {
- return getClassPool().toClass(this, loader);
- }
-
- /**
- * Removes this <code>CtClass</code> object from the
- * <code>ClassPool</code>.
- * After this method is called, any method cannot be called on the
- * removed <code>CtClass</code> object.
- *
- * <p>If <code>get()</code> in <code>ClassPool</code> is called
- * with the name of the removed method,
- * the <code>ClassPool</code> will read the class file again
- * and constructs another <code>CtClass</code> object representing
- * the same class.
- */
- public void detach() {
- ClassPool cp = getClassPool();
- CtClass obj = cp.removeCached(getName());
- if (obj != this)
- cp.cacheCtClass(getName(), obj, false);
- }
-
- /**
- * Disallows (or allows) automatically pruning this <code>CtClass</code>
- * object.
- *
- * <p>
- * Javassist can automatically prune a <code>CtClass</code> object
- * when <code>toBytecode()</code> (or <code>toClass()</code>,
- * <code>writeFile()</code>) is called.
- * Since a <code>ClassPool</code> holds all instances of <code>CtClass</code>
- * even after <code>toBytecode()</code> (or <code>toClass()</code>,
- * <code>writeFile()</code>) is called, pruning may significantly
- * save memory consumption.
- *
- * <p>If <code>ClassPool.doPruning</code> is true, the automatic pruning
- * is on by default. Otherwise, it is off.
- *
- * @param stop disallow pruning if true. Otherwise, allow.
- * @return the previous status of pruning. true if pruning is already stopped.
- *
- * @see #detach()
- * @see #prune()
- * @see ClassPool#doPruning
- */
- public boolean stopPruning(boolean stop) { return true; }
-
- /**
- * Discards unnecessary attributes, in particuar,
- * <code>CodeAttribute</code>s (method bodies) of the class,
- * to minimize the memory footprint.
- * After calling this method, the class is read only.
- * It cannot be modified any more.
- * Furthermore, <code>toBytecode()</code>,
- * <code>writeFile()</code>, <code>toClass()</code>,
- * or <code>instrument()</code> cannot be called.
- * However, the method names and signatures in the class etc.
- * are still accessible.
- *
- * <p><code>toBytecode()</code>, <code>writeFile()</code>, and
- * <code>toClass()</code> internally call this method.
- *
- * @see #toBytecode()
- * @see #toClass()
- * @see #writeFile()
- * @see #instrument(CodeConverter)
- * @see #instrument(ExprEditor)
- *
- * @see #stopPruning(boolean)
- */
- public void prune() {}
-
- /* Called by get() in ClassPool.
- * CtClassType overrides this method.
- */
- void incGetCounter() {}
-
- /**
- * Converts this class to a class file.
- * Once this method is called, further modifications are not
- * possible any more.
- *
- * @return the contents of the class file.
- */
- public byte[] toBytecode() throws IOException, CannotCompileException {
- ByteArrayOutputStream barray = new ByteArrayOutputStream();
- DataOutputStream out = new DataOutputStream(barray);
- try {
- toBytecode(out);
- }
- finally {
- out.close();
- }
-
- return barray.toByteArray();
- }
-
- /**
- * Writes a class file represented by this <code>CtClass</code>
- * object in the current directory.
- * Once this method is called, further modifications are not
- * possible any more.
- */
- public void writeFile()
- throws NotFoundException, IOException, CannotCompileException
- {
- writeFile(".");
- }
-
- /**
- * Writes a class file represented by this <code>CtClass</code>
- * object on a local disk.
- * Once this method is called, further modifications are not
- * possible any more.
- *
- * @param directoryName it must end without a directory separator.
- */
- public void writeFile(String directoryName)
- throws NotFoundException, CannotCompileException, IOException
- {
- String classname = getName();
- String filename = directoryName + File.separatorChar
- + classname.replace('.', File.separatorChar) + ".class";
- int pos = filename.lastIndexOf(File.separatorChar);
- if (pos > 0) {
- String dir = filename.substring(0, pos);
- if (!dir.equals("."))
- new File(dir).mkdirs();
- }
-
- DataOutputStream out
- = new DataOutputStream(new BufferedOutputStream(
- new DelayedFileOutputStream(filename)));
- try {
- toBytecode(out);
- }
- finally {
- out.close();
- }
- }
-
- /**
- * Writes a class file as <code>writeFile()</code> does although this
- * method does not prune or freeze the class after writing the class
- * file. Note that, once <code>writeFile()</code> or <code>toBytecode()</code>
- * is called, it cannot be called again since the class is pruned and frozen.
- * This method would be useful for debugging.
- */
- public void debugWriteFile() {
- try {
- boolean p = stopPruning(true);
- writeFile();
- defrost();
- stopPruning(p);
- }
- catch (Exception e) {
- throw new RuntimeException(e);
- }
- }
-
- static class DelayedFileOutputStream extends OutputStream {
- private FileOutputStream file;
- private String filename;
-
- DelayedFileOutputStream(String name) {
- file = null;
- filename = name;
- }
-
- private void init() throws IOException {
- if (file == null)
- file = new FileOutputStream(filename);
- }
-
- public void write(int b) throws IOException {
- init();
- file.write(b);
- }
-
- public void write(byte[] b) throws IOException {
- init();
- file.write(b);
- }
-
- public void write(byte[] b, int off, int len) throws IOException {
- init();
- file.write(b, off, len);
-
- }
-
- public void flush() throws IOException {
- init();
- file.flush();
- }
-
- public void close() throws IOException {
- init();
- file.close();
- }
- }
-
- /**
- * Converts this class to a class file.
- * Once this method is called, further modifications are not
- * possible any more.
- *
- * <p>This method dose not close the output stream in the end.
- *
- * @param out the output stream that a class file is written to.
- */
- public void toBytecode(DataOutputStream out)
- throws CannotCompileException, IOException
- {
- throw new CannotCompileException("not a class");
- }
-
- /**
- * Makes a unique member name. This method guarantees that
- * the returned name is not used as a prefix of any methods
- * or fields visible in this class.
- * If the returned name is XYZ, then any method or field names
- * in this class do not start with XYZ.
- *
- * @param prefix the prefix of the member name.
- */
- public String makeUniqueName(String prefix) {
- throw new RuntimeException("not available in " + getName());
- }
- }
|