|
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.units.impl.ContainerUnit