ClassFile (XApi - Dev uber jar 0.5 API)

java.lang.Object
- xapi.bytecode.ClassFile

All Implemented Interfaces:: Annotated

public final class ClassFile
extends Object
implements Annotated

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`JAVA_1` The major version number of class files for JDK 1.1.
`static int`	`JAVA_2` The major version number of class files for JDK 1.2.
`static int`	`JAVA_3` The major version number of class files for JDK 1.3.
`static int`	`JAVA_4` The major version number of class files for JDK 1.4.
`static int`	`JAVA_5` The major version number of class files for JDK 1.5.
`static int`	`JAVA_6` The major version number of class files for JDK 1.6.
`static int`	`JAVA_7` The major version number of class files for JDK 1.7.
`static int`	`MAJOR_VERSION` The major version number of class files created from scratch.

Constructor Summary

Constructors
Constructor and Description
`ClassFile(boolean isInterface, String classname, String superclass)` Constructs a class file including no members.
`ClassFile(DataInput in)` Constructs a class file from a byte stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(AttributeInfo info)` Appends an attribute.
`void`	`addField(FieldInfo finfo)` Appends a field to the class.
`void`	`addInterface(String name)` Appends an interface to the interfaces implemented by the class.
`void`	`addMethod(MethodInfo minfo)` Just appends a method to the class.
`void`	`compact()` Eliminates dead constant pool items.
`boolean`	`equals(Object obj)`
`int`	`getAccessFlags()` Returns access flags.
`Annotation`	`getAnnotation(Class<?> annoClass)`
`<T extends Annotation> T`	`getAnnotation(Class<T> annoClass, ClassLoader loader)`
`Annotation`	`getAnnotation(String name)` This method is for lazy programmers only; it checks both runtime and compile annotations.
`Annotation[]`	`getAnnotations()`
`AttributeInfo`	`getAttribute(String name)` Returns the attribute with the specified name.
`List<AttributeInfo>`	`getAttributes()` Returns all the attributes.
`Annotation`	`getCompileAnnotation(String name)` This method returns any compile annotations on the given classfile.
`ConstPool`	`getConstPool()` Returns a constant pool table.
`String`	`getEnclosedName()`
`List<FieldInfo>`	`getFields()` Returns all the fields declared in the class.
`int`	`getInnerAccessFlags()` Returns access and property flags of this nested class.
`String[]`	`getInterfaces()` Returns the names of the interfaces implemented by the class.
`int`	`getMajorVersion()` Get the Major version.
`MethodInfo`	`getMethod(String name)` Returns the method with the specified name.
`List<MethodInfo>`	`getMethods()` Returns all the methods declared in the class.
`int`	`getMinorVersion()` Get the minor version.
`String`	`getName()` Returns the class name.
`String`	`getPackage()`
`String`	`getQualifiedName()`
`String`	`getResourceName()`
`Annotation`	`getRuntimeAnnotation(String name)` This method returns any runtime annotations on the given classfile.
`String`	`getSimpleName()`
`String`	`getSourceFile()` Returns the source file containing this class.
`String`	`getSuperclass()` Returns the super class name.
`int`	`getSuperclassId()` Returns the index of the constant pool entry representing the super class.
`int`	`getThisClassIndex()`
`boolean`	`hasAnnotation(Class<?> annoClass)`
`int`	`hashCode()`
`boolean`	`hasSuperClass(String superClass)`
`boolean`	`isAbstract()` Returns true if this is an abstract class or an interface.
`boolean`	`isClass(String pkg, String enclosed)`
`boolean`	`isFinal()` Returns true if this is a final class or interface.
`boolean`	`isInterface()` Returns true if this is an interface.
`void`	`prune()` Discards all attributes, associated with both the class file and the members such as a code attribute and exceptions attribute.
`void`	`renameClass(Map<?,?> classnames)` Replaces all occurrences of several class names in the class file.
`void`	`renameClass(String oldname, String newname)` Replaces all occurrences of a class name in the class file.
`void`	`setAccessFlags(int acc)` Changes access flags.
`void`	`setInterfaces(String[] nameList)` Sets the interfaces.
`void`	`setMajorVersion(int major)` Set the major version.
`void`	`setMinorVersion(int minor)` Set the minor version.
`void`	`setName(String name)` Sets the class name.
`void`	`setSuperclass(String superclass)` Sets the super class.
`void`	`setVersionToJava5()` Sets the major and minor version to Java 5.
`String`	`toString()`
`void`	`write(DataOutputStream out)` Writes a class file represented by this object into an output stream.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JAVA_1
```
public static final int JAVA_1
```
    The major version number of class files for JDK 1.1.
    
    See Also:
    
    Constant Field Values
  - JAVA_2
```
public static final int JAVA_2
```
    The major version number of class files for JDK 1.2.
    
    See Also:
    
    Constant Field Values
  - JAVA_3
```
public static final int JAVA_3
```
    The major version number of class files for JDK 1.3.
    
    See Also:
    
    Constant Field Values
  - JAVA_4
```
public static final int JAVA_4
```
    The major version number of class files for JDK 1.4.
    
    See Also:
    
    Constant Field Values
  - JAVA_5
```
public static final int JAVA_5
```
    The major version number of class files for JDK 1.5.
    
    See Also:
    
    Constant Field Values
  - JAVA_6
```
public static final int JAVA_6
```
    The major version number of class files for JDK 1.6.
    
    See Also:
    
    Constant Field Values
  - JAVA_7
```
public static final int JAVA_7
```
    The major version number of class files for JDK 1.7.
    
    See Also:
    
    Constant Field Values
  - MAJOR_VERSION
```
public static int MAJOR_VERSION
```
    The major version number of class files created from scratch. The default value is 47 (JDK 1.3) or 49 (JDK 1.5) if the JVM supports java.lang.StringBuilder.
- Constructor Detail
  - ClassFile
```
public ClassFile(DataInput in)
          throws IOException
```
    Constructs a class file from a byte stream.
    
    Throws:
    
    IOException
  - ClassFile
```
public ClassFile(boolean isInterface,
                 String classname,
                 String superclass)
```
    Constructs a class file including no members.
    
    Parameters:
    
    isInterface - true if this is an interface. false if this is a class.
    
    classname - a fully-qualified class name
    
    superclass - a fully-qualified super class name
- Method Detail
  - compact
```
public void compact()
```
    Eliminates dead constant pool items. If a method or a field is removed, the constant pool items used by that method/field become dead items. This method recreates a constant pool.
  - prune
```
public void prune()
```
    Discards all attributes, associated with both the class file and the members such as a code attribute and exceptions attribute. The unused constant pool entries are also discarded (a new packed constant pool is constructed).
  - getConstPool
```
public ConstPool getConstPool()
```
    Returns a constant pool table.
  - isInterface
```
public boolean isInterface()
```
    Returns true if this is an interface.
  - isFinal
```
public boolean isFinal()
```
    Returns true if this is a final class or interface.
  - isAbstract
```
public boolean isAbstract()
```
    Returns true if this is an abstract class or an interface.
  - getAccessFlags
```
public int getAccessFlags()
```
    Returns access flags.
    
    See Also:
    
    javassist.bytecode.AccessFlag
  - setAccessFlags
```
public void setAccessFlags(int acc)
```
    Changes access flags.
    
    See Also:
    
    javassist.bytecode.AccessFlag
  - getInnerAccessFlags
```
public int getInnerAccessFlags()
```
    Returns access and property flags of this nested class. This method returns -1 if the class is not a nested class.
    The returned value is obtained from inner_class_access_flags of the entry representing this nested class itself in InnerClasses_attribute>.
  - getThisClassIndex
```
public int getThisClassIndex()
```
  - getName
```
public String getName()
```
    Returns the class name.
  - setName
```
public void setName(String name)
```
    Sets the class name. This method substitutes the new name for all occurrences of the old class name in the class file.
  - getSuperclass
```
public String getSuperclass()
```
    Returns the super class name.
  - getSuperclassId
```
public int getSuperclassId()
```
    Returns the index of the constant pool entry representing the super class.
  - setSuperclass
```
public void setSuperclass(String superclass)
```
    Sets the super class.
    The new super class should inherit from the old super class. This method modifies constructors so that they call constructors declared in the new super class.
  - renameClass
```
public final void renameClass(String oldname,
                              String newname)
```
    Replaces all occurrences of a class name in the class file.
    If class X is substituted for class Y in the class file, X and Y must have the same signature. If Y provides a method m(), X must provide it even if X inherits m() from the super class. If this fact is not guaranteed, the bytecode verifier may cause an error.
    
    Parameters:
    
    oldname - the replaced class name
    
    newname - the substituted class name
  - renameClass
```
public final void renameClass(Map<?,?> classnames)
```
    Replaces all occurrences of several class names in the class file.
    
    Parameters:
    
    classnames - specifies which class name is replaced with which new name. Class names must be described with the JVM-internal representation like java/lang/Object.
    
    See Also:
    
    renameClass(String,String)
  - getInterfaces
```
public String[] getInterfaces()
```
    Returns the names of the interfaces implemented by the class. The returned array is read only.
  - setInterfaces
```
public void setInterfaces(String[] nameList)
```
    Sets the interfaces.
    
    Parameters:
    
    nameList - the names of the interfaces.
  - addInterface
```
public void addInterface(String name)
```
    Appends an interface to the interfaces implemented by the class.
  - getFields
```
public List<FieldInfo> getFields()
```
    Returns all the fields declared in the class.
    
    Returns:
    
    a list of FieldInfo.
    
    See Also:
    
    FieldInfo
  - addField
```
public void addField(FieldInfo finfo)
```
    Appends a field to the class. Does not check for existing fields.
  - getMethods
```
public List<MethodInfo> getMethods()
```
    Returns all the methods declared in the class.
    
    Returns:
    
    a list of MethodInfo.
    
    See Also:
    
    MethodInfo
  - getMethod
```
public MethodInfo getMethod(String name)
```
    Returns the method with the specified name. If there are multiple methods with that name, this method returns one of them.
    
    Returns:
    
    null if no such a method is found.
  - addMethod
```
public final void addMethod(MethodInfo minfo)
```
    Just appends a method to the class. It does not check method duplication or remove a bridge method. Use this method only when minimizing performance overheads is seriously required.
    
    Since:
    
    3.13
  - getAttributes
```
public List<AttributeInfo> getAttributes()
```
    Returns all the attributes. The returned List object is shared with this object. If you add a new attribute to the list, the attribute is also added to the classs file represented by this object. If you remove an attribute from the list, it is also removed from the class file.
    
    Returns:
    
    a list of AttributeInfo objects.
    
    See Also:
    
    AttributeInfo
  - getAttribute
```
public AttributeInfo getAttribute(String name)
```
    Returns the attribute with the specified name. If there are multiple attributes with that name, this method returns either of them. It returns null if the specified attributed is not found.
    
    Parameters:
    
    name - attribute name
    
    See Also:
    
    getAttributes()
  - addAttribute
```
public void addAttribute(AttributeInfo info)
```
    Appends an attribute. If there is already an attribute with the same name, the new one substitutes for it.
    
    See Also:
    
    getAttributes()
  - getSourceFile
```
public String getSourceFile()
```
    Returns the source file containing this class.
    
    Returns:
    
    null if this information is not available.
  - write
```
public void write(DataOutputStream out)
           throws IOException
```
    Writes a class file represented by this object into an output stream.
    
    Throws:
    
    IOException
  - getMajorVersion
```
public int getMajorVersion()
```
    Get the Major version.
    
    Returns:
    
    the major version
  - setMajorVersion
```
public void setMajorVersion(int major)
```
    Set the major version.
    
    Parameters:
    
    major - the major version
  - getMinorVersion
```
public int getMinorVersion()
```
    Get the minor version.
    
    Returns:
    
    the minor version
  - setMinorVersion
```
public void setMinorVersion(int minor)
```
    Set the minor version.
    
    Parameters:
    
    minor - the minor version
  - setVersionToJava5
```
public void setVersionToJava5()
```
    Sets the major and minor version to Java 5. If the major version is older than 49, Java 5 extensions such as annotations are ignored by the JVM.
  - getAnnotation
```
public Annotation getAnnotation(String name)
```
    This method is for lazy programmers only; it checks both runtime and compile annotations. You should know what retention your annotations are set to, but in case you aren't sure, this method checks them all.
    
    Specified by:
    
    getAnnotation in interface Annotated
    
    Parameters:
    
    name - - The fully qualified annotation name
    
    Returns:
    
    - An annotation descriptor of the type you want.
  - getAnnotation
```
public Annotation getAnnotation(Class<?> annoClass)
```
  - hasAnnotation
```
public boolean hasAnnotation(Class<?> annoClass)
```
  - getAnnotation
```
public <T extends Annotation> T getAnnotation(Class<T> annoClass,
                                              ClassLoader loader)
                                       throws ClassNotFoundException,
                                              NoSuchClassError
```
    Throws:
    
    ClassNotFoundException
    
    NoSuchClassError
  - getAnnotations
```
public Annotation[] getAnnotations()
```
    Specified by:
    
    getAnnotations in interface Annotated
    
    Returns:
    
    all compiletime and runtime annotations present on this class file.
  - getRuntimeAnnotation
```
public Annotation getRuntimeAnnotation(String name)
```
    This method returns any runtime annotations on the given classfile.
    
    Parameters:
    
    name - - The fully qualified annotation name
    
    Returns:
    
    - An annotation descriptor of the type you want.
  - getCompileAnnotation
```
public Annotation getCompileAnnotation(String name)
```
    This method returns any compile annotations on the given classfile.
    
    Parameters:
    
    name - - The fully qualified annotation name
    
    Returns:
    
    - An annotation descriptor of the type you want.
  - getPackage
```
public String getPackage()
```
  - getEnclosedName
```
public String getEnclosedName()
```
  - getSimpleName
```
public String getSimpleName()
```
  - getQualifiedName
```
public String getQualifiedName()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getResourceName
```
public String getResourceName()
```
  - isClass
```
public boolean isClass(String pkg,
                       String enclosed)
```
  - hasSuperClass
```
public boolean hasSuperClass(String superClass)
```

Class ClassFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAVA_1

JAVA_2

JAVA_3

JAVA_4

JAVA_5

JAVA_6

JAVA_7

MAJOR_VERSION

Constructor Detail

ClassFile

ClassFile

Method Detail

compact

prune

getConstPool

isInterface

isFinal

isAbstract

getAccessFlags

setAccessFlags

getInnerAccessFlags

getThisClassIndex

getName

setName

getSuperclass

getSuperclassId

setSuperclass

renameClass

renameClass

getInterfaces

setInterfaces

addInterface

getFields

addField

getMethods

getMethod

addMethod

getAttributes

getAttribute

addAttribute

getSourceFile

write

getMajorVersion

setMajorVersion

getMinorVersion

setMinorVersion

setVersionToJava5

getAnnotation

getAnnotation

hasAnnotation

getAnnotation

getAnnotations

getRuntimeAnnotation

getCompileAnnotation

getPackage

getEnclosedName

getSimpleName

getQualifiedName

hashCode

equals

toString

getResourceName

isClass

hasSuperClass