public class

ContainerUnit

extends AbstractUnit

java.lang.Object
↳	com.pnfsoftware.jeb.core.events.JebEventSource
	↳	com.pnfsoftware.jeb.core.units.AbstractUnit
		↳	com.pnfsoftware.jeb.core.units.impl.ContainerUnit

Known Direct Subclasses

DataContainerUnit, FileContainerUnit, LazyDataContainerUnit

Class Overview

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

Summary

Fields
public static final Comparator<IUnit>	CONTAINERS_FIRST

[Expand]

Inherited Fields

From class com.pnfsoftware.jeb.core.events.JebEventSource

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

Public Methods
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(boolean processLeaves)
boolean	process() The default implementation calls `processInternal()`, and makes sure that a status string is set on error, or nullified on success.

[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

From class java.lang.Object

From interface com.pnfsoftware.jeb.core.IUnitCreator

From interface com.pnfsoftware.jeb.core.IUserDataSupport

From interface com.pnfsoftware.jeb.core.units.IUnit

From interface com.pnfsoftware.jeb.util.events.IEventSource

Fields

public static final Comparator<IUnit> CONTAINERS_FIRST

Public Constructors

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

Create a container unit.

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

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

Public Methods

public boolean equals (Object o)

public List<? extends IUnit> getChildren ()

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

Returns

the children or an empty list, never null

public ContainerUnit getRootContainer ()

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

Returns

the first non-container parent

public int hashCode ()

public boolean process (boolean processLeaves)

public boolean process ()

The default implementation calls processInternal(), and makes sure that a status string is set on error, or nullified on success. processInternal() is never called is 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.

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 UnitProcessed event. If processing succeeded, subsequent calls to isProcessed() should return true.

Classes

ContainerUnit

Class Overview

Summary

Fields

public static final Comparator<IUnit> CONTAINERS_FIRST

Public Constructors

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

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

Public Methods

public boolean equals (Object o)

public List<? extends IUnit> getChildren ()

Returns

public ContainerUnit getRootContainer ()

Returns

public int hashCode ()

public boolean process (boolean processLeaves)

public boolean process ()

Returns