org.safs.logging

Class MessageTypeInfo

java.lang.Object

org.safs.logging.MessageTypeInfo

public class MessageTypeInfo
extends java.lang.Object

This helper class encapsulates all constant information related to a particular message type, including the STAF level that the type maps to, the prefix used in the text log, and the type string used in the xml log.

To get all constant information associated with a message type in a MessageTypeInfo, use the static get method:

MessageTypeInfo info = MessageTypeInfo.get(msgType);

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEBUG_MESSAGE_PREFIX
static java.lang.String	DEBUG_MESSAGE_XML_PREFIX
static java.lang.String	END_COUNTER_PREFIX
static java.lang.String	END_COUNTER_XML_PREFIX
static java.lang.String	END_CYCLE_PREFIX
static java.lang.String	END_CYCLE_XML_PREFIX
static java.lang.String	END_DATATABLE_PREFIX
static java.lang.String	END_DATATABLE_XML_PREFIX
static java.lang.String	END_PROCEDURE_PREFIX
static java.lang.String	END_PROCEDURE_XML_PREFIX
static java.lang.String	END_REQUIREMENT_PREFIX
static java.lang.String	END_REQUIREMENT_XML_PREFIX
static java.lang.String	END_SUITE_PREFIX
static java.lang.String	END_SUITE_XML_PREFIX
static java.lang.String	END_TESTCASE_PREFIX
static java.lang.String	END_TESTCASE_XML_PREFIX
static java.lang.String	FAILED_MESSAGE_PREFIX
static java.lang.String	FAILED_MESSAGE_XML_PREFIX
static java.lang.String	FAILED_OK_MESSAGE_PREFIX
static java.lang.String	FAILED_OK_MESSAGE_XML_PREFIX
static java.lang.String	GENERIC_MESSAGE_PREFIX
static java.lang.String	GENERIC_MESSAGE_XML_PREFIX
static java.lang.String	PASSED_MESSAGE_PREFIX
static java.lang.String	PASSED_MESSAGE_XML_PREFIX
static java.lang.String	RESUME_COUNTERS_PREFIX
static java.lang.String	RESUME_COUNTERS_XML_PREFIX
static java.lang.String	SKIPPED_TEST_PREFIX
static java.lang.String	SKIPPED_TEST_XML_PREFIX
java.lang.String	stafLevel STAF Log level that this message type maps to.
static java.lang.String	START_COUNTER_PREFIX
static java.lang.String	START_COUNTER_XML_PREFIX
static java.lang.String	START_CYCLE_PREFIX
static java.lang.String	START_CYCLE_XML_PREFIX
static java.lang.String	START_DATATABLE_PREFIX
static java.lang.String	START_DATATABLE_XML_PREFIX
static java.lang.String	START_LOGGING_PREFIX
static java.lang.String	START_LOGGING_XML_PREFIX
static java.lang.String	START_PROCEDURE_PREFIX
static java.lang.String	START_PROCEDURE_XML_PREFIX
static java.lang.String	START_REQUIREMENT_PREFIX
static java.lang.String	START_REQUIREMENT_XML_PREFIX
static java.lang.String	START_SUITE_PREFIX
static java.lang.String	START_SUITE_XML_PREFIX
static java.lang.String	START_TESTCASE_PREFIX
static java.lang.String	START_TESTCASE_XML_PREFIX
static java.lang.String	STATUS_REPORT_END_PREFIX
static java.lang.String	STATUS_REPORT_END_XML_PREFIX
static java.lang.String	STATUS_REPORT_GENERAL_FAILURES_PREFIX
static java.lang.String	STATUS_REPORT_GENERAL_FAILURES_XML_PREFIX
static java.lang.String	STATUS_REPORT_GENERAL_PASSES_PREFIX
static java.lang.String	STATUS_REPORT_GENERAL_PASSES_XML_PREFIX
static java.lang.String	STATUS_REPORT_GENERAL_PREFIX
static java.lang.String	STATUS_REPORT_GENERAL_WARNINGS_PREFIX
static java.lang.String	STATUS_REPORT_GENERAL_WARNINGS_XML_PREFIX
static java.lang.String	STATUS_REPORT_GENERAL_XML_PREFIX
static java.lang.String	STATUS_REPORT_IO_FAILURES_PREFIX
static java.lang.String	STATUS_REPORT_IO_FAILURES_XML_PREFIX
static java.lang.String	STATUS_REPORT_RECORDS_PREFIX
static java.lang.String	STATUS_REPORT_RECORDS_XML_PREFIX
static java.lang.String	STATUS_REPORT_SKIPPED_PREFIX
static java.lang.String	STATUS_REPORT_SKIPPED_XML_PREFIX
static java.lang.String	STATUS_REPORT_START_PREFIX
static java.lang.String	STATUS_REPORT_START_XML_PREFIX
static java.lang.String	STATUS_REPORT_TEST_FAILURES_PREFIX
static java.lang.String	STATUS_REPORT_TEST_FAILURES_XML_PREFIX
static java.lang.String	STATUS_REPORT_TEST_PASSES_PREFIX
static java.lang.String	STATUS_REPORT_TEST_PASSES_XML_PREFIX
static java.lang.String	STATUS_REPORT_TEST_WARNINGS_PREFIX
static java.lang.String	STATUS_REPORT_TEST_WARNINGS_XML_PREFIX
static java.lang.String	STATUS_REPORT_TESTS_PREFIX
static java.lang.String	STATUS_REPORT_TESTS_XML_PREFIX
static java.lang.String	STOP_LOGGING_PREFIX
static java.lang.String	STOP_LOGGING_XML_PREFIX
static java.lang.String	SUSPEND_COUNTERS_PREFIX
static java.lang.String	SUSPEND_COUNTERS_XML_PREFIX
java.lang.String	textPrefix Prefix string for this message type used in text log.
int	type The message type identifier.
static java.lang.String	WARNING_MESSAGE_PREFIX
static java.lang.String	WARNING_MESSAGE_XML_PREFIX
static java.lang.String	WARNING_OK_MESSAGE_PREFIX
static java.lang.String	WARNING_OK_MESSAGE_XML_PREFIX
java.lang.String	xmlPrefix Prefix string for this message type used in xml log.

Method Summary

Modifier and Type	Method and Description
static MessageTypeInfo	get(int type) Returns a MessageTypeInfo for a message type.
static boolean	typeBelongsToLevel(int type, int level) Tests if a message type "belongs to" a log level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG_MESSAGE_XML_PREFIX

public static final java.lang.String DEBUG_MESSAGE_XML_PREFIX

See Also:

Constant Field Values

GENERIC_MESSAGE_XML_PREFIX

public static final java.lang.String GENERIC_MESSAGE_XML_PREFIX

See Also:

Constant Field Values

SKIPPED_TEST_XML_PREFIX

public static final java.lang.String SKIPPED_TEST_XML_PREFIX

See Also:

Constant Field Values

FAILED_MESSAGE_XML_PREFIX

public static final java.lang.String FAILED_MESSAGE_XML_PREFIX

See Also:

Constant Field Values

FAILED_OK_MESSAGE_XML_PREFIX

public static final java.lang.String FAILED_OK_MESSAGE_XML_PREFIX

See Also:

Constant Field Values

PASSED_MESSAGE_XML_PREFIX

public static final java.lang.String PASSED_MESSAGE_XML_PREFIX

See Also:

Constant Field Values

WARNING_MESSAGE_XML_PREFIX

public static final java.lang.String WARNING_MESSAGE_XML_PREFIX

See Also:

Constant Field Values

WARNING_OK_MESSAGE_XML_PREFIX

public static final java.lang.String WARNING_OK_MESSAGE_XML_PREFIX

See Also:

Constant Field Values

START_DATATABLE_XML_PREFIX

public static final java.lang.String START_DATATABLE_XML_PREFIX

See Also:

Constant Field Values

END_DATATABLE_XML_PREFIX

public static final java.lang.String END_DATATABLE_XML_PREFIX

See Also:

Constant Field Values

START_PROCEDURE_XML_PREFIX

public static final java.lang.String START_PROCEDURE_XML_PREFIX

See Also:

Constant Field Values

END_PROCEDURE_XML_PREFIX

public static final java.lang.String END_PROCEDURE_XML_PREFIX

See Also:

Constant Field Values

START_TESTCASE_XML_PREFIX

public static final java.lang.String START_TESTCASE_XML_PREFIX

See Also:

Constant Field Values

END_TESTCASE_XML_PREFIX

public static final java.lang.String END_TESTCASE_XML_PREFIX

See Also:

Constant Field Values

START_SUITE_XML_PREFIX

public static final java.lang.String START_SUITE_XML_PREFIX

See Also:

Constant Field Values

END_SUITE_XML_PREFIX

public static final java.lang.String END_SUITE_XML_PREFIX

See Also:

Constant Field Values

START_COUNTER_XML_PREFIX

public static final java.lang.String START_COUNTER_XML_PREFIX

See Also:

Constant Field Values

END_COUNTER_XML_PREFIX

public static final java.lang.String END_COUNTER_XML_PREFIX

See Also:

Constant Field Values

SUSPEND_COUNTERS_XML_PREFIX

public static final java.lang.String SUSPEND_COUNTERS_XML_PREFIX

See Also:

Constant Field Values

RESUME_COUNTERS_XML_PREFIX

public static final java.lang.String RESUME_COUNTERS_XML_PREFIX

See Also:

Constant Field Values

START_CYCLE_XML_PREFIX

public static final java.lang.String START_CYCLE_XML_PREFIX

See Also:

Constant Field Values

END_CYCLE_XML_PREFIX

public static final java.lang.String END_CYCLE_XML_PREFIX

See Also:

Constant Field Values

START_LOGGING_XML_PREFIX

public static final java.lang.String START_LOGGING_XML_PREFIX

See Also:

Constant Field Values

STOP_LOGGING_XML_PREFIX

public static final java.lang.String STOP_LOGGING_XML_PREFIX

See Also:

Constant Field Values

START_REQUIREMENT_XML_PREFIX

public static final java.lang.String START_REQUIREMENT_XML_PREFIX

See Also:

Constant Field Values

END_REQUIREMENT_XML_PREFIX

public static final java.lang.String END_REQUIREMENT_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_START_XML_PREFIX

public static final java.lang.String STATUS_REPORT_START_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_RECORDS_XML_PREFIX

public static final java.lang.String STATUS_REPORT_RECORDS_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_SKIPPED_XML_PREFIX

public static final java.lang.String STATUS_REPORT_SKIPPED_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_TESTS_XML_PREFIX

public static final java.lang.String STATUS_REPORT_TESTS_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_TEST_PASSES_XML_PREFIX

public static final java.lang.String STATUS_REPORT_TEST_PASSES_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_TEST_WARNINGS_XML_PREFIX

public static final java.lang.String STATUS_REPORT_TEST_WARNINGS_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_TEST_FAILURES_XML_PREFIX

public static final java.lang.String STATUS_REPORT_TEST_FAILURES_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_XML_PREFIX

public static final java.lang.String STATUS_REPORT_GENERAL_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_PASSES_XML_PREFIX

public static final java.lang.String STATUS_REPORT_GENERAL_PASSES_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_WARNINGS_XML_PREFIX

public static final java.lang.String STATUS_REPORT_GENERAL_WARNINGS_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_FAILURES_XML_PREFIX

public static final java.lang.String STATUS_REPORT_GENERAL_FAILURES_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_IO_FAILURES_XML_PREFIX

public static final java.lang.String STATUS_REPORT_IO_FAILURES_XML_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_END_XML_PREFIX

public static final java.lang.String STATUS_REPORT_END_XML_PREFIX

See Also:

Constant Field Values

DEBUG_MESSAGE_PREFIX

public static final java.lang.String DEBUG_MESSAGE_PREFIX

See Also:

Constant Field Values

GENERIC_MESSAGE_PREFIX

public static final java.lang.String GENERIC_MESSAGE_PREFIX

See Also:

Constant Field Values

SKIPPED_TEST_PREFIX

public static final java.lang.String SKIPPED_TEST_PREFIX

See Also:

Constant Field Values

FAILED_MESSAGE_PREFIX

public static final java.lang.String FAILED_MESSAGE_PREFIX

See Also:

Constant Field Values

FAILED_OK_MESSAGE_PREFIX

public static final java.lang.String FAILED_OK_MESSAGE_PREFIX

See Also:

Constant Field Values

PASSED_MESSAGE_PREFIX

public static final java.lang.String PASSED_MESSAGE_PREFIX

See Also:

Constant Field Values

WARNING_MESSAGE_PREFIX

public static final java.lang.String WARNING_MESSAGE_PREFIX

See Also:

Constant Field Values

WARNING_OK_MESSAGE_PREFIX

public static final java.lang.String WARNING_OK_MESSAGE_PREFIX

See Also:

Constant Field Values

START_DATATABLE_PREFIX

public static final java.lang.String START_DATATABLE_PREFIX

See Also:

Constant Field Values

END_DATATABLE_PREFIX

public static final java.lang.String END_DATATABLE_PREFIX

See Also:

Constant Field Values

START_PROCEDURE_PREFIX

public static final java.lang.String START_PROCEDURE_PREFIX

See Also:

Constant Field Values

END_PROCEDURE_PREFIX

public static final java.lang.String END_PROCEDURE_PREFIX

See Also:

Constant Field Values

START_TESTCASE_PREFIX

public static final java.lang.String START_TESTCASE_PREFIX

See Also:

Constant Field Values

END_TESTCASE_PREFIX

public static final java.lang.String END_TESTCASE_PREFIX

See Also:

Constant Field Values

START_SUITE_PREFIX

public static final java.lang.String START_SUITE_PREFIX

See Also:

Constant Field Values

END_SUITE_PREFIX

public static final java.lang.String END_SUITE_PREFIX

See Also:

Constant Field Values

START_COUNTER_PREFIX

public static final java.lang.String START_COUNTER_PREFIX

See Also:

Constant Field Values

END_COUNTER_PREFIX

public static final java.lang.String END_COUNTER_PREFIX

See Also:

Constant Field Values

SUSPEND_COUNTERS_PREFIX

public static final java.lang.String SUSPEND_COUNTERS_PREFIX

See Also:

Constant Field Values

RESUME_COUNTERS_PREFIX

public static final java.lang.String RESUME_COUNTERS_PREFIX

See Also:

Constant Field Values

START_CYCLE_PREFIX

public static final java.lang.String START_CYCLE_PREFIX

See Also:

Constant Field Values

END_CYCLE_PREFIX

public static final java.lang.String END_CYCLE_PREFIX

See Also:

Constant Field Values

START_LOGGING_PREFIX

public static final java.lang.String START_LOGGING_PREFIX

See Also:

Constant Field Values

STOP_LOGGING_PREFIX

public static final java.lang.String STOP_LOGGING_PREFIX

See Also:

Constant Field Values

START_REQUIREMENT_PREFIX

public static final java.lang.String START_REQUIREMENT_PREFIX

See Also:

Constant Field Values

END_REQUIREMENT_PREFIX

public static final java.lang.String END_REQUIREMENT_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_START_PREFIX

public static final java.lang.String STATUS_REPORT_START_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_RECORDS_PREFIX

public static final java.lang.String STATUS_REPORT_RECORDS_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_SKIPPED_PREFIX

public static final java.lang.String STATUS_REPORT_SKIPPED_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_TESTS_PREFIX

public static final java.lang.String STATUS_REPORT_TESTS_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_TEST_PASSES_PREFIX

public static final java.lang.String STATUS_REPORT_TEST_PASSES_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_TEST_WARNINGS_PREFIX

public static final java.lang.String STATUS_REPORT_TEST_WARNINGS_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_TEST_FAILURES_PREFIX

public static final java.lang.String STATUS_REPORT_TEST_FAILURES_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_PREFIX

public static final java.lang.String STATUS_REPORT_GENERAL_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_PASSES_PREFIX

public static final java.lang.String STATUS_REPORT_GENERAL_PASSES_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_WARNINGS_PREFIX

public static final java.lang.String STATUS_REPORT_GENERAL_WARNINGS_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_GENERAL_FAILURES_PREFIX

public static final java.lang.String STATUS_REPORT_GENERAL_FAILURES_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_IO_FAILURES_PREFIX

public static final java.lang.String STATUS_REPORT_IO_FAILURES_PREFIX

See Also:

Constant Field Values

STATUS_REPORT_END_PREFIX

public static final java.lang.String STATUS_REPORT_END_PREFIX

See Also:

Constant Field Values

type

public int type

The message type identifier. Valid values are defined by AbstractLogFacility.

stafLevel

public java.lang.String stafLevel

STAF Log level that this message type maps to.

textPrefix

public java.lang.String textPrefix

Prefix string for this message type used in text log.

xmlPrefix

public java.lang.String xmlPrefix

Prefix string for this message type used in xml log.

Method Detail

get

public static MessageTypeInfo get(int type)

Returns a MessageTypeInfo for a message type.

Parameters:

type - the message type.

Returns:

the MessageTypeInfo for the specified type; null if type is not a standard SAFS message type.

typeBelongsToLevel

public static boolean typeBelongsToLevel(int type,
                                         int level)

Tests if a message type "belongs to" a log level.

A message will not be written to a log if its type does not pass the test against the log level of that log.

Parameters:

type - the message type to test.

level - the log level to test against. One of the LOGLEVEL constants defined by AbstractLogFacility.

Returns:

true if type passes the test of level; false if not.