public final class SweepMode
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static SweepMode |
SWEEP_MODE_NORMAL
The sweep job or policy will execute in a non-preview mode;
that is, it will perform an action on the selected candidate objects,
and it will increment the ExaminedObjectCount and ProcessedObjectCount counters.
|
static int |
SWEEP_MODE_NORMAL_AS_INT
An
int value associated with the SWEEP_MODE_NORMAL instance of this class. |
static SweepMode |
SWEEP_MODE_PREVIEW
The sweep job or sweep policy will not perform an action on the selected candidate objects.
|
static int |
SWEEP_MODE_PREVIEW_AS_INT
An
int value associated with the SWEEP_MODE_PREVIEW instance of this class. |
static SweepMode |
SWEEP_MODE_PREVIEW_COUNTERS_ONLY
The sweep job or sweep policy will not perform an action on the selected candidate objects,
nor will it generate a
CmSweepResult object
of type PREVIEW for each object that is selected by the sweep. |
static int |
SWEEP_MODE_PREVIEW_COUNTERS_ONLY_AS_INT
An
int value associated with the SWEEP_MODE_PREVIEW_COUNTERS_ONLY instance of this class. |
Modifier and Type | Method and Description |
---|---|
static SweepMode |
getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.
|
int |
getValue()
Returns the internal integer value associated with a specific instance of this class.
|
java.lang.String |
toString()
Returns a
String representation of this enumeration instance. |
public static final int SWEEP_MODE_NORMAL_AS_INT
int
value associated with the SWEEP_MODE_NORMAL instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.public static final SweepMode SWEEP_MODE_NORMAL
CmSweepResult
object of type FAILURE
.
For a CmSweepJob
, failure reporting can be suppressed by setting the
RecordFailures property to false
.
For a CmSweepPolicy
, failure reporting can be suppressed by setting the
SweepResultIterationKeepCount to zero.
public static final int SWEEP_MODE_PREVIEW_COUNTERS_ONLY_AS_INT
int
value associated with the SWEEP_MODE_PREVIEW_COUNTERS_ONLY instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.public static final SweepMode SWEEP_MODE_PREVIEW_COUNTERS_ONLY
CmSweepResult
object
of type PREVIEW
for each object that is selected by the sweep.
With this preview mode setting, the sweep will only increment
the ExaminedObjectCount and ProcessedObjectCount counters.public static final int SWEEP_MODE_PREVIEW_AS_INT
int
value associated with the SWEEP_MODE_PREVIEW instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.public static final SweepMode SWEEP_MODE_PREVIEW
SweepActionHandler
implementation does not run.)
It will generate a CmSweepResult
object
of type PREVIEW
for each object that is selected by the sweep,
indicating that the swept object would be processed if the sweep were run in normal execution mode.
The sweep will also increment the ExaminedObjectCount and ProcessedObjectCount counters.public int getValue()
getInstanceFromInt(int)
public java.lang.String toString()
String
representation of this enumeration instance.toString
in class java.lang.Object
public static SweepMode getInstanceFromInt(int value)
value
- The integer value. (See the *_AS_INT fields.)EngineRuntimeException
- If an enumeration instance with the given
ordinal value does not exist.getValue()
© Copyright IBM Corporation 2006, 2015. All rights reserved.