Package org.duracloud.common.error

Interface MessageFormattable

All Known Implementing Classes:
DuraCloudCheckedException, DuraCloudExceptionCore, DuraCloudRuntimeException, InvalidUsernameException, ManifestVerifyException, NoUserLoggedInException, RetryFlaggableException
public interface MessageFormattable
This interface defines the methods for creating formatted messages.
Author:
Andrew Woods Date: Nov 20, 2009

  • Method Summary

    Modifier and Type
    Method
    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 Details

    • 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