net.greghaines.jesque

Class Job

java.lang.Object

net.greghaines.jesque.Job

All Implemented Interfaces:

Serializable

public class Job
extends Object
implements Serializable

A simple class to describe a job to be run by a worker.

Author:

Greg Haines

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Job() No-argument constructor.
Job(Job origJob) Cloning constructor.
Job(String className, List<?> args) A convenience constructor.
Job(String className, Map<String,? extends Object> vars) Create a new Job with the given class name and named arguments. Resque 2.0-style Job.
Job(String className, Object... args) Create a new Job with the given class name and arguments.
Job(String className, Object[] args, Map<String,? extends Object> vars) Create a new Job with the given class name and both types of arguments. Resque 2.0-style Job.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object[]	getArgs()
String	getClassName()
Object	getUnknownField(String fieldName) Get an unknown field.
Map<String,Object>	getUnknownFields() Get all unknown fields.
Map<String,Object>	getVars()
int	hashCode()
boolean	isValid()
void	setArgs(Object... args) Set the arguments.
void	setClassName(String className) Set the class name.
void	setUnknownField(String name, Object value) Set an unknown field.
void	setUnknownFields(Map<String,Object> unknownFields) Set all unknown fields
void	setVars(Map<String,? extends Object> vars) Set the named arguments.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Job

public Job()

No-argument constructor.

Job

public Job(Job origJob)

Cloning constructor. Makes a clone of the arguments, if they exist.

Parameters:

origJob - the Job to start from

Throws:

IllegalArgumentException - if the origJob is null

Job

public Job(String className,
   List<?> args)

A convenience constructor. Delegates to Job(String, Object...) by calling args.toArray().

Parameters:

className - the class name of the Job

args - the arguments for the Job

Job

public Job(String className,
   Object... args)

Create a new Job with the given class name and arguments.

Parameters:

className - the class name of the Job

args - the arguments for the Job

Job

public Job(String className,
   Map<String,? extends Object> vars)

Create a new Job with the given class name and named arguments.
Resque 2.0-style Job.

Parameters:

className - the class name of the Job

vars - the named arguments for the Job

Job

public Job(String className,
   Object[] args,
   Map<String,? extends Object> vars)

Create a new Job with the given class name and both types of arguments.
Resque 2.0-style Job.

Parameters:

className - the class name of the Job

args - the arguments for the Job

vars - the named arguments for the Job

Method Detail

getClassName

public String getClassName()

Returns:

the name of the Job's class

setClassName

public void setClassName(String className)

Set the class name.

Parameters:

className - the new class name

getArgs

public Object[] getArgs()

Returns:

the arguments for the job

setArgs

public void setArgs(Object... args)

Set the arguments.

Parameters:

args - the new arguments

getVars

public Map<String,Object> getVars()

Returns:

the named arguments for the job

setVars

public void setVars(Map<String,? extends Object> vars)

Set the named arguments.

Parameters:

vars - the new named arguments

isValid

public boolean isValid()

Returns:

true if this Job has a valid class name and arguments

getUnknownField

public Object getUnknownField(String fieldName)

Get an unknown field.

Parameters:

fieldName - the field name

Returns:

the value

getUnknownFields

public Map<String,Object> getUnknownFields()

Get all unknown fields.

Returns:

all unknown fields

setUnknownField

public void setUnknownField(String name,
                   Object value)

Set an unknown field.

Parameters:

name - the unknown property name

value - the unknown property value

setUnknownFields

public void setUnknownFields(Map<String,Object> unknownFields)

Set all unknown fields

Parameters:

unknownFields - the new unknown fields

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object