org.duracloud.common.error

Class DuraCloudExceptionCore

java.lang.Object

org.duracloud.common.error.DuraCloudExceptionCore

All Implemented Interfaces:

Serializable, MessageFormattable

public class DuraCloudExceptionCore
extends Object
implements MessageFormattable, Serializable

This class is the core utility for supporting DuraCloud exceptions and user-friendly formatted messages.

Author:

Andrew Woods Date: Nov 20, 2009

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DuraCloudExceptionCore()
DuraCloudExceptionCore(String key)

Method Summary

Modifier and Type	Method and Description
String[]	getArgs() This method returns the args that act as variables in the message.
String	getFormattedMessage() This method returns the message which includes the arg elements.
String	getKey() This method returns the message key used as an index in the ResourceBundle.
void	setArgs(String... args) This method sets the arg variables that are placed in the message.

Methods inherited from class java.lang.Object

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

Constructor Detail

DuraCloudExceptionCore

public DuraCloudExceptionCore()

DuraCloudExceptionCore

public DuraCloudExceptionCore(String key)

Method Detail

getKey

public String getKey()

Description copied from interface: MessageFormattable

This method returns the message key used as an index in the ResourceBundle.

Specified by:

getKey in interface MessageFormattable

Returns:

key

getArgs

public String[] getArgs()

Description copied from interface: MessageFormattable

This method returns the args that act as variables in the message.

Specified by:

getArgs in interface MessageFormattable

Returns:

list of message elements

setArgs

public void setArgs(String... args)

Description copied from interface: MessageFormattable

This method sets the arg variables that are placed in the message.

Specified by:

setArgs in interface MessageFormattable

Parameters:

args - list of elements to be placed in message

getFormattedMessage

public String getFormattedMessage()

Description copied from interface: MessageFormattable

This method returns the message which includes the arg elements.

Specified by:

getFormattedMessage in interface MessageFormattable

Returns:

formatted message