Package com.pnfsoftware.jeb.core.units

Class AbstractBinaryUnit

java.lang.Object

com.pnfsoftware.jeb.core.events.JebEventSource

com.pnfsoftware.jeb.core.units.AbstractUnit

com.pnfsoftware.jeb.core.units.AbstractBinaryUnit

All Implemented Interfaces:

IUnitCreator, IUserDataSupport, IBinaryUnit, IUnit, IEventSource

Direct Known Subclasses:

AbstractCodeObjectUnit, AbstractInteractiveBinaryUnit, UnknownBinaryUnit

@Ser
public abstract class AbstractBinaryUnit
extends AbstractUnit
implements IBinaryUnit

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);
     ...
 }
 

Field Summary

Fields inherited from class com.pnfsoftware.jeb.core.events.JebEventSource

onEventCallCount

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBinaryUnit(String mimeType, IInput input, String formatType, String name, IUnit parent)	Create a binary unit using the parent unit's processor and property definitions.
protected	AbstractBinaryUnit(String mimeType, IInput input, String formatType, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)	Create a binary unit.

Method Summary

Modifier and Type	Method	Description
IInput	getInput()	The default implementation returns the input provided to the constructor.
String	getMimeType()	The default implementation returns the MIME type provided to the constructor.
void	setInput(IInput input)	Set the binary input.
void	setMimeType(String mimeType)	Set the MIME type.

Methods inherited from class com.pnfsoftware.jeb.core.units.AbstractUnit

addChild, addChild, addChild, addNotification, canBePersisted, clearAllData, dispose, finalize, generateQuickState, getAllData, getChildren, getContributions, getCreationTimestamp, getData, getDescription, getFormatter, getFormatType, getIconData, getInterpreters, getLock, getName, getNotes, getNotificationManager, getParent, getPropertyDefinitionManager, getPropertyManager, getRealName, getStatus, getUid, getUnitProcessor, hasChildren, initializePropertyObjects, internalSwapChildren, isDeserialized, isDisposed, isProcessed, isStale, isTransientChild, logError, logException, logInfo, logTrace, logWarn, onPropertyChange, postDeserialization, process, processInternal, removeChild, removeChild, setChild, setChild, setData, setName, setNotes, setParent, setProcessed, setProcessed, setRealName, setStatus, setStatus, setUnitProcessor, toString

Methods inherited from class com.pnfsoftware.jeb.core.events.JebEventSource

addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, notifyListeners, notifyListeners, removeListener, setParentSource

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.pnfsoftware.jeb.util.events.IEventSource

addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, removeListener, setParentSource

Methods inherited from interface com.pnfsoftware.jeb.core.units.IUnit

addChild, addChild, canBePersisted, dispose, execprvfunc, generateQuickState, getChildren, getContributions, getCreationTimestamp, getDescription, getExtraInputs, getFormatter, getFormatType, getIconData, getInterpreters, getLock, getName, getNotes, getNotificationManager, getParent, getParentArtifact, getParentProject, getPropertyDefinitionManager, getPropertyManager, getRealName, getStatus, getUid, getUnitProcessor, initializePropertyObjects, isDisposed, isProcessed, isStale, isTransientChild, notifyGenericChange, postDeserialization, process, removeChild, setName, setNotes, setParent, setRealName, setUnitProcessor

Methods inherited from interface com.pnfsoftware.jeb.core.IUserDataSupport

clearAllData, getAllData, getData, setData

Constructor Details

AbstractBinaryUnit

protected AbstractBinaryUnit(String mimeType,
 IInput input,
 String formatType,
 String name,
 IUnit parent)

Create a binary unit using the parent unit's processor and property definitions.

Parameters:

mimeType - MIME type; defaults to application/octet-stream if null or empty

input - mandatory binary input

formatType - unit format type

name - unit name

parent - parent unit

AbstractBinaryUnit

protected AbstractBinaryUnit(String mimeType,
 IInput input,
 String formatType,
 String name,
 IUnitProcessor unitProcessor,
 IUnitCreator parent,
 IPropertyDefinitionManager pdm)

Create a binary unit.

Parameters:

mimeType - MIME type; defaults to application/octet-stream if null or empty

input - mandatory binary input

formatType - unit format type

name - unit name

unitProcessor - unit processor

parent - parent unit or artifact

pdm - property definition manager

Method Details

getMimeType

public String getMimeType()

The default implementation returns the MIME type provided to the constructor.

Specified by:

getMimeType in interface IBinaryUnit

Returns:

optional content-type

setMimeType

public void setMimeType(String mimeType)

Set the MIME type.

Parameters:

mimeType - MIME type

getInput

public IInput getInput()

The default implementation returns the input provided to the constructor.

Specified by:

getInput in interface IBinaryUnit

Specified by:

getInput in interface IUnit

Specified by:

getInput in interface IUnitCreator

Returns:

a mandatory input object

setInput

public void setInput(IInput input)

Set the binary input.

Parameters:

input - binary input