ClassModel (Aparapi 1.2.0 API)

java.lang.Object
- com.aparapi.internal.model.ClassModel

```
public class ClassModel
extends Object
```
Class represents a ClassFile (MyClass.class). A ClassModel is constructed from an instance of a java.lang.Class. If the java class mode changes we may need to modify this to accommodate.

Author:

gfrost

See Also:

Java 5 Class File Format + * @see Java 7 Class File Format

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClassModel.Access`
`class`	`ClassModel.AttributePool`
`class`	`ClassModel.ClassModelField`
`class`	`ClassModel.ClassModelInterface`
`class`	`ClassModel.ClassModelMethod`
`class`	`ClassModel.ConstantPool`
`static class`	`ClassModel.ConstantPoolType`
`static interface`	`ClassModel.LocalVariableInfo`
`static interface`	`ClassModel.LocalVariableTableEntry<T extends ClassModel.LocalVariableInfo>`
`static class`	`ClassModel.MethodDescription`

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`SIGC_ARRAY`
`static char`	`SIGC_BOOLEAN`
`static char`	`SIGC_BYTE`
`static char`	`SIGC_CHAR`
`static char`	`SIGC_CLASS`
`static char`	`SIGC_DOUBLE`
`static char`	`SIGC_END_CLASS`
`static char`	`SIGC_END_METHOD`
`static char`	`SIGC_FLOAT`
`static char`	`SIGC_INT`
`static char`	`SIGC_LONG`
`static char`	`SIGC_PACKAGE`
`static char`	`SIGC_SHORT`
`static char`	`SIGC_START_METHOD`
`static char`	`SIGC_VOID`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`convert(String _string)`
`static String`	`convert(String _string, String _insert)`
`static String`	`convert(String _string, String _insert, boolean _showFullClassName)`
`static ClassModel`	`createClassModel(Class<?> _class)`
`int`	`getAccessFlags()`
`ClassModel.AttributePool`	`getAttributePool()`
`Class<?>`	`getClassWeAreModelling()`
`ClassModel.ConstantPool`	`getConstantPool()`
`Entrypoint`	`getEntrypoint()`
`Entrypoint`	`getEntrypoint(String _entrypointName, Object _k)`
`ClassModel.ClassModelField`	`getField(String _name)`
`ClassModel.ClassModelField`	`getField(String _name, String _descriptor)`
`List<ClassModel.ClassModelField>`	`getFieldPoolEntries()`
`int`	`getMagic()`
`int`	`getMajorVersion()`
`ClassModel.ClassModelMethod`	`getMethod(ClassModel.ConstantPool.MethodEntry _methodEntry, boolean _isSpecial)` Look up a ConstantPool MethodEntry and return the corresponding Method.
`ClassModel.ClassModelMethod`	`getMethod(String _name, String _descriptor)`
`static ClassModel.MethodDescription`	`getMethodDescription(String _string)`
`MethodModel`	`getMethodModel(String _name, String _signature)` Create a MethodModel for a given method name and signature.
`int`	`getMinorVersion()`
`Set<String>`	`getNoCLMethods()`
`Integer`	`getPrivateMemorySize(String fieldName)` If a field does not satisfy the private memory conditions, null, otherwise the size of private memory required.
`static Integer`	`getPrivateMemorySizeFromField(Field field)`
`static Integer`	`getPrivateMemorySizeFromFieldName(String fieldName)`
`ArrayList<Long>`	`getStructMemberOffsets()`
`ArrayList<ClassModel.ConstantPool.FieldEntry>`	`getStructMembers()`
`ArrayList<InstructionSet.TypeSpec>`	`getStructMemberTypes()`
`int`	`getSuperClassConstantPoolIndex()`
`ClassModel`	`getSuperClazz()` Getter for superClazz
`int`	`getThisClassConstantPoolIndex()`
`int`	`getTotalStructSize()`
`static void`	`invalidateCaches()`
`boolean`	`isSuperClass(Class<?> other)` Determine if this is the superclass of some other class.
`boolean`	`isSuperClass(String otherClassName)` Determine if this is the superclass of some other named class.
`void`	`parse(Class<?> _class)` We extract the class's classloader and name and delegate to private parse method.
`void`	`replaceSuperClazz(ClassModel c)`
`void`	`setTotalStructSize(int x)`
`String`	`toString()`
`static String`	`typeName(char _typeChar)` Convert a given JNI character type (say 'I') to its type name ('int').

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- SIGC_VOID
```
public static final char SIGC_VOID
```
  See Also:
  
  Constant Field Values
- SIGC_BOOLEAN
```
public static final char SIGC_BOOLEAN
```
  See Also:
  
  Constant Field Values
- SIGC_BYTE
```
public static final char SIGC_BYTE
```
  See Also:
  
  Constant Field Values
- SIGC_CHAR
```
public static final char SIGC_CHAR
```
  See Also:
  
  Constant Field Values
- SIGC_SHORT
```
public static final char SIGC_SHORT
```
  See Also:
  
  Constant Field Values
- SIGC_INT
```
public static final char SIGC_INT
```
  See Also:
  
  Constant Field Values
- SIGC_LONG
```
public static final char SIGC_LONG
```
  See Also:
  
  Constant Field Values
- SIGC_FLOAT
```
public static final char SIGC_FLOAT
```
  See Also:
  
  Constant Field Values
- SIGC_DOUBLE
```
public static final char SIGC_DOUBLE
```
  See Also:
  
  Constant Field Values
- SIGC_ARRAY
```
public static final char SIGC_ARRAY
```
  See Also:
  
  Constant Field Values
- SIGC_CLASS
```
public static final char SIGC_CLASS
```
  See Also:
  
  Constant Field Values
- SIGC_START_METHOD
```
public static final char SIGC_START_METHOD
```
  See Also:
  
  Constant Field Values
- SIGC_END_CLASS
```
public static final char SIGC_END_CLASS
```
  See Also:
  
  Constant Field Values
- SIGC_END_METHOD
```
public static final char SIGC_END_METHOD
```
  See Also:
  
  Constant Field Values
- SIGC_PACKAGE
```
public static final char SIGC_PACKAGE
```
  See Also:
  
  Constant Field Values

Method Detail

isSuperClass
```
public boolean isSuperClass(String otherClassName)
```
Determine if this is the superclass of some other named class.

Parameters:

otherClassName - The name of the class to compare against

Returns:

true if 'this' a superclass of another named class

isSuperClass
```
public boolean isSuperClass(Class<?> other)
```
Determine if this is the superclass of some other class.

Parameters:

other - The class to compare against

Returns:

true if 'this' a superclass of another class

getSuperClazz
```
public ClassModel getSuperClazz()
```
Getter for superClazz

Returns:

the superClazz ClassModel

replaceSuperClazz

public void replaceSuperClazz(ClassModel c)

typeName
```
public static String typeName(char _typeChar)
```
Convert a given JNI character type (say 'I') to its type name ('int').

Parameters:

_typeChar -

Returns:

either a mapped type name or null if no mapping exists.

getPrivateMemorySize
```
public Integer getPrivateMemorySize(String fieldName)
                             throws ClassParseException
```
If a field does not satisfy the private memory conditions, null, otherwise the size of private memory required.

Throws:

ClassParseException

getPrivateMemorySizeFromField

public static Integer getPrivateMemorySizeFromField(Field field)

getPrivateMemorySizeFromFieldName

public static Integer getPrivateMemorySizeFromFieldName(String fieldName)
                                                 throws ClassParseException

Throws:: ClassParseException

getNoCLMethods
```
public Set<String> getNoCLMethods()
```

convert

public static String convert(String _string)

convert

public static String convert(String _string,
                             String _insert)

convert

public static String convert(String _string,
                             String _insert,
                             boolean _showFullClassName)

getMethodDescription

public static ClassModel.MethodDescription getMethodDescription(String _string)

createClassModel

public static ClassModel createClassModel(Class<?> _class)
                                   throws ClassParseException

Throws:: ClassParseException

parse
```
public void parse(Class<?> _class)
           throws ClassParseException
```
We extract the class's classloader and name and delegate to private parse method.

Parameters:

_class - The class we wish to model

Throws:

ClassParseException

getMagic
```
public int getMagic()
```

getMajorVersion
```
public int getMajorVersion()
```

getMinorVersion
```
public int getMinorVersion()
```

getAccessFlags
```
public int getAccessFlags()
```

getConstantPool

public ClassModel.ConstantPool getConstantPool()

getThisClassConstantPoolIndex

public int getThisClassConstantPoolIndex()

getSuperClassConstantPoolIndex

public int getSuperClassConstantPoolIndex()

getAttributePool

public ClassModel.AttributePool getAttributePool()

getField

public ClassModel.ClassModelField getField(String _name,
                                           String _descriptor)

getField

public ClassModel.ClassModelField getField(String _name)

getMethod

public ClassModel.ClassModelMethod getMethod(String _name,
                                             String _descriptor)

getFieldPoolEntries

public List<ClassModel.ClassModelField> getFieldPoolEntries()

getMethod
```
public ClassModel.ClassModelMethod getMethod(ClassModel.ConstantPool.MethodEntry _methodEntry,
                                             boolean _isSpecial)
```
Look up a ConstantPool MethodEntry and return the corresponding Method.

Parameters:

_methodEntry - The ConstantPool MethodEntry we want.

_isSpecial - True if we wish to delegate to super (to support super.foo())

Returns:

The Method or null if we fail to locate a given method.

getMethodModel

public MethodModel getMethodModel(String _name,
                                  String _signature)
                           throws AparapiException

Create a MethodModel for a given method name and signature.

Parameters:: _name -; _signature -
Returns:
Throws:: AparapiException

getStructMembers

public ArrayList<ClassModel.ConstantPool.FieldEntry> getStructMembers()

getStructMemberOffsets

public ArrayList<Long> getStructMemberOffsets()

getStructMemberTypes

public ArrayList<InstructionSet.TypeSpec> getStructMemberTypes()

getTotalStructSize
```
public int getTotalStructSize()
```

setTotalStructSize

public void setTotalStructSize(int x)

getClassWeAreModelling

public Class<?> getClassWeAreModelling()

getEntrypoint

public Entrypoint getEntrypoint(String _entrypointName,
                                Object _k)
                         throws AparapiException

Throws:: AparapiException

getEntrypoint

public Entrypoint getEntrypoint()
                         throws AparapiException

Throws:: AparapiException

invalidateCaches
```
public static void invalidateCaches()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class ClassModel

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIGC_VOID

SIGC_BOOLEAN

SIGC_BYTE

SIGC_CHAR

SIGC_SHORT

SIGC_INT

SIGC_LONG

SIGC_FLOAT

SIGC_DOUBLE

SIGC_ARRAY

SIGC_CLASS

SIGC_START_METHOD

SIGC_END_CLASS

SIGC_END_METHOD

SIGC_PACKAGE

Method Detail

isSuperClass

isSuperClass

getSuperClazz

replaceSuperClazz

typeName

getPrivateMemorySize

getPrivateMemorySizeFromField

getPrivateMemorySizeFromFieldName

getNoCLMethods

convert

convert

convert

getMethodDescription

createClassModel

parse

getMagic

getMajorVersion

getMinorVersion

getAccessFlags

getConstantPool

getThisClassConstantPoolIndex

getSuperClassConstantPoolIndex

getAttributePool

getField

getField

getMethod

getFieldPoolEntries

getMethod

getMethodModel

getStructMembers

getStructMemberOffsets

getStructMemberTypes

getTotalStructSize

setTotalStructSize

getClassWeAreModelling

getEntrypoint

getEntrypoint

invalidateCaches

toString