BEAST
eu.baltrad.beast.log.message.ILogMessageRepository Interface Reference

Interface for supporting log messages belonging to various modules. More...

Inheritance diagram for eu.baltrad.beast.log.message.ILogMessageRepository:
eu.baltrad.beast.log.message.LogMessageRepository

Public Member Functions

LogMessage getMessage (String ecode)
 Returns a log message for the specified error code.
 
String getModule (String ecode)
 Returns the module this error code belongs to.
 
List< LogMessagegetModuleMessages ()
 Returns all messages belonging to a specific module.
 
String getMessage (String code, String message, Object... args)
 Returns a message for specified module, code.
 

Detailed Description

Interface for supporting log messages belonging to various modules.

Author
Anders Henja

Member Function Documentation

◆ getMessage() [1/2]

String eu.baltrad.beast.log.message.ILogMessageRepository.getMessage ( String code,
String message,
Object... args )

Returns a message for specified module, code.

The provided message is the default format string if no message can be found.

Parameters
modulethe module
codethe error code
messagethe default message
argsthe argument list
Returns
a message

Implemented in eu.baltrad.beast.log.message.LogMessageRepository.

◆ getMessage() [2/2]

LogMessage eu.baltrad.beast.log.message.ILogMessageRepository.getMessage ( String ecode)

Returns a log message for the specified error code.

Parameters
ecodethe error code
Returns
the log message or null if no message found

Implemented in eu.baltrad.beast.log.message.LogMessageRepository.

◆ getModule()

String eu.baltrad.beast.log.message.ILogMessageRepository.getModule ( String ecode)

Returns the module this error code belongs to.

Parameters
ecodethe error code
Returns
the module or null if error code not could be found

Implemented in eu.baltrad.beast.log.message.LogMessageRepository.

◆ getModuleMessages()

List< LogMessage > eu.baltrad.beast.log.message.ILogMessageRepository.getModuleMessages ( )

Returns all messages belonging to a specific module.

The map has error codes as keys and log messages as values.

Parameters
modulethe specific module
Returns
the messages, might be empty but will never be null

Implemented in eu.baltrad.beast.log.message.LogMessageRepository.


The documentation for this interface was generated from the following file: