FileContainerUnit

extends ContainerUnit

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

Class Overview

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

Summary

[Expand]

Inherited Fields

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

Public Constructors
	FileContainerUnit(File folder, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)

Public Methods
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.impl.ContainerUnit

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.
synchronized 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.
IQuickStateObject	generateQuickState() The default implementation returns null.
List<? extends IUnit>	getChildren() Sub-classes overriding this method must override related methods consistently.
synchronized List<IUnitContribution>	getContributions() Get the list of contributions attached to the unit.
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.
synchronized List<IUnitInterpreter>	getInterpreters() Get the list of command interpreters attached to the unit.
String	getName() Get the unit name.
String	getNotes() Get user-defined notes.
synchronized 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.
boolean	hasChildren()
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	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	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)
void	removeChild(IUnit unit) Sub-classes overriding this method must override related methods consistently.
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 optionally notify clients by issuing a `UnitChange` event.
final void	setProcessed(boolean processed) Mark the unit as processed and notify the client.
void	setStatus(String status, boolean notify)
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.units.IUnit

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

Public Constructors

public FileContainerUnit (File folder, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)

Parameters

folder	input folder to be processed

Public Methods

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