Platform SDK Java 8.5 API Reference

com.genesyslab.platform.logging.configuration
Enum MessageHeaderFormat

java.lang.Object
  extended by java.lang.Enum<MessageHeaderFormat>
      extended by com.genesyslab.platform.logging.configuration.MessageHeaderFormat
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MessageHeaderFormat>

public enum MessageHeaderFormat
extends java.lang.Enum<MessageHeaderFormat>

Describes the format of log string to be written into the log file.


Enum Constant Summary
FULL
          Full message header to be written to the log file.
MEDIUM
          Short message header with LoggerName info to be written to the log file.
SHORT
          Short message header to be written to the log file.
ShortCSV
          Short message header to be written to the log file.
ShortDSV
          Short message header to be written to the log file.
ShortTSV
          Short message header to be written to the log file.
 
Method Summary
static MessageHeaderFormat valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MessageHeaderFormat[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

SHORT

public static final MessageHeaderFormat SHORT
Short message header to be written to the log file.


FULL

public static final MessageHeaderFormat FULL
Full message header to be written to the log file.


MEDIUM

public static final MessageHeaderFormat MEDIUM
Short message header with LoggerName info to be written to the log file.


ShortCSV

public static final MessageHeaderFormat ShortCSV
Short message header to be written to the log file. Fields are separated by commas.


ShortTSV

public static final MessageHeaderFormat ShortTSV
Short message header to be written to the log file. Fields are separated by tabs.


ShortDSV

public static final MessageHeaderFormat ShortDSV
Short message header to be written to the log file. Fields are separated by defined delimiter.

Method Detail

values

public static MessageHeaderFormat[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (MessageHeaderFormat c : MessageHeaderFormat.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static MessageHeaderFormat valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.