uk.ac.ed.epcc.webapp.model.lifecycle

Class ActionList<T extends DataObject>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<L>

uk.ac.ed.epcc.webapp.model.AbstractConstructedTargetList<T,ActionListener<T>>

uk.ac.ed.epcc.webapp.model.lifecycle.ActionList<T>

Type Parameters:

T - type of target

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ActionListener<T>>, java.util.Collection<ActionListener<T>>, java.util.Deque<ActionListener<T>>, java.util.List<ActionListener<T>>, java.util.Queue<ActionListener<T>>, Contexed, ActionListener<T>, Targetted<T>

public class ActionList<T extends DataObject>
extends AbstractConstructedTargetList<T,ActionListener<T>>
implements ActionListener<T>

A LinkedList of AbstractActions that is populated from configuration parameters. The aim is to remove unnecessary code dependencies This looks in the parameter tag.list-name where tag is the configuration tag for the parent factory. This value is interpreted as a comma separated list of class tags and used to create the listeners. The target classes for the listeners and the factory are checked for type conflicts.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ActionList(DataObjectFactory<T> factory, java.lang.String list_name)

Method Summary

Modifier and Type	Method and Description
void	action(T target) Called after the event has taken place (and any external actions have completed) to allow the LifeCycleListener to make/finalise corresponding changes to its own objects.
boolean	allow(T target, boolean throw_reason) Does the ActionListener want to allow the event to take place.
protected java.lang.Class<? super ActionListener>	getTemplate()
java.lang.Object	getWarning(T target) Get an optional object (usually a String or other object that can be added to display content) that should be presented to the user as warning before performing the operation.

Methods inherited from class uk.ac.ed.epcc.webapp.model.AbstractConstructedTargetList

getContext, getLogger, getTarget

Methods inherited from class java.util.LinkedList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.Targetted

getTarget

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, replaceAll, retainAll, sort, subList

Methods inherited from interface java.util.Deque

iterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ActionList

public ActionList(DataObjectFactory<T> factory,
                  java.lang.String list_name)

Method Detail

getTemplate

protected java.lang.Class<? super ActionListener> getTemplate()

Specified by:

getTemplate in class AbstractConstructedTargetList<T extends DataObject,ActionListener<T extends DataObject>>

allow

public boolean allow(T target,
                     boolean throw_reason)
              throws LifeCycleException

Description copied from interface: ActionListener

Does the ActionListener want to allow the event to take place. This is to give the listener a chance to veto the event when it knows in advance its not capable of supporting the operation in its current state. For example veto project setup because there are no machines configured.

Specified by:

allow in interface ActionListener<T extends DataObject>

Parameters:

target - object.

throw_reason - set to true to throw exception instead of returning boolean.

Returns:

boolean true if operation allowed

Throws:

LifeCycleException

action

public void action(T target)

Description copied from interface: ActionListener

Called after the event has taken place (and any external actions have completed) to allow the LifeCycleListener to make/finalise corresponding changes to its own objects.

Specified by:

action in interface ActionListener<T extends DataObject>

getWarning

public java.lang.Object getWarning(T target)

Description copied from interface: ActionListener

Get an optional object (usually a String or other object that can be added to display content) that should be presented to the user as warning before performing the operation. Usually this would be included in a confirm dialog. Confirmation might be triggered by one of the ActionListeners returning a non-null value

Specified by:

getWarning in interface ActionListener<T extends DataObject>

Returns:

Object or null