com.candle.roma.kxc
Class RomaLogInformation

java.lang.Object
  |
  +--com.candle.roma.kxc.RomaLogInformation

public class RomaLogInformation
extends java.lang.Object

This class encapsulates the human-readable information that can be logged to an error log or sent as an alert.


Constructor Summary
RomaLogInformation()
          Constructs RomaLogInformation with a default message.
 
Method Summary
 void setFormat(int format)
          Sets format flags.
 void setSeverity(int severity)
          Sets severity of the error.
 void setUserData(byte[] data, int length)
          Sets the user data part of the log or alert message.
 void setUserData(java.lang.String data)
          Sets the user data part of the log or alert message.
 void setUserText(java.lang.String userText)
          Sets the user text, which will be included in the log or alert message.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RomaLogInformation

public RomaLogInformation()
Constructs RomaLogInformation with a default message.
Method Detail

setSeverity

public void setSeverity(int severity)
Sets severity of the error.
Parameters:
severity - severity of the error. It is one of the following constants:
  • SEV_INFO
  • SEV_WARNING
  • SEV_ERROR
  • SEV_SEVERE

setFormat

public void setFormat(int format)
Sets format flags.
Parameters:
format - new Roma format setting. Can be FORMAT_NONE or any combination of the following constants :-
  • FORMAT_HEXDUMP
  • FORMAT_NOTIMESTAMP
  • FORMAT_NOSEVERITY

setUserText

public void setUserText(java.lang.String userText)
Sets the user text, which will be included in the log or alert message.
Parameters:
userText - the user text

setUserData

public void setUserData(byte[] data,
                        int length)
Sets the user data part of the log or alert message. If format is not set to FORMAT_HEXDUMP, then the user data will be included as a text string in the message. Otherwise it will be included as hex dump.
Parameters:
data - the new user data
length - the length of the new user data

setUserData

public void setUserData(java.lang.String data)
Sets the user data part of the log or alert message. If format is not set to FORMAT_HEXDUMP, then the user data will be included as a text string in the message. Otherwise it will be included as hex dump.
Parameters:
String - the new user data