com.android.dx.dex.file
Class DebugInfoItem

java.lang.Object
  com.android.dx.dex.file.Item
      com.android.dx.dex.file.OffsettedItem
          com.android.dx.dex.file.DebugInfoItem

All Implemented Interfaces:

Comparable<OffsettedItem>

public class DebugInfoItem
extends OffsettedItem

Constructor Summary

DebugInfoItem(DalvCode code, boolean isStatic, CstMethodRef ref)

Method Summary

void	addContents(DexFile file) Populates a DexFile with items from within this instance.
void	annotateTo(DexFile file, AnnotatedOutput out, String prefix) Writes annotations for the elements of this list, as zero-length.
void	debugPrint(PrintWriter out, String prefix) Does a human-friendly dump of this instance.
ItemType	itemType() Returns the item type for this instance.
protected void	place0(Section addedTo, int offset) Does additional work required when placing an instance.
String	toHuman() Gets a short human-readable string representing this instance.
protected void	writeTo0(DexFile file, AnnotatedOutput out) Performs the actual write of the contents of this instance to the given data section.

Methods inherited from class com.android.dx.dex.file.OffsettedItem

compareTo, compareTo0, equals, getAbsoluteOffset, getAbsoluteOffsetOr0, getAlignment, getRelativeOffset, offsetString, place, setWriteSize, writeSize, writeTo

Methods inherited from class com.android.dx.dex.file.Item

typeName

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DebugInfoItem

public DebugInfoItem(DalvCode code,
                     boolean isStatic,
                     CstMethodRef ref)

Method Detail

itemType

public ItemType itemType()

Returns the item type for this instance.

Specified by:

itemType in class Item

Returns:

non-null; the item type

addContents

public void addContents(DexFile file)

Populates a DexFile with items from within this instance. This will not add an item to the file for this instance itself (which should have been done by whatever refers to this instance).

Note: Subclasses must override this to do something appropriate.

Specified by:

addContents in class Item

Parameters:

file - non-null; the file to populate

place0

protected void place0(Section addedTo,
                      int offset)

Does additional work required when placing an instance. The default implementation of this method is a no-op. If a particular class needs to do something special, then it should override this method. In particular, if this instance did not know its write size up-front, then this method is responsible for setting it.

Overrides:

place0 in class OffsettedItem

Parameters:

addedTo - non-null; the section this instance has been added to

offset - >= 0; the offset from the start of the section where this instance was placed

toHuman

public String toHuman()

Gets a short human-readable string representing this instance.

Specified by:

toHuman in class OffsettedItem

Returns:

non-null; the human form

annotateTo

public void annotateTo(DexFile file,
                       AnnotatedOutput out,
                       String prefix)

Writes annotations for the elements of this list, as zero-length. This is meant to be used for dumping this instance directly after a code dump (with the real local list actually existing elsewhere in the output).

Parameters:

file - non-null; the file to use for referencing other sections

out - non-null; where to annotate to

prefix - null-ok; prefix to attach to each line of output

debugPrint

public void debugPrint(PrintWriter out,
                       String prefix)

Does a human-friendly dump of this instance.

Parameters:

out - non-null; where to dump

prefix - non-null; prefix to attach to each line of output

writeTo0

protected void writeTo0(DexFile file,
                        AnnotatedOutput out)

Performs the actual write of the contents of this instance to the given data section. This is called by OffsettedItem.writeTo(com.android.dx.dex.file.DexFile, com.android.dx.util.AnnotatedOutput), which will have taken care of ensuring alignment.

Specified by:

writeTo0 in class OffsettedItem

Parameters:

file - non-null; the file to use for reference

out - non-null; where to write to