public class

DataContainerUnit

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

Class Overview

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.

Summary

Nested Classes
class DataContainerUnit.Entry  
[Expand]
Inherited Fields
From class com.pnfsoftware.jeb.core.units.impl.ContainerUnit
Public Constructors
DataContainerUnit(DataContainerUnit.Entry root, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)
Public Methods
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.
static void register(IUnit caller, Collection<DataContainerUnit.Entry> entries)
static void register(IUnit caller, Collection<DataContainerUnit.Entry> entries, boolean processLeaves)
[Expand]
Inherited Methods
From class com.pnfsoftware.jeb.core.units.impl.ContainerUnit
From class com.pnfsoftware.jeb.core.units.AbstractUnit
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

Public Constructors

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

Public Methods

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.

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

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