com.agenarisk.api.util

Class Advisory

java.lang.Object

com.agenarisk.api.util.Advisory

public class Advisory
extends Object

Advisory class allows to recover in recoverable situations and compile advisory messages instead of throwing exceptions.
Basic scenario: when loading a model in AgenaRisk Desktop, we'd rather load even invalid node tables and let the user sort them out, than to fail model load with an error.
Advisory class is thread-safe.

Author:

Eugene Dementiev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Advisory.AdvisoryGroup 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.
static class	Advisory.AdvisoryMessage AdvisoryMessage is an abstraction of a message with a possible Throwable cause.

Constructor Summary

Constructors

Constructor and Description
Advisory()

Method Summary

Modifier and Type	Method and Description
static boolean	addMessageIfLinked(String message) Returns true if Thread.currentThread() is linked to an AdvisoryGroup (also creates AdvisoryMessage and adds it to that group). Otherwise returns false.
static List<String>	compileAdvisoryMessages(Advisory.AdvisoryGroup agroup) Compiles a list of AdvisoryMessage texts, including messages of any Throwable causes of those AdvisoryMessages, for the provided AdvisoryGroup.
static List<String>	compileAdvisoryMessagesForCurrentThreadGroup() Compiles a list of AdvisoryMessage texts, including messages of any Throwable causes of those AdvisoryMessages, for the AdvisoryGroup linked to Thread.currentThread().
static void	destroy(Advisory.AdvisoryGroup aGroup) Destroys an AdvisoryGroup and breaks links to other objects.
static Advisory.AdvisoryGroup	getCurrentThreadGroup() Returns AdvisoryGroup to which Thread.currentThread() is linked to, or null.
static Advisory.AdvisoryGroup	getGroupByKey(Object key) Returns an AdvisoryGroup instance for the provided key. If no AdvisoryGroup exists for this key, it is created and then returned.
static Advisory.AdvisoryGroup	getGroupByThread(Thread thread) Returns AdvisoryGroup to which the provided Thread is linked to is linked to, or null.

Methods inherited from class java.lang.Object

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

Constructor Detail

Advisory

public Advisory()

Method Detail

getGroupByKey

public static Advisory.AdvisoryGroup getGroupByKey(Object key)

Returns an AdvisoryGroup instance for the provided key.
If no AdvisoryGroup exists for this key, it is created and then returned.

Parameters:

key - The key to uniquely identify the AdvisoryGroup. For example, a process ID or an ID of one of parallel jobs.

Returns:

AdvisoryGroup instance

getCurrentThreadGroup

public static Advisory.AdvisoryGroup getCurrentThreadGroup()

Returns AdvisoryGroup to which Thread.currentThread() is linked to, or null.

Returns:

AdvisoryGroup for current thread

getGroupByThread

public static Advisory.AdvisoryGroup getGroupByThread(Thread thread)

Returns AdvisoryGroup to which the provided Thread is linked to is linked to, or null.

Parameters:

thread - Thread to check if linked to an AdvisoryGroup

Returns:

AdvisoryGroup for provided Thread

destroy

public static void destroy(Advisory.AdvisoryGroup aGroup)

Destroys an AdvisoryGroup and breaks links to other objects.

Parameters:

aGroup - AdvisoryGroup to destroy

addMessageIfLinked

public static boolean addMessageIfLinked(String message)

Returns true if Thread.currentThread() is linked to an AdvisoryGroup (also creates AdvisoryMessage and adds it to that group).
Otherwise returns false.

Parameters:

message - text for the AdvisoryMessage

Returns:

true if an AdvisoryMessage was recorded

compileAdvisoryMessagesForCurrentThreadGroup

public static List<String> compileAdvisoryMessagesForCurrentThreadGroup()

Compiles a list of AdvisoryMessage texts, including messages of any Throwable causes of those AdvisoryMessages, for the AdvisoryGroup linked to Thread.currentThread().

Returns:

List of messages

compileAdvisoryMessages

public static List<String> compileAdvisoryMessages(Advisory.AdvisoryGroup agroup)

Compiles a list of AdvisoryMessage texts, including messages of any Throwable causes of those AdvisoryMessages, for the provided AdvisoryGroup.

Parameters:

agroup - AdvisoryGroup to compile messages from

Returns:

List of messages