Package cz.mendelu.xotradov

Class MoveAction

java.lang.Object

cz.mendelu.xotradov.MoveAction

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction

@Extension
public class MoveAction
extends Object
implements RootAction

Handles request to move one buildable item in a build queue, which is the core functionality of this plugin.

Author:

Jaroslav Otradovec

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static String	ITEM_ID_PARAM_NAME
static String	MOVE_TYPE_PARAM_NAME
static String	VIEW_NAME_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
MoveAction()

Method Summary

Modifier and Type	Method	Description
void	doMove(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response)	Main method responsible for receiving request from user
Queue.Item	getBottom(List<Queue.Item> queueItems)
String	getDisplayName()
String	getIconFileName()
Queue.Item	getTop(Collection<Queue.Item> items)
String	getUrlName()
void	moveDown(Queue.Item itemA, Queue queue)
void	moveDownFiltered(Queue.Item itemToDown, Queue queue, View view)
void	moveToBottom(Queue.Item itemA, Queue queue)
void	moveToBottomFiltered(Queue.Item itemToBottom, Queue queue, View view)
void	moveToTop(Queue.Item itemA, Queue queue)
void	moveUp(Queue.Item itemA, Queue queue)
void	moveUpFiltered(Queue.Item itemToUp, Queue queue, View view)	Handles move of item when view is filtered.
void	putAOnTopOfB(Queue.Item itemA, Queue.Item itemB, Queue queue)

Methods inherited from class java.lang.Object

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

Field Detail

MOVE_TYPE_PARAM_NAME

public static final String MOVE_TYPE_PARAM_NAME

See Also:

Constant Field Values

ITEM_ID_PARAM_NAME

public static final String ITEM_ID_PARAM_NAME

See Also:

Constant Field Values

VIEW_NAME_PARAM_NAME

public static final String VIEW_NAME_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

MoveAction

public MoveAction()

Method Detail

getIconFileName

@CheckForNull
public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

@CheckForNull
public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

@CheckForNull
public String getUrlName()

Specified by:

getUrlName in interface Action

doMove

public void doMove(org.kohsuke.stapler.StaplerRequest request,
                   org.kohsuke.stapler.StaplerResponse response)

Main method responsible for receiving request from user

Parameters:

request - Stapler request from user

response - Stapler response send back to users browser

moveToBottomFiltered

public void moveToBottomFiltered(Queue.Item itemToBottom,
                                 Queue queue,
                                 @Nonnull
                                 View view)

getBottom

@CheckForNull
public Queue.Item getBottom(@Nonnull
                            List<Queue.Item> queueItems)

moveDownFiltered

public void moveDownFiltered(Queue.Item itemToDown,
                             Queue queue,
                             View view)

moveUpFiltered

public void moveUpFiltered(Queue.Item itemToUp,
                           Queue queue,
                           View view)

Handles move of item when view is filtered.

Parameters:

itemToUp - Item to be moved up

queue - Main queue from jenkins

view - View in which was request produced

putAOnTopOfB

public void putAOnTopOfB(@Nonnull
                         Queue.Item itemA,
                         @Nonnull
                         Queue.Item itemB,
                         @Nonnull
                         Queue queue)

getTop

@CheckForNull
public Queue.Item getTop(Collection<Queue.Item> items)

Returns:

Returns last item from collection, in queue it has the least priority

moveToTop

public void moveToTop(@Nonnull
                      Queue.Item itemA,
                      @Nonnull
                      Queue queue)

Parameters:

itemA - Item with least importance

moveUp

public void moveUp(Queue.Item itemA,
                   Queue queue)

Parameters:

itemA - Item to be moved up in list = more away from execution

moveDown

public void moveDown(Queue.Item itemA,
                     Queue queue)

moveToBottom

public void moveToBottom(@Nonnull
                         Queue.Item itemA,
                         @Nonnull
                         Queue queue)

Parameters:

itemA - The most important item