Module org.refcodes.logger
Package org.refcodes.logger

Enum ColumnLayout

java.lang.Object
java.lang.Enum<ColumnLayout>
org.refcodes.logger.ColumnLayout
All Implemented Interfaces:
Serializable, Comparable<ColumnLayout>, java.lang.constant.Constable
public enum ColumnLayout extends Enum<ColumnLayout>
Predefined layouts passed to logger implementation supporting ColumnLayout modes.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ANALYST
    All information is displayed, no information is cut off, an analyst might like it though it does not please your eyes any more.
    BASIC
    Similar to GRANDPA though even with more information omitted (makes each log line fit on one console line).
    DEVELOPER
    Some technical details may be omitted when logging.
    DEVOPS
    Some technical details may be omitted when logging though the Correlation.SESSION TID and the Correlation.REQUEST TID must not be omitted.
    ENDUSER
    Most technical details may be omitted, focus is the logging of human targeted information such a person using a command line tool which prints out some nicely formatted status information.
    GRANDPA
    A fallback layout trying to log most available information with taking information loss into account.
    HACKER
    Some technical details may be omitted when logging, though the messages are not truncated.
    NONE
    Some default layout is choosen.
    SUPERUSER
    All available information is to be logged with minimal information loss.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ColumnLayout
    toColumnLayout(String aValue)
    Case insensitive convenience method for converting a String to an according enumeration.
    org.refcodes.textual.ColumnSetupMetrics[]
    toColumnSetupMetrics()
    Creates the ColumnSetupMetrics for the actual enumeration instance.
    static ColumnLayout
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static ColumnLayout[]
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final ColumnLayout NONE
      Some default layout is choosen.

    • SUPERUSER

      public static final ColumnLayout SUPERUSER
      All available information is to be logged with minimal information loss. A superuser or administrator might like this layout.

    • GRANDPA

      public static final ColumnLayout GRANDPA
      A fallback layout trying to log most available information with taking information loss into account. You might like this in case you have a terminal width less than ConsoleDimension.NORM_WIDTH. This layout might be chosen automatically in case the column width is not sufficient for the other layouts.

    • BASIC

      public static final ColumnLayout BASIC
      Similar to GRANDPA though even with more information omitted (makes each log line fit on one console line).

    • DEVELOPER

      public static final ColumnLayout DEVELOPER
      Some technical details may be omitted when logging. Focus is the logging of development targeted information (such as method names or line numbers).

    • HACKER

      public static final ColumnLayout HACKER
      Some technical details may be omitted when logging, though the messages are not truncated.

    • DEVOPS

      public static final ColumnLayout DEVOPS
      Some technical details may be omitted when logging though the Correlation.SESSION TID and the Correlation.REQUEST TID must not be omitted. Focus is the logging of communication targeted information (such as the correlation IDs).

    • ENDUSER

      public static final ColumnLayout ENDUSER
      Most technical details may be omitted, focus is the logging of human targeted information such a person using a command line tool which prints out some nicely formatted status information.

    • ANALYST

      public static final ColumnLayout ANALYST
      All information is displayed, no information is cut off, an analyst might like it though it does not please your eyes any more.

  • Method Details

    • values

      public static ColumnLayout[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ColumnLayout valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toColumnSetupMetrics

      public org.refcodes.textual.ColumnSetupMetrics[] toColumnSetupMetrics()
      Creates the ColumnSetupMetrics for the actual enumeration instance.
      Returns:
      The ColumnSetupMetrics array in question.

    • toColumnLayout

      public static ColumnLayout toColumnLayout(String aValue)
      Case insensitive convenience method for converting a String to an according enumeration.
      Parameters:
      aValue - The String to be converted.
      Returns:
      The according enumeration or null if the provided value is unknown.