Package org.jf.dexlib2.dexbacked

Class DexBackedField

java.lang.Object

org.jf.dexlib2.base.reference.BaseReference

org.jf.dexlib2.base.reference.BaseFieldReference

org.jf.dexlib2.dexbacked.DexBackedField

All Implemented Interfaces:

Comparable<FieldReference>, Annotatable, Field, Member, FieldReference, Reference

public class DexBackedField
extends BaseFieldReference
implements Field

Nested Class Summary

Nested classes/interfaces inherited from interface org.jf.dexlib2.iface.reference.Reference

Reference.InvalidReferenceException

Field Summary

Fields

Modifier and Type	Field	Description
final int	accessFlags
final int	annotationSetOffset
final ClassDef	classDef
final DexBackedDexFile	dexFile
private int	fieldIdItemOffset
final int	fieldIndex
private final int	hiddenApiRestrictions
final EncodedValue	initialValue
private final int	initialValueOffset
private final int	startOffset

Constructor Summary

Constructors

Constructor	Description
DexBackedField(DexBackedDexFile dexFile, DexReader reader, DexBackedClassDef classDef, int previousFieldIndex, AnnotationsDirectory.AnnotationIterator annotationIterator, int hiddenApiRestrictions)
DexBackedField(DexBackedDexFile dexFile, DexReader reader, DexBackedClassDef classDef, int previousFieldIndex, EncodedArrayItemIterator staticInitialValueIterator, AnnotationsDirectory.AnnotationIterator annotationIterator, int hiddenApiRestrictions)

Method Summary

Modifier and Type	Method	Description
int	getAccessFlags()	Gets the access flags for this field.
Set<? extends DexBackedAnnotation>	getAnnotations()	Gets a set of the annotations that are applied to this field.
String	getDefiningClass()	Gets the type of the class that defines this field.
private int	getFieldIdItemOffset()
Set<HiddenApiRestriction>	getHiddenApiRestrictions()	Gets the hidden api restrictions for this field.
EncodedValue	getInitialValue()	Gets the initial value for this field, if available.
String	getName()	Gets the name of this field.
int	getSize()	Calculate and return the private size of a field definition.
String	getType()	Gets the type of this field.
static void	skipFields(DexReader reader, int count)	Skips the reader over the specified number of encoded_field structures

Methods inherited from class org.jf.dexlib2.base.reference.BaseFieldReference

compareTo, equals, hashCode, toString

Methods inherited from class org.jf.dexlib2.base.reference.BaseReference

validateReference

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jf.dexlib2.iface.reference.FieldReference

compareTo, equals, hashCode

Methods inherited from interface org.jf.dexlib2.iface.reference.Reference

validateReference

Field Details

dexFile

@Nonnull
public final DexBackedDexFile dexFile

classDef

@Nonnull
public final ClassDef classDef

accessFlags

public final int accessFlags

initialValue

@Nullable
public final EncodedValue initialValue

annotationSetOffset

public final int annotationSetOffset

fieldIndex

public final int fieldIndex

startOffset

private final int startOffset

initialValueOffset

private final int initialValueOffset

hiddenApiRestrictions

private final int hiddenApiRestrictions

fieldIdItemOffset

private int fieldIdItemOffset

Constructor Details

DexBackedField

public DexBackedField(@Nonnull
 DexBackedDexFile dexFile,
 @Nonnull
 DexReader reader,
 @Nonnull
 DexBackedClassDef classDef,
 int previousFieldIndex,
 @Nonnull
 EncodedArrayItemIterator staticInitialValueIterator,
 @Nonnull
 AnnotationsDirectory.AnnotationIterator annotationIterator,
 int hiddenApiRestrictions)

DexBackedField

public DexBackedField(@Nonnull
 DexBackedDexFile dexFile,
 @Nonnull
 DexReader reader,
 @Nonnull
 DexBackedClassDef classDef,
 int previousFieldIndex,
 @Nonnull
 AnnotationsDirectory.AnnotationIterator annotationIterator,
 int hiddenApiRestrictions)

Method Details

getName

@Nonnull
public String getName()

Description copied from interface: Field

Gets the name of this field.

Specified by:

getName in interface Field

Specified by:

getName in interface FieldReference

Specified by:

getName in interface Member

Returns:

The name of this field

getType

@Nonnull
public String getType()

Description copied from interface: Field

Gets the type of this field.

Specified by:

getType in interface Field

Specified by:

getType in interface FieldReference

Returns:

The type of this field

getDefiningClass

@Nonnull
public String getDefiningClass()

Description copied from interface: Field

Gets the type of the class that defines this field.

Specified by:

getDefiningClass in interface Field

Specified by:

getDefiningClass in interface FieldReference

Specified by:

getDefiningClass in interface Member

Returns:

The type of the class that defines this field

getAccessFlags

public int getAccessFlags()

Description copied from interface: Field

Gets the access flags for this field. This will be a combination of the AccessFlags.* flags that are marked as compatible for use with a field.

Specified by:

getAccessFlags in interface Field

Specified by:

getAccessFlags in interface Member

Returns:

The access flags for this field

getInitialValue

@Nullable
public EncodedValue getInitialValue()

Description copied from interface: Field

Gets the initial value for this field, if available. Only static field may have an initial value set, but are not required to have an initial value.

Specified by:

getInitialValue in interface Field

Returns:

The initial value for this field, or null if this field is not a static field, or if this static field does not have an initial value.

getAnnotations

@Nonnull
public Set<? extends DexBackedAnnotation> getAnnotations()

Description copied from interface: Field

Gets a set of the annotations that are applied to this field. The annotations in the returned set are guaranteed to have unique types.

Specified by:

getAnnotations in interface Annotatable

Specified by:

getAnnotations in interface Field

Returns:

A set of the annotations that are applied to this field

getHiddenApiRestrictions

@Nonnull
public Set<HiddenApiRestriction> getHiddenApiRestrictions()

Description copied from interface: Field

Gets the hidden api restrictions for this field. This will contain at most 1 normal flag (with isDomainSpecificApiFlag() = false), and 1 domain-specific api flag (with isDomainSpecificApiFlag() = true)

Specified by:

getHiddenApiRestrictions in interface Field

Specified by:

getHiddenApiRestrictions in interface Member

Returns:

A set of the hidden api restrictions for this field.

skipFields

public static void skipFields(@Nonnull
 DexReader reader,
 int count)

Skips the reader over the specified number of encoded_field structures

Parameters:

reader - The reader to skip

count - The number of encoded_field structures to skip over

getFieldIdItemOffset

private int getFieldIdItemOffset()

getSize

public int getSize()

Calculate and return the private size of a field definition. Calculated as: field_idx_diff + access_flags + annotations overhead + initial value size + field reference size

Returns:

size in bytes