Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

public abstract class

AbstractInteractiveBinaryUnit

extends AbstractBinaryUnit
implements IInteractiveUnit

java.lang.Object
↳	com.pnfsoftware.jeb.core.events.JebEventSource
	↳	com.pnfsoftware.jeb.core.units.AbstractUnit
		↳	com.pnfsoftware.jeb.core.units.AbstractBinaryUnit
			↳	com.pnfsoftware.jeb.core.units.AbstractInteractiveBinaryUnit

Known Direct Subclasses

AbstractCodeUnit

Class Overview

Skeleton of an interactive binary unit. Usage of this abstract class is encouraged. This unit provides a default metadata manager.

Implementors must implement their own constructor; the default constructor is used for deserialization only. Example of a typical interactive binary unit constructor:

 public DerivedClass(String name, IInput input, IUnitProcessor unitProcessor, IUnitCreator parent,
         IPropertyDefinitionManager pdm) {
     super(..., input, ..., name, unitProcessor, parent, pdm);
     ...
 }

Summary

[Expand]

Inherited Fields

From class com.pnfsoftware.jeb.core.events.JebEventSource

Public Constructors
	AbstractInteractiveBinaryUnit(String mimeType, IInput input, String formatType, String name, IUnit parent)
	AbstractInteractiveBinaryUnit(String mimeType, IInput input, String formatType, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm) Constructor.

Public Methods
boolean	canExecuteAction(ActionContext actionContext) The skeleton implementation returns false.
boolean	executeAction(ActionContext actionContext, IActionData actionData, boolean notify) The skeleton implementation returns false.
boolean	executeAction(ActionContext actionContext, IActionData actionData) The skeleton implementation returns `executeAction(actionContext, actionData, true)`.
List<Integer>	getAddressActions(String address) The skeleton implementation returns an empty list.
String	getAddressOfItem(long id) The skeleton implementation returns null.
List<Integer>	getGlobalActions() The skeleton implementation returns an empty list.
List<Integer>	getItemActions(long id) The skeleton implementation returns an empty list.
long	getItemAtAddress(String address) The skeleton implementation returns 0.
Object	getItemObject(long id) The skeleton implementation returns null.
IMetadataManager	getMetadataManager() The skeleton implementation returns an empty metadata manager.
List<Long>	getRelatedItems(long id) The skeleton implementation returns an empty list.
boolean	isValidAddress(String address) The default implementation returns true IFF the address can be converted to a valid (non-zero) item id.
boolean	prepareExecution(ActionContext actionContext, IActionData actionData) The skeleton implementation returns false.

[Expand]

Inherited Methods

From class com.pnfsoftware.jeb.core.units.AbstractBinaryUnit

From class com.pnfsoftware.jeb.core.units.AbstractUnit

void	addChild(IUnit unit, boolean persisted) Sub-classes overriding this method must override related methods consistently.
void	addChild(IUnit unit, boolean persisted, boolean notify)
void	addChild(IUnit unit) Sub-classes overriding this method must override related methods consistently.
void	addChildUnit(IUnit unit) Sub-classes overriding this method must override related methods consistently.
final void	addNotification(IUnitNotification notification)
boolean	canBePersisted() Determine if this unit can be persisted.
void	clearAllData(Object key) Remove all pieces of custom unit data.
void	dispose() Sub-classes overriding this method must call the `super` implementation last.
void	finalize()
IQuickStateObject	generateQuickState() The default implementation returns null.
Map<Object, Object>	getAllData() Retrieve a map containing all key-value pairs of of custom unit data.
List<? extends IUnit>	getChildren() Sub-classes overriding this method must override related methods consistently.
List<IUnitContribution>	getContributions() Get the list of contributions attached to the unit.
long	getCreationTimestamp() Get the date of creation of this unit.
Object	getData(Object key) Retrieve a piece of custom unit data.
String	getDescription() Get a description string for that unit.
String	getFormatType() Mandatory unit type.
IUnitFormatter	getFormatter() Retrieve a fresh formatter for that unit.
byte[]	getIconData() The icon bytes representing units of such type.
List<IUnitInterpreter>	getInterpreters() Get the list of command interpreters attached to the unit.
IUnitLock	getLock() The default implementation returns a pass-through lock that never locks.
String	getName() Get the unit name.
String	getNotes() Get user-defined notes.
IUnitNotificationManager	getNotificationManager() Get a reference to the notification manager.
IUnitCreator	getParent() Retrieve the creator (or parent) of this unit.
IPropertyDefinitionManager	getPropertyDefinitionManager() Retrieve the PDM used by this unit.
IPropertyManager	getPropertyManager() Retrieve the PM used by this unit.
String	getRealName() Retrieve the optional real unit name.
String	getStatus() Get the status for the unit.
long	getUid() Retrieve an identifier that uniquely identifies the unit within its `project`.
IUnitProcessor	getUnitProcessor() Retrieve the unit processor used by this unit.
boolean	hasChildren()
void	initializePropertyObjects(IUnitCreator parent, IUnitProcessor processor, IPropertyDefinitionManager pdm) Overrides are allowed.
synchronized void	internalSwapChildren() RESERVED FOR INTERNAL USE.
boolean	isDeserialized()
final boolean	isDisposed() Indicate if the unit has been disposed
boolean	isProcessed() Verify if the unit was successfully processed.
boolean	isStale() The default implementation returns `false`.
boolean	isTransientChild(IUnit unit) Sub-classes overriding this method must override related methods consistently.
void	logError(boolean recordNotification, String format, Object... params) Log an error message using the current class logger, and optionally create a persistent unit notification as well.
void	logException(Exception e) Log an exception using the current class logger.
void	logInfo(boolean recordNotification, String format, Object... params) Log an information message using the current class logger, and optionally create a persistent unit notification as well.
void	logTrace(String format, Object... params) Log a trace message using the current class logger.
void	logWarn(boolean recordNotification, String format, Object... params) Log a warning message using the current class logger, and optionally create a persistent unit notification as well.
void	onPropertyChange(String fqPropertyName) This method is called when a project property is changed.
void	postDeserialization(IRuntimeProject prj) To be overridden by subclasses if necessary.
boolean	process() The default implementation calls `processInternal()`, and makes sure that a status string is set on error, or nullified on success.
boolean	processInternal() Plugins may override this method instead of the traditional `process()`.
void	removeChild(IUnit unit, boolean notify)
final void	removeChild(IUnit unit) Sub-classes overriding this method must override related methods consistently.
boolean	setChild(IUnit oldUnit, IUnit newUnit, boolean notify)
boolean	setChild(IUnit oldUnit, IUnit newUnit)
void	setData(Object key, Object value, boolean persist) Store a piece of custom unit data.
void	setName(String name) Set the unit name.
void	setNotes(String notes) Set user-defined notes.
void	setParent(IUnitCreator parent) Set the parent unit or artifact.
void	setProcessed(boolean processed, boolean notify) Mark the unit as processed and, if processed, optionally notify clients by issuing a `UnitChange` event.
final void	setProcessed(boolean processed) Mark the unit as processed and, if processed, notify the client.
void	setRealName(String name) Set the optional unit's real name.
void	setStatus(String status, boolean notify)
final void	setStatus(String status) Set the plugin status.
void	setUnitProcessor(IUnitProcessor processor) Set the unit processor.
String	toString()

From class com.pnfsoftware.jeb.core.events.JebEventSource

From class java.lang.Object

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.IBinaryUnit

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.util.events.IEventSource

Public Constructors

public AbstractInteractiveBinaryUnit (String mimeType, IInput input, String formatType, String name, IUnit parent)

public AbstractInteractiveBinaryUnit (String mimeType, IInput input, String formatType, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)

Constructor.

Public Methods

public boolean canExecuteAction (ActionContext actionContext)

The skeleton implementation returns false.

Parameters

actionContext	location context for the action

Returns

true

public boolean executeAction (ActionContext actionContext, IActionData actionData, boolean notify)

The skeleton implementation returns false.

Parameters

actionContext	context for the action
actionData	data for the action
notify	true to notify clients if the action was successfully executed and the unit contents has changed

Returns

action success indicator

public boolean executeAction (ActionContext actionContext, IActionData actionData)

The skeleton implementation returns executeAction(actionContext, actionData, true).

Parameters

actionContext	location context for the action
actionData	data for the action

Returns

true if the execution was successful. Upon successful execution, actionData will contain plugin-set post-execution data

public List<Integer> getAddressActions (String address)

The skeleton implementation returns an empty list.

Parameters

address	the target address

Returns

the list of actions

public String getAddressOfItem (long id)

The skeleton implementation returns null.

Parameters

id	the item id

Returns

an address best representing or matching the provided item, null otherwise

public List<Integer> getGlobalActions ()

The skeleton implementation returns an empty list.

Returns

the list of actions

public List<Integer> getItemActions (long id)

The skeleton implementation returns an empty list.

Parameters

id	the target item identifier

Returns

the list of actions

public long getItemAtAddress (String address)

The skeleton implementation returns 0.

Parameters

address	the address

Returns

an item best representing or matching the provided address, 0 otherwise

public Object getItemObject (long id)

The skeleton implementation returns null.

Parameters

id	the item id

Returns

an object, whose type is defined by contract, potentially null

public IMetadataManager getMetadataManager ()

The skeleton implementation returns an empty metadata manager.

Returns

the manager, null if none

public List<Long> getRelatedItems (long id)

The skeleton implementation returns an empty list.

Parameters

id	an item id

Returns

a list of related items (not containing the provided id), may be empty - never null

public boolean isValidAddress (String address)

The default implementation returns true IFF the address can be converted to a valid (non-zero) item id.

public boolean prepareExecution (ActionContext actionContext, IActionData actionData)

The skeleton implementation returns false.

Parameters

actionContext	location context for the action
actionData	data for the action

Returns

true if the preparation was successful, and the action may be executed. Upon successful preparation, actionData will contain plugin-set pre-execution data

Interfaces

Classes

Enums

Exceptions

AbstractInteractiveBinaryUnit

Class Overview

Summary

Public Constructors

public AbstractInteractiveBinaryUnit (String mimeType, IInput input, String formatType, String name, IUnit parent)

public AbstractInteractiveBinaryUnit (String mimeType, IInput input, String formatType, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)

Public Methods

public boolean canExecuteAction (ActionContext actionContext)

Parameters

Returns

public boolean executeAction (ActionContext actionContext, IActionData actionData, boolean notify)

Parameters

Returns

public boolean executeAction (ActionContext actionContext, IActionData actionData)

Parameters

Returns

public List<Integer> getAddressActions (String address)

Parameters

Returns

public String getAddressOfItem (long id)

Parameters

Returns

public List<Integer> getGlobalActions ()

Returns

public List<Integer> getItemActions (long id)

Parameters

Returns

public long getItemAtAddress (String address)

Parameters

Returns

public Object getItemObject (long id)

Parameters

Returns

public IMetadataManager getMetadataManager ()

Returns

public List<Long> getRelatedItems (long id)

Parameters

Returns

public boolean isValidAddress (String address)

public boolean prepareExecution (ActionContext actionContext, IActionData actionData)

Parameters

Returns