Package com.pnfsoftware.jeb.core.units.code

Interface ICodeUnit

All Superinterfaces:

IAddressableUnit, IEventSource, IInteractiveUnit, IUnit, IUnitCreator, IUserDataSupport

All Known Subinterfaces:

IDexUnit, INativeCodeUnit<InsnType>

All Known Implementing Classes:

AbstractCodeUnit

@Ser
public interface ICodeUnit
extends IInteractiveUnit

Base interface for units representing disassembled binary code, such as bytecode, opcodes, object files, executable files, and so on.

Code units are interactive, in order to provide facility for code refactoring, modification, etc.

Code units generate CodeDocument, and as such, generate AssemblyItem objects. Implementors must implement IAddressableUnit.getItemObject(long) properly.

Method Summary

Modifier and Type	Method	Description
String	getAddressFromCodeCoordinates(ICodeCoordinates cc)	Convert code coordinates to a unit address.
ICodeClass	getClass(String fqname)	Convenience method used to retrieve a class by name.
List<? extends ICodeClass>	getClasses()	Get the list of classes.
ICodeCoordinates	getCodeCoordinatesFromAddress(String address)	Convert a unit address to code coordinates.
ICodeItem	getCodeItemByAddress(String fqname)	Convenience method used to retrieve a code item by name.
CodeCommentManager<?>	getCommentManager()	Get the comment manager.
String	getDisassembly()	Convenience method used to generate the disassembly of this code unit using standard settings.
ITextDocument	getDisassemblyDocument()	Convenience method to retrieve the text document representing the disassembly of this code unit.
ICodeField	getField(String fqname)	Convenience method used to retrieve a field by name.
List<? extends ICodeField>	getFields()	Get the list of fields.
ICodeHierarchy	getHierarchy()	Get the code hierarchy.
ICodeMethod	getMethod(String fqname)	Convenience method used to retrieve a method by name.
List<? extends ICodeMethod>	getMethods()	Get the list of methods.
ICodePackage	getPackage(String fqname)	Convenience method used to retrieve a package by name.
List<? extends ICodePackage>	getPackages()	Get the list of code packages.
List<? extends ICodeString>	getStrings()	Get the list of code strings.
List<? extends ICodeType>	getTypes()	Get the list of types.

Methods inherited from interface com.pnfsoftware.jeb.core.units.IAddressableUnit

getAddressLabel, getAddressLabels, getAddressOfItem, getCanonicalAddress, getItemAtAddress, getItemObject, getRelatedItems, getWellKnownAddresses, isValidAddress

Methods inherited from interface com.pnfsoftware.jeb.util.events.IEventSource

addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, removeListener, setParentSource

Methods inherited from interface com.pnfsoftware.jeb.core.units.IInteractiveUnit

addressToLocation, canExecuteAction, executeAction, executeAction, getAddressActions, getFullComment, getFullComments, getGlobalActions, getInlineComment, getInlineComments, getItemActions, getMetadataManager, locationToAddress, prepareExecution, setInlineComment

Methods inherited from interface com.pnfsoftware.jeb.core.units.IUnit

addChild, addChild, canBePersisted, dispose, execprvfunc, generateQuickState, getChildren, getContributions, getCreationTimestamp, getDescription, getExtraInputs, getFormatter, getFormatType, getIconData, getInput, getInterpreters, getLock, getName, getNotes, getNotificationManager, getParent, getParentArtifact, getParentProject, getPropertyDefinitionManager, getPropertyManager, getRealName, getStatus, getUid, getUnitProcessor, initializePropertyObjects, isDisposed, isProcessed, isStale, isTransientChild, notifyGenericChange, postDeserialization, process, removeChild, setName, setNotes, setParent, setRealName, setUnitProcessor

Methods inherited from interface com.pnfsoftware.jeb.core.IUserDataSupport

clearAllData, getAllData, getData, setData

Method Details

getHierarchy

ICodeHierarchy getHierarchy()

Get the code hierarchy.

Returns:

code hierarchy

getStrings

List<? extends ICodeString> getStrings()

Get the list of code strings.

Returns:

code strings

getPackages

List<? extends ICodePackage> getPackages()

Get the list of code packages.

Returns:

code packages

getTypes

List<? extends ICodeType> getTypes()

Get the list of types.

Returns:

code types

getClasses

List<? extends ICodeClass> getClasses()

Get the list of classes.

Returns:

code classes

getFields

List<? extends ICodeField> getFields()

Get the list of fields.

Returns:

code fields

getMethods

List<? extends ICodeMethod> getMethods()

Get the list of methods.

Returns:

code methods

getClass

ICodeClass getClass(String fqname)

Convenience method used to retrieve a class by name.

Parameters:

fqname - fully-qualified class name

Returns:

matching class, or null

getField

ICodeField getField(String fqname)

Convenience method used to retrieve a field by name.

Parameters:

fqname - fully-qualified field name

Returns:

matching field, or null

getMethod

ICodeMethod getMethod(String fqname)

Convenience method used to retrieve a method by name.

Parameters:

fqname - fully-qualified method name

Returns:

matching method, or null

getPackage

ICodePackage getPackage(String fqname)

Convenience method used to retrieve a package by name.

Parameters:

fqname - fully-qualified package name

Returns:

matching package, or null

getCodeItemByAddress

ICodeItem getCodeItemByAddress(String fqname)

Convenience method used to retrieve a code item by name.

Parameters:

fqname - fully-qualified item name

Returns:

a class, method field or other item

getCodeCoordinatesFromAddress

ICodeCoordinates getCodeCoordinatesFromAddress(String address)

Convert a unit address to code coordinates.

Parameters:

address - unit address

Returns:

code coordinates, or null

getAddressFromCodeCoordinates

String getAddressFromCodeCoordinates(ICodeCoordinates cc)

Convert code coordinates to a unit address.

Parameters:

cc - code coordinates

Returns:

unit address, or null

getCommentManager

CodeCommentManager<?> getCommentManager()

Description copied from interface: IInteractiveUnit

Get the comment manager. This method is optional. When the unit is disposed, this method must return null. The default implementation returns null.

Specified by:

getCommentManager in interface IInteractiveUnit

Returns:

a comment manager, or null if the unit does not have one

getDisassemblyDocument

ITextDocument getDisassemblyDocument()

Convenience method to retrieve the text document representing the disassembly of this code unit.

The caller is responsible for disposing the returned document after usage.

Returns:

disassembly document

getDisassembly

String getDisassembly()

Convenience method used to generate the disassembly of this code unit using standard settings.

Returns:

disassembly text