Package hudson.model.queue

Class ScheduleResult

java.lang.Object

hudson.model.queue.ScheduleResult

Direct Known Subclasses:

ScheduleResult.Created, ScheduleResult.Existing, ScheduleResult.Refused

public abstract class ScheduleResult
extends Object

Result of Queue.schedule2(hudson.model.Queue.Task, int, java.util.List<hudson.model.Action>)

Since:

1.521

Author:

Kohsuke Kawaguchi

See Also:

• Queue.schedule(Task, int, Action...)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ScheduleResult.Created
static final class	ScheduleResult.Existing
static final class	ScheduleResult.Refused

Constructor Summary

Constructors

Constructor	Description
ScheduleResult()

Method Summary

Modifier and Type	Method	Description
static ScheduleResult.Created	created(Queue.WaitingItem i)
static ScheduleResult.Existing	existing(Queue.Item i)
Queue.WaitingItem	getCreateItem()	If isCreated() returns true, then this method returns the newly created item, which is always of the type Queue.WaitingItem.
Queue.Item	getItem()	Unless isRefused() is true, this method either returns the newly created item in the queue or the existing item that's already in the queue that matched the submitted task.
final boolean	isAccepted()	Opposite of isRefused()
boolean	isCreated()	If true, the getItem() is newly created as a result of Queue.schedule2(hudson.model.Queue.Task, int, java.util.List<hudson.model.Action>).
boolean	isRefused()	The scheduling of the task was refused and the queue didn't change.
static ScheduleResult.Refused	refused()

Methods inherited from class java.lang.Object

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

Constructor Details

ScheduleResult

public ScheduleResult()

Method Details

isCreated

public boolean isCreated()

If true, the getItem() is newly created as a result of Queue.schedule2(hudson.model.Queue.Task, int, java.util.List<hudson.model.Action>).

isRefused

public boolean isRefused()

The scheduling of the task was refused and the queue didn't change. If this method returns true, getItem() will return null.

getItem

@CheckForNull
public Queue.Item getItem()

Unless isRefused() is true, this method either returns the newly created item in the queue or the existing item that's already in the queue that matched the submitted task.

getCreateItem

@CheckForNull
public Queue.WaitingItem getCreateItem()

If isCreated() returns true, then this method returns the newly created item, which is always of the type Queue.WaitingItem.

isAccepted

public final boolean isAccepted()

Opposite of isRefused()

created

public static ScheduleResult.Created created(Queue.WaitingItem i)

existing

public static ScheduleResult.Existing existing(Queue.Item i)

refused

public static ScheduleResult.Refused refused()