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 Methods
From class com.pnfsoftware.jeb.core.units.AbstractUnit void addChild(IUnit unit) Sub-classes overriding this method must override related methods consistently. void addChild(IUnit unit, boolean persisted, boolean notify) void addChild(IUnit unit, boolean persisted) 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 dispose() Sub-classes overriding this method must override related methods consistently. List<? extends IUnit> getChildren() Sub-classes overriding this method must override related methods consistently. ICommandInterpreter getCommandInterpreter() Get a command interpreter provided by the unit, if any. long getCreationTimestamp() Get the date of creation of this unit. 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. 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 getStatus() Get the status for the unit. IUnitProcessor getUnitProcessor() Retrieve the unit processor used by this unit. void initializePropertyObjects(IUnitCreator parent, IUnitProcessor processor, IPropertyDefinitionManager pdm) Overrides are allowed. boolean isProcessed() Verify if the unit was successfully processed. boolean isTransientChild(IUnit unit) Sub-classes overriding this method must override related methods consistently. void onPropertyChange(String fqPropertyName) This method is called when a project property is changed. void removeChild(IUnit unit) Sub-classes overriding this method must override related methods consistently. void removeChild(IUnit unit, boolean notify) 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. final void setProcessed(boolean processed) Mark the unit as processed and notify the client. void setProcessed(boolean processed, boolean notify) Mark the unit as processed and optionally notify clients by issuing a UnitChange event. void setStatus(String status) Set the plugin status. void setStatus(String status, boolean notify) void setUnitProcessor(IUnitProcessor processor) Set the unit processor. String toString()
From class com.pnfsoftware.jeb.core.events.JebEventSource synchronized void addListener(IEventListener listener) Register a listener. synchronized int countListeners() Get the numbers of objects listening to this event source. synchronized List<IEventListener> getListeners() Get a copy of the list of listeners. synchronized IEventSource getParentSource() Get the parent source. synchronized void insertListener(int index, IEventListener listener) Insert a listner at the given position. synchronized void notifyListeners(IEvent e) Notify listeners that an event has occurred. synchronized boolean removeListener(IEventListener listener) Unregister a listener. synchronized 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() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.pnfsoftware.jeb.core.units.IBinaryUnit abstract int getConsummedSize() Get the number of bytes consumed by the unit after processing. 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) Register a child unit to this unit. abstract void addChild(IUnit unit, boolean persisted) Add 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 List<? extends IUnit> getChildren() Retrieve a read-only list of all direct children units. abstract ICommandInterpreter getCommandInterpreter() Get a command interpreter provided by the unit, if any. abstract long getCreationTimestamp() Get the date of creation of this unit. abstract String getDescription() Get a description string for that unit. 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 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 IPropertyDefinitionManager getPropertyDefinitionManager() Retrieve the PDM used by this unit. abstract IPropertyManager getPropertyManager() Retrieve the PM used by this unit. abstract String getStatus() Get the status for the unit. 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 isProcessed() Verify if the unit was successfully processed. abstract boolean isTransientChild(IUnit unit) Check if a child unit is transient. 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 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) Insert a listner at the given position. abstract void notifyListeners(IEvent e) Notify listeners that an event has occurred. abstract boolean removeListener(IEventListener listener) Unregister a listener. abstract void setParentSource(IEventSource parentSource) Set a parent source.