org.owasp.dependencycheck

Enum Engine.Mode

java.lang.Object

java.lang.Enum<Engine.Mode>

org.owasp.dependencycheck.Engine.Mode

All Implemented Interfaces:

Serializable, Comparable<Engine.Mode>

Enclosing class:

Engine

public static enum Engine.Mode
extends Enum<Engine.Mode>

Engine execution modes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVIDENCE_COLLECTION In evidence collection mode the Engine only collects evidence from the scan targets, and doesn't require a database.
EVIDENCE_PROCESSING In evidence processing mode the Engine processes the evidence collected using the EVIDENCE_COLLECTION mode.
STANDALONE In standalone mode the Engine will collect and process evidence in a single execution.

Method Summary

Modifier and Type	Method and Description
List<AnalysisPhase>	getPhases() Returns the phases for this mode.
static Engine.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Engine.Mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EVIDENCE_COLLECTION

public static final Engine.Mode EVIDENCE_COLLECTION

In evidence collection mode the Engine only collects evidence from the scan targets, and doesn't require a database.

EVIDENCE_PROCESSING

public static final Engine.Mode EVIDENCE_PROCESSING

In evidence processing mode the Engine processes the evidence collected using the EVIDENCE_COLLECTION mode. Dependencies should be injected into the Engine using Engine.setDependencies(List).

STANDALONE

public static final Engine.Mode STANDALONE

In standalone mode the Engine will collect and process evidence in a single execution.

Method Detail

values

public static Engine.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Engine.Mode c : Engine.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Engine.Mode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getPhases

public List<AnalysisPhase> getPhases()

Returns the phases for this mode.

Returns:

the phases for this mode