xapi.util.impl

Class ReceivesPrioritizedValue<T>

java.lang.Object

xapi.util.impl.ReceivesMultiValue<T>

xapi.util.impl.ReceivesPrioritizedValue<T>

Type Parameters:

T -

All Implemented Interfaces:

ReceivesValue<T>

public class ReceivesPrioritizedValue<T>
extends ReceivesMultiValue<T>

An extension of ReceivesMultiValue which uses three prioritized callback buckets.

#addPre(ReceivesValue, boolean) - pushes callback onto stack called before all others. Send true to push on head of pre stack

addPost(ReceivesValue) - pushes callback onto bottom of the stack called after all others. Send true to push on head of pre stack

#addToHead(ReceivesValue) - push callback on top of main callback stack

ReceivesMultiValue.addReceiver(ReceivesValue) - push callback on bottom of main callback stack

Author:

James X. Nelson (james@wetheinter.net, @james)

Nested Class Summary

Nested classes/interfaces inherited from interface xapi.util.api.ReceivesValue

ReceivesValue.NoOp<T>

Constructor Summary

Constructors

Constructor and Description
ReceivesPrioritizedValue()

Method Summary

Modifier and Type	Method and Description
void	addPost(ReceivesValue<T> receiver) Adds a callback that will be fired after the pre and main callback stacks
void	addPre(ReceivesValue<T> receiver) Adds a callback that will be fired before the main and post callback stacks
void	clearReceivers() Clear all callback stacks.
void	removeReceiver(ReceivesValue<T> receiver) Explicitly remove the given receiver from all callback stacks.
void	set(T value) Send an object to all of our callbacks, in prioritized order.

Methods inherited from class xapi.util.impl.ReceivesMultiValue

addReceiver

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceivesPrioritizedValue

public ReceivesPrioritizedValue()

Method Detail

addPre

public void addPre(ReceivesValue<T> receiver)

Adds a callback that will be fired before the main and post callback stacks

Parameters:

receiver - - The receiver to add to pre-fire stack

top - - true to unshift onto head, false to push onto tail

addPost

public void addPost(ReceivesValue<T> receiver)

Adds a callback that will be fired after the pre and main callback stacks

Parameters:

receiver - - The receiver to add to pre-fire stack

top - - true to unshift onto head, false to push onto tail

set

public void set(T value)

Send an object to all of our callbacks, in prioritized order.

Specified by:

set in interface ReceivesValue<T>

Overrides:

set in class ReceivesMultiValue<T>

Parameters:

value - - The object to receive.

clearReceivers

public void clearReceivers()

Clear all callback stacks.

Overrides:

clearReceivers in class ReceivesMultiValue<T>

removeReceiver

public void removeReceiver(ReceivesValue<T> receiver)

Explicitly remove the given receiver from all callback stacks.

Overrides:

removeReceiver in class ReceivesMultiValue<T>

Parameters:

receiver - - The receiver to remove.