JobState

java.lang.Object

com.polarion.platform.jobs.JobState

All Implemented Interfaces:: Serializable

public final class JobState extends Object implements Serializable

Job state "enumeration".

Values of this enumeration treat Object.equals(java.lang.Object) and == the same.

Version:

$Revision:56034 $ $Date:2006-07-13 11:21:20Z $

Author:

Stepan Roh, Polarion Software

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

static final JobState

STATE_ABORTED

job aborted (no matter how) - more information may be found in IJob.getStatus()

static final JobState

STATE_ACTIVATING

job is in IJobUnit.activate()

static final JobState

STATE_FINISHED

job finished (no matter how) - more information may be found in IJob.getStatus()

static final JobState

STATE_RUNNING

job is in IJobUnit.run(IProgressMonitor) or a child is running

static final JobState

STATE_UNSCHEDULED

initial state of all spawned jobs

static final JobState

STATE_WAITING

job waits for IJobUnit.run(IProgressMonitor) to be executed
Method Summary

Modifier and Type

Method

Description

static JobState

fromString(String s)

Return enumeration value for given name.

String

getName()

Return state name.

String

toString()

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- STATE_UNSCHEDULED
  
  public static final JobState STATE_UNSCHEDULED
  
  initial state of all spawned jobs
- STATE_ACTIVATING
  
  public static final JobState STATE_ACTIVATING
  
  job is in IJobUnit.activate()
- STATE_WAITING
  
  public static final JobState STATE_WAITING
  
  job waits for IJobUnit.run(IProgressMonitor) to be executed
- STATE_RUNNING
  
  public static final JobState STATE_RUNNING
  
  job is in IJobUnit.run(IProgressMonitor) or a child is running
- STATE_FINISHED
  
  public static final JobState STATE_FINISHED
  
  job finished (no matter how) - more information may be found in IJob.getStatus()
- STATE_ABORTED
  
  public static final JobState STATE_ABORTED
  
  job aborted (no matter how) - more information may be found in IJob.getStatus()
Method Details
- getName
  
  public String getName()
  
  Return state name.
  Same as toString().
  Do not use for comparison, use fromString(String) first.
  
  Returns:
  
  name (not null)
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- fromString
  
  public static JobState fromString(String s)
  
  Return enumeration value for given name.
  Comparison is case insensitive.
  Parameters:
  
  s - name
  
  Returns:
  
  proper enumeration value (not null)
  
  Throws:
  
  IllegalArgumentException - if name is not known
  
  See Also:
  
  getName()
  
  toString()