org.duracloud.common.error

Interface MessageFormattable

All Known Implementing Classes:

AuditLogEmptyException, AuditLogReaderException, AuditLogWriteFailedException, ChecksumMismatchException, ContentNotAddedException, ContentStateException, ContentStoreException, DataSourceException, DuraCloudCheckedException, DuraCloudExceptionCore, DuraCloudRuntimeException, EmptyUserListException, InvalidEventTSVException, InvalidIdException, InvalidIdException, InvalidManifestException, InvalidRequestException, InvalidScheduleException, InvalidUsernameException, ManifestArgumentException, ManifestFormatterException, ManifestGeneratorException, ManifestNotFoundException, ManifestVerifyException, NotFoundException, NotFoundException, NotFoundException, NotFoundException, NoUserLoggedInException, ReportBuilderException, ReportException, ResourceChecksumException, ResourceException, ResourceNotFoundException, ResourceStateException, SnapshotDataException, StorageException, StorageReportCancelledException, StorageStateException, TaskException, UnauthorizedException, UnexpectedResponseException, UnknownResourceTypeException, UnsupportedTaskException, UnsupportedTaskException

public interface MessageFormattable

This interface defines the methods for creating formatted messages.

Author:

Andrew Woods Date: Nov 20, 2009

Method Summary

Methods

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.

Method Detail

getKey

String getKey()

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

Returns:

key

getArgs

String[] getArgs()

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

Returns:

list of message elements

setArgs

void setArgs(String... args)

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

Parameters:

args - list of elements to be placed in message

getFormattedMessage

String getFormattedMessage()

This method returns the message which includes the arg elements.

Returns:

formatted message