com.norconex.jef
Class JobContext

java.lang.Object
  extended by com.norconex.jef.JobContext
All Implemented Interfaces:
IJobContext, Serializable

public class JobContext
extends Object
implements IJobContext

Basic POJO implementation of IJobContext.

Since:
2.0
Author:
Pascal Essiembre
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.norconex.jef.IJobContext
PROGRESS_100, PROGRESS_ZERO
 
Constructor Summary
JobContext()
          Constructor.
JobContext(IJobContext context)
          Constructor.
JobContext(String description, long progressMinimum, long progressMaximum)
          Constructor.
 
Method Summary
 String getDescription()
          Gets the job description.
 long getProgressMaximum()
          Gets the maximum execution progress value.
 long getProgressMinimum()
          Gets the minimum execution progress value.
 void setDescription(String description)
           
 void setProgressMaximum(long progressMaximum)
           
 void setProgressMinimum(long progressMinimum)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JobContext

public JobContext()
Constructor.


JobContext

public JobContext(String description,
                  long progressMinimum,
                  long progressMaximum)
Constructor.

Parameters:
description - the job description
progressMinimum - the minimum possible progress value
progressMaximum - the maximum possible progress value

JobContext

public JobContext(IJobContext context)
Constructor. Initialise this job context with values from another job context.

Parameters:
context -
Method Detail

getDescription

public String getDescription()
Description copied from interface: IJobContext
Gets the job description.

Specified by:
getDescription in interface IJobContext
Returns:
job description

setDescription

public void setDescription(String description)

getProgressMinimum

public long getProgressMinimum()
Description copied from interface: IJobContext
Gets the minimum execution progress value.

Specified by:
getProgressMinimum in interface IJobContext
Returns:
minimum progress value

setProgressMinimum

public void setProgressMinimum(long progressMinimum)

getProgressMaximum

public long getProgressMaximum()
Description copied from interface: IJobContext
Gets the maximum execution progress value.

Specified by:
getProgressMaximum in interface IJobContext
Returns:
maximum progress value

setProgressMaximum

public void setProgressMaximum(long progressMaximum)

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2007-2013 Norconex Inc.. All Rights Reserved.