com.tivoli.jflt
Interface LogCatalog

All Known Implementing Classes:
LogCatalogSupport

public interface LogCatalog

Implementations of this interface provide the mechanism for accessing text strings for a set of messages with keys. Normally, these strings are stored in a messages file.

Version:
1.2
Author:
Cosimo Vampo, Raimondo Castino

Method Summary
 java.lang.String getMessage(java.lang.String key)
          Gets a message with no inserts from the catalog.
 java.lang.String getMessage(java.lang.String key, java.lang.Object param)
          Gets a message with one insert from the catalog.
 java.lang.String getMessage(java.lang.String key, java.lang.Object[] params)
          Gets a message with an array of inserts from the catalog.
 java.lang.String getMessage(java.lang.String key, java.lang.Object param1, java.lang.Object param2)
          Gets a message with two inserts from the catalog.
 java.lang.String getMessageCatalog()
          Gets the message catalog name.
 void setMessageCatalog(java.lang.String catalogName)
          Sets the message catalog name for this catalog.
 

Method Detail

getMessage

public java.lang.String getMessage(java.lang.String key)
Gets a message with no inserts from the catalog.
Parameters:
key - The key name of this message
Returns:
The formatted message from the catalog.

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object param)
Gets a message with one insert from the catalog.
Parameters:
key - The key name of this message
obj - An element to be inserted into the message
Returns:
The formatted message from the catalog.

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object param1,
                                   java.lang.Object param2)
Gets a message with two inserts from the catalog.
Parameters:
key - The key name of this message
obj1 - An element to be inserted into the message
obj2 - An element to be inserted into the message
Returns:
The formatted message from the catalog.

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object[] params)
Gets a message with an array of inserts from the catalog.
Parameters:
key - The key name of this message
objects - An array of elements to be inserted into the message
Returns:
The formatted message from the catalog.

getMessageCatalog

public java.lang.String getMessageCatalog()
Gets the message catalog name.
Returns:
The message catalog name for this catalog.

setMessageCatalog

public void setMessageCatalog(java.lang.String catalogName)
Sets the message catalog name for this catalog. Usually this name is the base name of a resource bundle or the name of a file containing the messages in some specific format.
Parameters:
catalogName - The catalog name which contains the messages. If null, the current value is not changed.