org.javades.jqueues.r5.entity.jq

Class SimJQOperation.RequestJAndOrQ<O extends SimEntityOperation,Req extends SimJQOperation.RequestJAndOrQ>

java.lang.Object

org.javades.jqueues.r5.entity.SimEntityOperation.RequestE<O,Req>

org.javades.jqueues.r5.entity.jq.SimJQOperation.RequestJAndOrQ<O,Req>

Type Parameters:

O - The operation type.

Req - The request type (corresponding to the operation type).

All Implemented Interfaces:

SimEntityOperation.Request<O,Req>

Direct Known Subclasses:

SimJQOperation.RequestJ, SimJQOperation.RequestJQ, SimJQOperation.RequestQ

Enclosing interface:

SimJQOperation<J extends SimJob,Q extends SimQueue,O extends SimEntityOperation,Req extends SimEntityOperation.Request,Rep extends SimEntityOperation.Reply>

public abstract static class SimJQOperation.RequestJAndOrQ<O extends SimEntityOperation,Req extends SimJQOperation.RequestJAndOrQ>
extends SimEntityOperation.RequestE<O,Req>

A request of an operation on a SimQueue and/or a {SimJob}.

Either the job or the queue (or both) must be non-null, and one of them (non-null) is always the target entity.

See Also:

SimEntityOperation.Request.forTargetEntity(org.javades.jqueues.r5.entity.SimEntity)

Constructor Summary

Constructors

Constructor and Description
RequestJAndOrQ(SimJob job, SimQueue queue) Creates a new request for a job or queue or both, preferring a non-null queue as target entity.
RequestJAndOrQ(SimJob job, SimQueue queue, boolean jobIsTarget) Creates a new request for a job or queue or both, with the option to set the target entity.

Method Summary

Modifier and Type	Method and Description
abstract Req	forJob(SimJob job) Returns a copy of this request for another job.
abstract Req	forJobAndQueue(SimJob job, SimQueue queue) Returns a copy of this request for another job and another queue.
abstract Req	forQueue(SimQueue queue) Returns a copy of this request for another queue.
Req	forTargetEntity(SimEntity newTargetEntity) Creates a new request in which given new entity replaces the current job or queue.
SimJob	getJob() Returns the job associated with this request.
SimQueue	getQueue() Returns the queue associated with this request.

Methods inherited from class org.javades.jqueues.r5.entity.SimEntityOperation.RequestE

getTargetEntity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.javades.jqueues.r5.entity.SimEntityOperation.Request

getOperation

Constructor Detail

RequestJAndOrQ

public RequestJAndOrQ(SimJob job,
                      SimQueue queue,
                      boolean jobIsTarget)

Creates a new request for a job or queue or both, with the option to set the target entity.

Either the job or the queue or both must be non-null.

Parameters:

job - The job.

queue - The queue.

jobIsTarget - Whether to set the job true) or the queue (false) as the target entity.

Throws:

IllegalArgumentException - If both job and queue are null, or the target entity selected is null.

See Also:

SimEntityOperation.Request, SimEntityOperation.RequestE, SimEntityOperation.Request.getTargetEntity()

RequestJAndOrQ

public RequestJAndOrQ(SimJob job,
                      SimQueue queue)

Creates a new request for a job or queue or both, preferring a non-null queue as target entity.

Either the job or the queue or both must be non-null.

If the queue is non-null, it is always the target entity. If the job is non-null, it becaomes target entity if and only if the queue is null.

Parameters:

job - The job.

queue - The queue.

Throws:

IllegalArgumentException - If both job and queue are null.

See Also:

SimEntityOperation.Request, SimEntityOperation.RequestE, SimEntityOperation.Request.getTargetEntity()

Method Detail

getJob

public final SimJob getJob()

Returns the job associated with this request.

Note: job and queue cannot both be null.

Returns:

The job associated with this request, may be null.

See Also:

getQueue(), SimEntityOperation.RequestE.getTargetEntity()

getQueue

public final SimQueue getQueue()

Returns the queue associated with this request.

Note: job and queue cannot both be null.

Returns:

The queue associated with this request, may be null.

See Also:

getJob(), SimEntityOperation.RequestE.getTargetEntity()

forJob

public abstract Req forJob(SimJob job)

Returns a copy of this request for another job.

Parameters:

job - The new job, non-null.

Returns:

A copy of this request for given job.

Throws:

IllegalArgumentException - If the job is null.

UnsupportedOperationException - If this request does not support jobs.

forQueue

public abstract Req forQueue(SimQueue queue)

Returns a copy of this request for another queue.

Parameters:

queue - The new queue, non-null.

Returns:

A copy of this request for given queue.

Throws:

IllegalArgumentException - If the queue is null.

UnsupportedOperationException - If this request does not support queues.

forJobAndQueue

public abstract Req forJobAndQueue(SimJob job,
                                   SimQueue queue)

Returns a copy of this request for another job and another queue.

Parameters:

job - The new job, non-null.

queue - The new queue, non-null.

Returns:

A copy of this request for given job and queue.

Throws:

IllegalArgumentException - If the job and/or queue is null.

UnsupportedOperationException - If this request does not support jobs or does not support queues.

forTargetEntity

public final Req forTargetEntity(SimEntity newTargetEntity)

Creates a new request in which given new entity replaces the current job or queue.

In the current object, either the job or the queue is the target entity; the argument given must respect this. In other words, this implementation does not allow a change from job to queue as target entity, or vice versa.

Parameters:

newTargetEntity - The target entity, non-null.

Returns:

The new request in which given new entity replaces the current job or queue.

Throws:

IllegalArgumentException - If the target entity is null or does not match the type of the current target entity.

See Also:

forJob(org.javades.jqueues.r5.entity.jq.job.SimJob), forQueue(org.javades.jqueues.r5.entity.jq.queue.SimQueue), forJobAndQueue(org.javades.jqueues.r5.entity.jq.job.SimJob, org.javades.jqueues.r5.entity.jq.queue.SimQueue)