Dex (JEB API)

java.lang.Object
- jeb.api.dex.Dex

```
public class Dex
extends java.lang.Object
```
This class represents the DEX file being processed by JEB.
To better understand the methods of this class as well as the objects returned by these methods, it is encouraged to read the specifications for the DEX format.
Although it is assumed that the reader is familiar with the aforementioned document, here are three examples of fully-qualified names:
- Class: Lcom/foo/bar/Blob;
- Method: Lcom/foo/bar/Blob;->methodX([BILjava/lang/String;)V
- Field: Lcom/foo/bar/Blob;->var:J
This class also defines constants for class/field/method access types, see ACC_xxx constants.
Since:

1.2.201305230

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACC_ABSTRACT`
`static int`	`ACC_ANNOTATION`
`static int`	`ACC_BRIDGE`
`static int`	`ACC_CONSTRUCTOR`
`static int`	`ACC_DECLARED_SYNCHRONIZED`
`static int`	`ACC_ENUM`
`static int`	`ACC_FINAL`
`static int`	`ACC_INTERFACE`
`static int`	`ACC_NATIVE`
`static int`	`ACC_PRIVATE`
`static int`	`ACC_PROTECTED`
`static int`	`ACC_PUBLIC`
`static int`	`ACC_STATIC`
`static int`	`ACC_STRICT`
`static int`	`ACC_SYNCHRONIZED`
`static int`	`ACC_SYNTHETIC`
`static int`	`ACC_TRANSIENT`
`static int`	`ACC_VARARGS`
`static int`	`ACC_VOLATILE`
`static int`	`FLAG_ALERT`
`static int`	`FLAG_CONST`
`static int`	`FLAG_LIBRARY`
`static int`	`FLAG_LIBRARY_EXT`

Constructor Summary

Constructors
Constructor and Description

Dex(java.lang.Object dex_data)
Internal constructor, do not use.

Constructors
Constructor and Description
`Dex(java.lang.Object dex_data)` Internal constructor, do not use.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DexField`	`addFieldReference(java.lang.String signature)` Create or retrieve a new field reference.
`DexMethod`	`addMethodReference(java.lang.String signature)` Create or retrieve a new method reference.
`int`	`addString(java.lang.String str)` Create a new string.
`int`	`addType(java.lang.String typestr)` Create a new type.
`DexClass`	`getClass(int index)` Get a class object by index.
`DexClass`	`getClass(java.lang.String name)` Get a class object by name.
`int`	`getClassCount()` Get the number of classes defined in the DEX file.
`java.util.List<java.lang.String>`	`getClassSignatures(boolean effective)` Get the full list of class signatures.
`java.util.Set<java.lang.Long>`	`getConstants()` Convenience method to retrieve all constants defined in the DEX file.
`byte[]`	`getData()` Get a copy of the entire DEX file.
`int`	`getDexStringCount()` Get the number of strings contained in the original (non-augmented) string pool.
`int`	`getDexTypeCount()` Get the number of types contained in the original (non-augmented) type pool.
`DexField`	`getField(int index)` Get a field description by index.
`int`	`getFieldCount()` Get the number of fields described in the DEX file.
`DexFieldData`	`getFieldData(java.lang.String name)` Retrieve a field definition by name.
`java.util.List<java.lang.Integer>`	`getFieldReferences(int index)` Retrieve the list of methods that reference the provided field.
`java.util.List<java.lang.String>`	`getFieldSignatures(boolean effective)` Get the full list of field signatures.
`DexMethod`	`getMethod(int index)` Get a method description by index.
`int`	`getMethodCount()` Get the number of methods described in the DEX file.
`DexMethodData`	`getMethodData(java.lang.String name)` Retrieve a method definition by name.
`java.util.List<java.lang.Integer>`	`getMethodReferences(int index)` Retrieve the list of methods that reference the provided method.
`java.util.List<java.lang.String>`	`getMethodSignatures(boolean effective)` Get the full list of method signatures.
`DexPrototype`	`getPrototype(int index)` Get a prototype by index.
`int`	`getPrototypeCount()` Get the number of prototypes contained in the DEX file.
`java.lang.String`	`getString(int index)` Get a string from the DEX string pool.
`int`	`getStringCount()` Get the number of strings in the string pool.
`java.util.List<java.lang.String>`	`getStrings()` Retrieve all strings from the DEX pool.
`java.lang.String`	`getType(int index)` Retrieve a type from the type manager.
`java.lang.String`	`getType(int index, boolean effective)` Retrieve a type from the type manager.
`int`	`getTypeCount()` Get the number of types contained in the type manager.
`java.util.List<java.lang.Integer>`	`getTypeReferences(int index)` Retrieve the list of methods that reference the provided type.
`boolean`	`setString(int index, java.lang.String string)` Replace a string in the DEX string pool.

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

- Field Detail
  - ACC_PUBLIC
```
public static final int ACC_PUBLIC
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_PRIVATE
```
public static final int ACC_PRIVATE
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_PROTECTED
```
public static final int ACC_PROTECTED
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_STATIC
```
public static final int ACC_STATIC
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_FINAL
```
public static final int ACC_FINAL
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_SYNCHRONIZED
```
public static final int ACC_SYNCHRONIZED
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_VOLATILE
```
public static final int ACC_VOLATILE
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_BRIDGE
```
public static final int ACC_BRIDGE
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_TRANSIENT
```
public static final int ACC_TRANSIENT
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_VARARGS
```
public static final int ACC_VARARGS
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_NATIVE
```
public static final int ACC_NATIVE
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_INTERFACE
```
public static final int ACC_INTERFACE
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_ABSTRACT
```
public static final int ACC_ABSTRACT
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_STRICT
```
public static final int ACC_STRICT
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_SYNTHETIC
```
public static final int ACC_SYNTHETIC
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_ANNOTATION
```
public static final int ACC_ANNOTATION
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_ENUM
```
public static final int ACC_ENUM
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_CONSTRUCTOR
```
public static final int ACC_CONSTRUCTOR
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - ACC_DECLARED_SYNCHRONIZED
```
public static final int ACC_DECLARED_SYNCHRONIZED
```
    Since:
    
    1.2.201305230
    
    See Also:
    
    Constant Field Values
  - FLAG_CONST
```
public static final int FLAG_CONST
```
    Since:
    
    1.3.201307250
    
    See Also:
    
    Constant Field Values
  - FLAG_LIBRARY
```
public static final int FLAG_LIBRARY
```
    Since:
    
    1.3.201307250
    
    See Also:
    
    Constant Field Values
  - FLAG_LIBRARY_EXT
```
public static final int FLAG_LIBRARY_EXT
```
    Since:
    
    1.3.201307250
    
    See Also:
    
    Constant Field Values
  - FLAG_ALERT
```
public static final int FLAG_ALERT
```
    Since:
    
    1.3.201307250
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Dex
```
public Dex(java.lang.Object dex_data)
```
    Internal constructor, do not use.
    Clients should not create instances of this class directly. Use the JebInstance.getDex() method to retrieve a reference on the currently processed DEX file.
    
    Parameters:
    
    dex_data - opaque DEX data
- Method Detail
  - getData
```
public byte[] getData()
```
    Get a copy of the entire DEX file.
    
    Returns:
    
    copy of the DEX file, can be safely modified by the client
    
    Since:
    
    1.2.201305230
  - getString
```
public java.lang.String getString(int index)
```
    Get a string from the DEX string pool.
    
    Parameters:
    
    index - string index
    
    Returns:
    
    the string, or null if the index is out of range
    
    Since:
    
    1.2.201305230
  - getStrings
```
public java.util.List<java.lang.String> getStrings()
```
    Retrieve all strings from the DEX pool. The strings returned are the strings contained in the current pool, not the original DEX file pool. For example, if the original pool was: ["A", "XYZ", "bla"], and that the strings "foo" and "bar" were added, this function will return: ["A", "XYZ", "bla", "foo", "bar"]. The order matters.
    
    Returns:
    
    the list of pool strings, ordered by index
    
    Since:
    
    1.2.201305230
  - getStringCount
```
public int getStringCount()
```
    Get the number of strings in the string pool. The pool may have been augmented (see the documentation for getStrings()), in which case, the number returned would be greater than the original number.
    
    Returns:
    
    the number of strings in the string pool
    
    Since:
    
    1.2.201305230
  - getDexStringCount
```
public int getDexStringCount()
```
    Get the number of strings contained in the original (non-augmented) string pool.
    
    Returns:
    
    the number of strings contained in the DEX file
    
    Since:
    
    1.3.201308090
  - setString
```
public boolean setString(int index,
                         java.lang.String string)
```
    Replace a string in the DEX string pool.
    This method modifies the DEX representation, and should be used with care.
    It is not recommended to replace strings representing class/field/method/type names.
    Replacing strings might break code logic.
    Updated strings are NOT saved to a JEB database.
    
    Parameters:
    
    index - string index
    
    string - new string
    
    Returns:
    
    true if the string was replaced
    
    Since:
    
    1.2.201305230
  - getType
```
public java.lang.String getType(int index)
```
    Retrieve a type from the type manager.
    Equivalent to getType(index, true).
    
    Parameters:
    
    index - the type index
    
    Returns:
    
    the current signature for the type, or null on error
    
    Since:
    
    1.2.201305230
  - getType
```
public java.lang.String getType(int index,
                                boolean effective)
```
    Retrieve a type from the type manager.
    The type manager contains the DEX types as well as artificial types. (An artificial type was added by JEB; it is not contained in the type pool.)
    
    Parameters:
    
    index - the type index
    
    effective - true to get the effective (current) type signature, false to get the original signature
    
    Returns:
    
    the type signature, or null on error. Example: Lcom/farm/Animal; or [[I
    
    Since:
    
    1.4.201309040
  - getTypeCount
```
public int getTypeCount()
```
    Get the number of types contained in the type manager.
    
    Returns:
    
    the number of types
    
    Since:
    
    1.2.201305230
  - getDexTypeCount
```
public int getDexTypeCount()
```
    Get the number of types contained in the original (non-augmented) type pool.
    
    Returns:
    
    the number of types contained in the DEX file
    
    Since:
    
    1.3.201308090
  - getPrototype
```
public DexPrototype getPrototype(int index)
```
    Get a prototype by index.
    
    Parameters:
    
    index - prototype index
    
    Returns:
    
    an object representing the prototype
    
    Since:
    
    1.2.201305230
  - getPrototypeCount
```
public int getPrototypeCount()
```
    Get the number of prototypes contained in the DEX file.
    
    Returns:
    
    the number of prototypes
    
    Since:
    
    1.2.201305230
  - getField
```
public DexField getField(int index)
```
    Get a field description by index.
    The field can be internal (defined in the DEX file, in which case there is an associated FieldData object) or external (simple reference)
    
    Parameters:
    
    index - field index
    
    Returns:
    
    the field object
    
    Since:
    
    1.2.201305230
  - getFieldCount
```
public int getFieldCount()
```
    Get the number of fields described in the DEX file.
    
    Returns:
    
    the number of fields
    
    Since:
    
    1.2.201305230
  - getMethod
```
public DexMethod getMethod(int index)
```
    Get a method description by index.
    The method can be internal (defined in the DEX file, in which case there is an associated MethodData object) or external (simple reference.)
    
    Parameters:
    
    index - method index
    
    Returns:
    
    the method object
    
    Since:
    
    1.2.201305230
  - getMethodCount
```
public int getMethodCount()
```
    Get the number of methods described in the DEX file.
    
    Returns:
    
    the number of methods
    
    Since:
    
    1.2.201305230
  - getFieldData
```
public DexFieldData getFieldData(java.lang.String name)
```
    Retrieve a field definition by name.
    Only internal fields have an associated FieldData object (see encoded_field in the DEX file specification.)
    
    Parameters:
    
    name - field name (can be partial or fully-qualified)
    
    Returns:
    
    the field data object
    
    Since:
    
    1.2.201305230
  - getMethodData
```
public DexMethodData getMethodData(java.lang.String name)
```
    Retrieve a method definition by name.
    Only internal methods have an associated MethodData object (see encoded_method in the DEX file specification.)
    
    Parameters:
    
    name - method name (can be partial or fully-qualified)
    
    Returns:
    
    the method data object
    
    Since:
    
    1.2.201305230
  - getClass
```
public DexClass getClass(int index)
```
    Get a class object by index.
    Every class defined in the DEX file has an associated class object.
    
    Parameters:
    
    index - the class index
    
    Returns:
    
    the class object
    
    Since:
    
    1.2.201305230
  - getClass
```
public DexClass getClass(java.lang.String name)
```
    Get a class object by name.
    
    Parameters:
    
    name - class name (can be partial or fully-qualified)
    
    Returns:
    
    the class object
    
    Since:
    
    1.3.201307250
  - getClassCount
```
public int getClassCount()
```
    Get the number of classes defined in the DEX file.
    
    Returns:
    
    the number of classes
    
    Since:
    
    1.2.201305230
  - getClassSignatures
```
public java.util.List<java.lang.String> getClassSignatures(boolean effective)
```
    Get the full list of class signatures.
    
    Parameters:
    
    effective - indicates if the current names or real names should be retrieved
    
    Returns:
    
    the list of class signatures
    
    Since:
    
    1.2.201305230
  - getMethodSignatures
```
public java.util.List<java.lang.String> getMethodSignatures(boolean effective)
```
    Get the full list of method signatures.
    
    Parameters:
    
    effective - indicates if the current names or real names should be retrieved
    
    Returns:
    
    the list of method signatures (internal and external)
    
    Since:
    
    1.2.201305230
  - getFieldSignatures
```
public java.util.List<java.lang.String> getFieldSignatures(boolean effective)
```
    Get the full list of field signatures.
    
    Parameters:
    
    effective - indicates if the current names or real names should be retrieved
    
    Returns:
    
    the list of fields signatures (internal and external)
    
    Since:
    
    1.2.201305230
  - getConstants
```
public java.util.Set<java.lang.Long> getConstants()
```
    Convenience method to retrieve all constants defined in the DEX file.
    This method has no equivalent in the DEX file format. The DEX parser will build a list of numeric literals used by Dalvik instructions and populate this "artificial" pool with these literals.
    
    Returns:
    
    the set of constants, encoded as long integers
    
    Since:
    
    1.2.201305230
  - getTypeReferences
```
public java.util.List<java.lang.Integer> getTypeReferences(int index)
```
    Retrieve the list of methods that reference the provided type.
    
    Parameters:
    
    index - type index
    
    Returns:
    
    the list of method indexes, may contain duplicates. Null on error.
    
    Since:
    
    1.4.201309040
  - getFieldReferences
```
public java.util.List<java.lang.Integer> getFieldReferences(int index)
```
    Retrieve the list of methods that reference the provided field.
    
    Parameters:
    
    index - field index
    
    Returns:
    
    the list of method indexes, may contain duplicates. Null on error.
    
    Since:
    
    1.4.201309040
  - getMethodReferences
```
public java.util.List<java.lang.Integer> getMethodReferences(int index)
```
    Retrieve the list of methods that reference the provided method.
    
    Parameters:
    
    index - method index
    
    Returns:
    
    the list of method indexes, may contain duplicates. Null on error.
    
    Since:
    
    1.4.201309040
  - addString
```
public int addString(java.lang.String str)
```
    Create a new string. The string is added to the string pool.
    
    Parameters:
    
    str - mandatory string
    
    Returns:
    
    the string index
  - addType
```
public int addType(java.lang.String typestr)
```
    Create a new type. The type is added to the type pool.
    
    Parameters:
    
    typestr - full signature of the field
    
    Returns:
    
    the type index
    
    Throws:
    
    java.lang.IllegalArgumentException - if the type string is invalid and cannot be added to the pool
  - addFieldReference
```
public DexField addFieldReference(java.lang.String signature)
```
    Create or retrieve a new field reference.
    
    Parameters:
    
    signature - full signature of the field
    
    Returns:
    
    the field object, null on error
  - addMethodReference
```
public DexMethod addMethodReference(java.lang.String signature)
```
    Create or retrieve a new method reference.
    
    Parameters:
    
    signature - full signature of the method
    
    Returns:
    
    the method object, null on error

Class Dex

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACC_PUBLIC

ACC_PRIVATE

ACC_PROTECTED

ACC_STATIC

ACC_FINAL

ACC_SYNCHRONIZED

ACC_VOLATILE

ACC_BRIDGE

ACC_TRANSIENT

ACC_VARARGS

ACC_NATIVE

ACC_INTERFACE

ACC_ABSTRACT

ACC_STRICT

ACC_SYNTHETIC

ACC_ANNOTATION

ACC_ENUM

ACC_CONSTRUCTOR

ACC_DECLARED_SYNCHRONIZED

FLAG_CONST

FLAG_LIBRARY

FLAG_LIBRARY_EXT

FLAG_ALERT

Constructor Detail

Dex

Method Detail

getData

getString

getStrings

getStringCount

getDexStringCount

setString

getType

getType

getTypeCount

getDexTypeCount

getPrototype

getPrototypeCount

getField

getFieldCount

getMethod

getMethodCount

getFieldData

getMethodData

getClass

getClass

getClassCount

getClassSignatures

getMethodSignatures

getFieldSignatures

getConstants

getTypeReferences

getFieldReferences

getMethodReferences

addString

addType

addFieldReference

addMethodReference