AbstractBinaryUnit

Class Overview

This extension class provides basic implementations for methods specific to binary units.

Implementors must implement their own constructor; the default constructor is used for deserialization only. Example of a typical 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 static final AtomicInteger onEventCallCount

[Expand] Inherited Methods
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 void addListener(IEventListener listener) Register a listener. int countListeners() Get the numbers of objects listening to this event source. List<IEventListener> getListeners() Get a copy of the list of listeners. IEventSource getParentSource() Get the parent source. void insertListener(int index, IEventListener listener) Register a listener. void notifyListeners(JebEvent e, boolean notifyParent) void notifyListeners(IEvent e) Notify listeners that an event has occurred. void notifyListeners(JebEvent e) void removeListener(IEventListener listener) Unregister a listener. void setParentSource(IEventSource parentSource) Set a parent source.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.pnfsoftware.jeb.core.IUnitCreator abstract IInput getInput() Retrieve the optional input data. abstract String getName() Get the name of this object. abstract IUnitCreator getParent() Get the parent of the current object.
From interface com.pnfsoftware.jeb.core.IUserDataSupport abstract void clearAllData(Object key) Remove all pieces of custom unit data. abstract Map<Object, Object> getAllData() Retrieve a map containing all key-value pairs of of custom unit data. abstract Object getData(Object key) Retrieve a piece of custom unit data. abstract void setData(Object key, Object value, boolean persist) Store a piece of custom unit data.
From interface com.pnfsoftware.jeb.core.units.IBinaryUnit abstract IInput getInput() Get the input data for that unit. abstract String getMimeType() Retrieve the optional content-type for that unit.
From interface com.pnfsoftware.jeb.core.units.IUnit abstract void addChild(IUnit unit, boolean persisted) Add a child unit to this unit. abstract void addChild(IUnit unit) Register a child unit to this unit. abstract void addChildUnit(IUnit unit) Deprecated. abstract boolean canBePersisted() Determine if this unit can be persisted. abstract void dispose() Dispose of the resources used by this unit. abstract IQuickStateObject generateQuickState() Save the state of this unit (it may be a partial state). abstract List<? extends IUnit> getChildren() Retrieve a read-only list of all direct children units. abstract List<IUnitContribution> getContributions() Get the list of contributions attached to the unit. abstract long getCreationTimestamp() Get the date of creation of this unit. abstract String getDescription() Get a description string for that unit. abstract Collection<IInput> getExtraInputs() Get additional inputs. abstract String getFormatType() Mandatory unit type. abstract IUnitFormatter getFormatter() Retrieve a fresh formatter for that unit. abstract byte[] getIconData() The icon bytes representing units of such type. abstract IInput getInput() Get the primary input data for that unit, if there is some. abstract List<IUnitInterpreter> getInterpreters() Get the list of command interpreters attached to the unit. abstract IUnitLock getLock() Get the unit lock. abstract String getName() Get the unit name. abstract String getNotes() Get user-defined notes. abstract IUnitNotificationManager getNotificationManager() Get a reference to the notification manager. abstract IUnitCreator getParent() Retrieve the creator (or parent) of this unit. abstract IArtifact getParentArtifact() Retrieve the artifact from which this unit derive. abstract IRuntimeProject getParentProject() Retrieve the parent project that owns this unit. abstract IPropertyDefinitionManager getPropertyDefinitionManager() Retrieve the PDM used by this unit. abstract IPropertyManager getPropertyManager() Retrieve the PM used by this unit. abstract String getRealName() Retrieve the optional real unit name. abstract String getStatus() Get the status for the unit. abstract long getUid() Retrieve an identifier that uniquely identifies the unit within its project. abstract IUnitProcessor getUnitProcessor() Retrieve the unit processor used by this unit. abstract void initializePropertyObjects(IUnitCreator parent, IUnitProcessor processor, IPropertyDefinitionManager pdm) Initialize the property manager and property definition manager used by this unit. abstract boolean isDisposed() Indicate if the unit has been disposed abstract boolean isProcessed() Verify if the unit was successfully processed. abstract boolean isStale() Determine whether the unit was successfully processed, but is now considered to be stale (outdated content). abstract boolean isTransientChild(IUnit unit) Check if a child unit is transient. abstract void notifyGenericChange() Notify all listeners of a generic change, i.e. abstract void postDeserialization(IRuntimeProject prj) This method is called by the engines after a unit has been fully deserialized. abstract boolean process() Process the unit. abstract void removeChild(IUnit unit) Remove a direct child of the current unit. abstract void setName(String name) Set the unit name. abstract void setNotes(String notes) Set user-defined notes. abstract void setParent(IUnitCreator parent) Set the parent unit or artifact. abstract void setRealName(String name) Set the optional unit's real name. abstract void setUnitProcessor(IUnitProcessor processor) Set the unit processor.
From interface com.pnfsoftware.jeb.util.events.IEventSource abstract void addListener(IEventListener listener) Register a listener. abstract int countListeners() Get the numbers of objects listening to this event source. abstract List<? extends IEventListener> getListeners() Get a copy of the list of listeners. abstract IEventSource getParentSource() Get the parent source. abstract void insertListener(int index, IEventListener listener) Register a listener. abstract void notifyListeners(IEvent e) Notify listeners that an event has occurred. abstract void removeListener(IEventListener listener) Unregister a listener. abstract void setParentSource(IEventSource parentSource) Set a parent source.