org.writersforge.catalan.process.queue
Class Alert

java.lang.Object
  org.writersforge.catalan.process.queue.Alert

public final class Alert

extends java.lang.Object

A message returned from the transform processing.

Author:

jsheets

Constructor Summary

Alert(AlertPriority priority, java.lang.Exception exception)
Creates a new instance of Alert with an exception.

Alert(AlertPriority priority, java.lang.String message)
Creates a new instance of Alert with a text message.

Alert(AlertPriority priority, java.lang.String message, java.lang.Exception exception)
Creates a new instance of Alert with a text message and an exception.

Method Summary

java.lang.Exception	getException() Retrieves the optional thrown exception which triggered the alert.
java.lang.String	getMessage() Retrieves the optional text content of the alert.
AlertPriority	getPriority() Retrieves the priority of the alert.
java.lang.String	toString() Converts this object into String form.

Methods inherited from class java.lang.Object

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

Constructor Detail

Alert

public Alert(AlertPriority priority,
             java.lang.String message)

Creates a new instance of Alert with a text message.

Parameters:

priority - the alert priority

message - text content of the alert

Alert

public Alert(AlertPriority priority,
             java.lang.Exception exception)

Creates a new instance of Alert with an exception.

Parameters:

priority - the alert priority

exception - the thrown exception which triggered the alert

Alert

public Alert(AlertPriority priority,
             java.lang.String message,
             java.lang.Exception exception)

Creates a new instance of Alert with a text message and an exception.

Parameters:

priority - the alert priority

message - text content of the alert

exception - the thrown exception which triggered the alert

Method Detail

getPriority

public AlertPriority getPriority()

Retrieves the priority of the alert.

Returns:

alert the alert priority

getMessage

public java.lang.String getMessage()

Retrieves the optional text content of the alert.

Returns:

text the content of the alert

getException

public java.lang.Exception getException()

Retrieves the optional thrown exception which triggered the alert.

Returns:

the thrown exception

toString

public java.lang.String toString()

Converts this object into String form.

Returns:

String version of object