Package org.duracloud.common.error
Interface MessageFormattable
-
- All Known Implementing Classes:
DuraCloudCheckedException,DuraCloudExceptionCore,DuraCloudRuntimeException,InvalidUsernameException,ManifestVerifyException,NoUserLoggedInException,RetryFlaggableException
public interface MessageFormattableThis interface defines the methods for creating formatted messages.- Author:
- Andrew Woods Date: Nov 20, 2009
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String[]getArgs()This method returns the args that act as variables in the message.StringgetFormattedMessage()This method returns the message which includes the arg elements.StringgetKey()This method returns the message key used as an index in the ResourceBundle.voidsetArgs(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
-
-