Package com.pnfsoftware.jeb.core.units.impl

Class DataContainerUnit

java.lang.Object

com.pnfsoftware.jeb.core.events.JebEventSource

com.pnfsoftware.jeb.core.units.AbstractUnit

com.pnfsoftware.jeb.core.units.impl.ContainerUnit

com.pnfsoftware.jeb.core.units.impl.DataContainerUnit

All Implemented Interfaces:

IUnitCreator, IUserDataSupport, IUnit, IEventSource

@Ser
public class DataContainerUnit
extends ContainerUnit

Container units used to recursively process virtual folders and data blobs. Units and children units are created to mimic the file-system structure provided as input.

See Also:

• FileContainerUnit

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataContainerUnit.Entry	Node of a container unit.

Field Summary

Fields inherited from class com.pnfsoftware.jeb.core.units.impl.ContainerUnit

CONTAINERS_FIRST

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

onEventCallCount

Constructor Summary

Constructors

Constructor	Description
DataContainerUnit(DataContainerUnit.Entry root, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)	Create a data container unit.

Method Summary

Modifier and Type	Method	Description
boolean	process()	The default implementation calls AbstractUnit.processInternal(), and makes sure that a status string is set on error, or nullified on success.
boolean	process(boolean processLeaves)	Process the container.
static void	register(IUnit caller, Collection<DataContainerUnit.Entry> entries)	Register entries as child units without processing leaves.
static void	register(IUnit caller, Collection<DataContainerUnit.Entry> entries, boolean processLeaves)	Register entries as child units.

Methods inherited from class com.pnfsoftware.jeb.core.units.impl.ContainerUnit

equals, getChildren, getRootContainer, hashCode

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

addChild, addChild, addChild, addNotification, canBePersisted, clearAllData, dispose, finalize, generateQuickState, getAllData, 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, 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, getClass, 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

execprvfunc, getExtraInputs, getInput, getParentArtifact, getParentProject, notifyGenericChange

Constructor Details

DataContainerUnit

public DataContainerUnit(DataContainerUnit.Entry root,
 IUnitProcessor unitProcessor,
 IUnitCreator parent,
 IPropertyDefinitionManager pdm)

Create a data container unit.

Parameters:

root - root entry

unitProcessor - unit processor

parent - parent unit or artifact

pdm - property definition manager

Method Details

process

public boolean process()

Description copied from class: AbstractUnit

The default implementation calls AbstractUnit.processInternal(), and makes sure that a status string is set on error, or nullified on success. processInternal() is never called is AbstractUnit.isProcessed() returns true.

Plugins may decide to override this method, if they need finer control over processing (we recommend overriding processInternal(); in that case, processInternal() should be ignored.

Specified by:

process in interface IUnit

Overrides:

process in class ContainerUnit

Returns:

true if processing is or was successful (in the latter case, process() should do nothing but return true), or false is processing failed. The unit should also notify clients by issuing a J.UnitProcessed event. If processing succeeded, subsequent calls to IUnit.isProcessed() should return true.

process

public boolean process(boolean processLeaves)

Description copied from class: ContainerUnit

Process the container.

Overrides:

process in class ContainerUnit

Parameters:

processLeaves - true to process leaf units

Returns:

true if processing succeeded

register

public static void register(IUnit caller,
 Collection<DataContainerUnit.Entry> entries)

Register entries as child units without processing leaves.

Parameters:

caller - parent unit

entries - entries to register

register

public static void register(IUnit caller,
 Collection<DataContainerUnit.Entry> entries,
 boolean processLeaves)

Register entries as child units.

Parameters:

caller - parent unit

entries - entries to register

processLeaves - true to process leaf units