IJavaSourceUnit

implements ISourceUnit

com.pnfsoftware.jeb.core.units.code.java.IJavaSourceUnit

Class Overview

Definition of a source unit representing a Java class or Java method in the form of an Abstract Syntax Tree (AST).

Summary

Public Methods
abstract IJavaElement	getASTElement() Get a reference to the Java class or method defined in this unit.
abstract IJavaClass	getClassElement() This method is deprecated. use `getASTElement()`
abstract IDexDecompilerUnit	getDecompiler() Get the decompiler unit (possibly the parent, possibly null) that generated this unit.
abstract IJavaFactories	getFactories() This method is deprecated. use `getASTFactories()` instead
abstract String	getIdentifierName(IJavaIdentifier ident) This method is deprecated. use `getIdentifierName(IJavaIdentifier)` instead
abstract int	optimize() Convenience method used to run an additional pass of standard (built-in) AST optimizations.
abstract boolean	setIdentifierName(IJavaIdentifier ident, String name) This method is deprecated. use `setIdentifierName(IJavaIdentifier, String)` instead

[Expand]

Inherited Methods

From interface com.pnfsoftware.jeb.core.IUnitCreator

From interface com.pnfsoftware.jeb.core.IUserDataSupport

From interface com.pnfsoftware.jeb.core.units.IAddressableUnit

abstract String	getAddressLabel(String address) Retrieve the label at a given address.
abstract Map<String, String>	getAddressLabels() Retrieve all labels.
abstract String	getAddressOfItem(long id) Attempt to determine the best address for a given item.
abstract String	getCanonicalAddress(String address) Convert the provided address to its canonical form.
abstract long	getItemAtAddress(String address) Attempt to determine the best item for a given address.
abstract Object	getItemObject(long id) Optionally provide an object associated with the given item.
abstract List<Long>	getRelatedItems(long id) Retrieve items related to the provided item id.
abstract Collection<String>	getWellKnownAddresses(int maxCount, Predicate<String> validator) Retrieve a collection of valid unit addresses.
abstract boolean	isValidAddress(String address) Determine if the provided address is a valid address for this unit.

From interface com.pnfsoftware.jeb.core.units.IInteractiveUnit

abstract IInputLocation	addressToLocation(String address) Convert a unit-specific address to location information relative to the input.
abstract boolean	canExecuteAction(ActionContext actionContext) Verify if an action can be executed.
abstract boolean	executeAction(ActionContext actionContext, IActionData actionData, boolean notify) Execute an action and optionally notify clients if the action was executed successfully and modified the unit contents.
abstract boolean	executeAction(ActionContext actionContext, IActionData actionData) Execute an action.
abstract List<Integer>	getAddressActions(String address) Provide a list of actions that may be executed at the given address.
abstract AbstractCommentManager<?, ?>	getCommentManager() Get the comment manager.
abstract String	getFullComment(String address) This convenience method is used to generate the full string comment attached to the provided address.
abstract Map<String, String>	getFullComments() This convenience method is used to generate a map of full string comments held by the units.
abstract List<Integer>	getGlobalActions() Provide a list of actions that may be executed globally.
abstract String	getInlineComment(String address) Retrieve the primary comment at a given address.
abstract Map<String, String>	getInlineComments() Retrieve all primary comments.
abstract List<Integer>	getItemActions(long id) Provide a list of actions that may be executed on the item with the given id.
abstract IMetadataManager	getMetadataManager() Get a reference to the metadata manager for this unit.
abstract String	getPrimaryComment(String address) This method is deprecated. use `getInlineComment(String)`
abstract Map<String, String>	getPrimaryComments() This method is deprecated. use `getInlineComments()`
abstract String	locationToAddress(IInputLocation location) Convert a location relative to the input to a unit-specific address.
abstract boolean	prepareExecution(ActionContext actionContext, IActionData actionData) Prepare the execution of an action.
abstract boolean	setInlineComment(String address, String comment) Set or delete the primary comment at a given address.
abstract boolean	setPrimaryComment(String address, String comment) This method is deprecated. use `setInlineComment(String, String)`

From interface com.pnfsoftware.jeb.core.units.IUnit

From interface com.pnfsoftware.jeb.core.units.code.ISourceUnit

From interface com.pnfsoftware.jeb.util.events.IEventSource

Public Methods

public abstract IJavaElement getASTElement ()

Get a reference to the Java class or method defined in this unit.

public abstract IJavaClass getClassElement ()

This method is deprecated.
use getASTElement()

public abstract IDexDecompilerUnit getDecompiler ()

Get the decompiler unit (possibly the parent, possibly null) that generated this unit.

Returns

a decompiler unit, possibly null

public abstract IJavaFactories getFactories ()

This method is deprecated.
use getASTFactories() instead

Get an AST element builder. The builder is used to create new AST elements, which can then be inserted in an existed AST. Convenience method.

public abstract String getIdentifierName (IJavaIdentifier ident)

This method is deprecated.
use getIdentifierName(IJavaIdentifier) instead

Retrieve the effective (renamed) name of an identifier in this method's AST. Convenience method.

public abstract int optimize ()

Convenience method used to run an additional pass of standard (built-in) AST optimizations.

public abstract boolean setIdentifierName (IJavaIdentifier ident, String name)

This method is deprecated.
use setIdentifierName(IJavaIdentifier, String) instead

Rename an identifier. Convenience method.

Interfaces

Classes

Enums