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

Class ContainerUnit

java.lang.Object

com.pnfsoftware.jeb.core.events.JebEventSource

com.pnfsoftware.jeb.core.units.AbstractUnit

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

All Implemented Interfaces:

IUnitCreator, IUserDataSupport, IUnit, IEventSource

Direct Known Subclasses:

DataContainerUnit, FileContainerUnit, LazyDataContainerUnit

@Ser
public class ContainerUnit
extends AbstractUnit

Container units are non-binary units used to represent tree structures.

Children can be attached to container units; it is recommended that clients handle container units as if they were file system folders (eg, displaying children should take priority over displaying container unit details).

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<IUnit>	CONTAINERS_FIRST	Comparator that sorts container units before leaf units, then by name.

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

onEventCallCount

Constructor Summary

Constructors

Constructor	Description
ContainerUnit(String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)	Create a container unit of the "composite" format type.
ContainerUnit(String formatType, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)	Create a container unit.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<? extends IUnit>	getChildren()	Sub-classes overriding this method must override related methods consistently.
ContainerUnit	getRootContainer()	Get the top-level container unit, within a hierarchy of containers.
int	hashCode()
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.

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

Field Details

CONTAINERS_FIRST

public static final Comparator<IUnit> CONTAINERS_FIRST

Comparator that sorts container units before leaf units, then by name.

Constructor Details

ContainerUnit

public ContainerUnit(String formatType,
 String name,
 IUnitProcessor unitProcessor,
 IUnitCreator parent,
 IPropertyDefinitionManager pdm)

Create a container unit.

Parameters:

formatType - unit format type

name - unit name

unitProcessor - unit processor

parent - parent unit or artifact

pdm - property definition manager

ContainerUnit

public ContainerUnit(String name,
 IUnitProcessor unitProcessor,
 IUnitCreator parent,
 IPropertyDefinitionManager pdm)

Create a container unit of the "composite" format type.

Parameters:

name - unit name

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 AbstractUnit

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)

Process the container.

Parameters:

processLeaves - true to process leaf units

Returns:

true if processing succeeded

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRootContainer

public ContainerUnit getRootContainer()

Get the top-level container unit, within a hierarchy of containers.

Returns:

the first non-container parent

getChildren

public List<? extends IUnit> getChildren()

Description copied from class: AbstractUnit

Sub-classes overriding this method must override related methods consistently.

Specified by:

getChildren in interface IUnit

Overrides:

getChildren in class AbstractUnit

Returns:

the children or an empty list, never null