public class

RuntimeProjectUtil

extends Object
java.lang.Object
   ↳ com.pnfsoftware.jeb.core.RuntimeProjectUtil

Class Overview

A collection of utility methods to navigate and act on JEB projects.

Summary

Public Constructors
RuntimeProjectUtil()
Public Methods
static boolean destroyLiveArtifact(ILiveArtifact liveArtifact)
Destroy a live Artifact and all its children.
static List<IUnit> filterUnits(IRuntimeProject prj, IUnitFilter filter)
Find the units in the project that pass a test provided by the user-defined filter object.
static <T extends IUnit> T findFirstUnitByType(IRuntimeProject prj, Class<T> c, boolean strict)
Find a units of a project that are of the specified type.
static IRuntimeProject findProject(IUnitCreator object)
Retrieve a JEB project object given any unit or artifact belonging to the project.
static List<IUnitContribution> findUnitContributions(IRuntimeProject prj, IUnit target)
Retrieve a list of contributions (defined within a given project) for a target unit.
static <T extends IUnit> List<T> findUnits(IRuntimeProject prj, Class<T> c)
Find all units of a project that are of the specified type.
static <T extends IUnit> List<T> findUnitsByType(IRuntimeProject prj, Class<T> c, boolean strict)
Find all units of a project that are of the specified type.
static List<IUnit> getAllUnits(IRuntimeProject prj)
Retrieve a list of all units in the provided project.
static boolean hasNotification(IRuntimeProject prj)
Determine if a project has at least one unit with at least one notification.
static boolean hasNotification(IRuntimeProject prj, int minLevel)
Determine if a project has at least one unit with at least one notification whose level is greater than or equal than the requested one.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RuntimeProjectUtil ()

Public Methods

public static boolean destroyLiveArtifact (ILiveArtifact liveArtifact)

Destroy a live Artifact and all its children.

Returns
  • false in case of error: the live artifact may be in an invalid state after destruction fails (some IUnit children may have been deleted)

public static List<IUnit> filterUnits (IRuntimeProject prj, IUnitFilter filter)

Find the units in the project that pass a test provided by the user-defined filter object.

Parameters
prj a project
filter a filter, null means no filter (ie, all units will be returned)
Returns
  • the list of units

public static T findFirstUnitByType (IRuntimeProject prj, Class<T> c, boolean strict)

Find a units of a project that are of the specified type.

Parameters
prj a project
c a type of unit, or null to indicate all units
strict if true, only units of class `c` will be returned; else, units of type `c` or any type derived from `c` will be returned
Returns
  • a unit or null

public static IRuntimeProject findProject (IUnitCreator object)

Retrieve a JEB project object given any unit or artifact belonging to the project.

Parameters
object a unit or an artifact
Returns
  • null on error

public static List<IUnitContribution> findUnitContributions (IRuntimeProject prj, IUnit target)

Retrieve a list of contributions (defined within a given project) for a target unit.

Parameters
prj a project
target the target unit
Returns
  • a list of contributions, potentially empty

public static List<T> findUnits (IRuntimeProject prj, Class<T> c)

Find all units of a project that are of the specified type.

Same as findUnitsByType(prj, c, false).

Parameters
prj JEB project
c unit type
Returns
  • the list of units

public static List<T> findUnitsByType (IRuntimeProject prj, Class<T> c, boolean strict)

Find all units of a project that are of the specified type.

Parameters
prj a project
c a type of unit, or null to indicate all units
strict if true, only units of class `c` will be returned; else, units of type `c` or any type derived from `c` will be returned
Returns
  • the list of units

public static List<IUnit> getAllUnits (IRuntimeProject prj)

Retrieve a list of all units in the provided project.

public static boolean hasNotification (IRuntimeProject prj)

Determine if a project has at least one unit with at least one notification.

public static boolean hasNotification (IRuntimeProject prj, int minLevel)

Determine if a project has at least one unit with at least one notification whose level is greater than or equal than the requested one.