com.agenarisk.api.util

Class Advisory.AdvisoryGroup

java.lang.Object

com.agenarisk.api.util.Advisory.AdvisoryGroup

Enclosing class:

Advisory

public static class Advisory.AdvisoryGroup
extends Object

AdvisoryGroup instance is associated with a number of Threads and is abstractly associated with some particular job (which is potentially multi-threaded).
AdvisoryGroup class is thread-safe.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdvisoryGroup(Object key)

Method Summary

Modifier and Type	Method and Description
void	addMessage(Advisory.AdvisoryMessage message) Adds an AdvisoryMessage to this AdvisoryGroup.
Set<Thread>	getGroupThreads() Returns the Set of Threads linked to this AdvisoryGroup. Warning: modifying this Set directly will affect the workings of the Advisory and is NOT recommended.
protected Object	getKey() Getter for AdvisoryGroup key
List<Advisory.AdvisoryMessage>	getMessages() Returns the List of AdvisoryMessages for this AdvisoryGroup. Warning: modifying this List directly will affect the workings of the Advisory and is NOT recommended.
boolean	isLinkedTo(Thread thread) Checks if this AdvisoryGroup is linked to the provided Thread.
void	linkToThread(Thread thread) Links the provided Thread to this AdvisoryGroup.
void	unlinkThread(Thread thread) Unlinks provided Thread from this AdvisoryGroup

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvisoryGroup

protected AdvisoryGroup(Object key)

Method Detail

linkToThread

public void linkToThread(Thread thread)

Links the provided Thread to this AdvisoryGroup.

Parameters:

thread - Thread to link to this AdvisoryGroup

Throws:

RuntimeException - if the provided Thread is already linked to another AdvisoryGroup

getKey

protected Object getKey()

Getter for AdvisoryGroup key

Returns:

AdvisoryGroup key

unlinkThread

public void unlinkThread(Thread thread)

Unlinks provided Thread from this AdvisoryGroup

Parameters:

thread - Thread to unlink

addMessage

public void addMessage(Advisory.AdvisoryMessage message)

Adds an AdvisoryMessage to this AdvisoryGroup.

Parameters:

message - AdvisoryMessage to add to this AdvisoryGroup

isLinkedTo

public boolean isLinkedTo(Thread thread)

Checks if this AdvisoryGroup is linked to the provided Thread.

Parameters:

thread - Thread to check

Returns:

true if the provided Thread is linked to this AdvisoryGroup and false otherwise

getMessages

public List<Advisory.AdvisoryMessage> getMessages()

Returns the List of AdvisoryMessages for this AdvisoryGroup.
Warning: modifying this List directly will affect the workings of the Advisory and is NOT recommended.

Returns:

List of AdvisoryMessages for this AdvisoryGroup

getGroupThreads

public Set<Thread> getGroupThreads()

Returns the Set of Threads linked to this AdvisoryGroup.
Warning: modifying this Set directly will affect the workings of the Advisory and is NOT recommended.

Returns:

Set of Threads linked to this AdvisoryGroup