org.xwiki.action

Class AbstractAction

java.lang.Object

org.xwiki.action.AbstractAction

All Implemented Interfaces:

Comparable<Action>, Action

public abstract class AbstractAction
extends Object
implements Action

Helper to implement Actions, providing some default implementation. We recommend Action writers to extend this class.

Since:

6.0M1

Version:

$Id: 4d49a239e4a2417965ef6fcf17c9e3cc8871eadd $

Constructor Summary

Constructors

Constructor and Description
AbstractAction()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Action action)
int	getPriority() The priority of execution relative to the other Actions.
void	setPriority(int priority)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.action.Action

execute, getSupportedActionIds

Constructor Detail

AbstractAction

public AbstractAction()

Method Detail

getPriority

public int getPriority()

Description copied from interface: Action

The priority of execution relative to the other Actions. The lowest values have the highest priorities and execute first. For example a Action with a priority of 100 will execute before one with a priority of 500.

Specified by:

getPriority in interface Action

Returns:

the execution priority

setPriority

public void setPriority(int priority)

Parameters:

priority - the Action priority to use (lower means execute before others), see getPriority()

compareTo

public int compareTo(Action action)

Specified by:

compareTo in interface Comparable<Action>