Package org.refcodes.logger

Enum ColumnLayout


  • public enum ColumnLayout
extends java.lang.Enum<ColumnLayout>
    Predefined layouts passed to logger implementation supporting ColumnLayout modes.

    • 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.
      DEVELOPER
      Just the information is logged which classical loggers log, no method name or line numbers or the like are logged.
      DEVOPS
      Some technical details may be omitted when logging though the Correlation.SESSION ID and the Correlation.REQUEST ID must not be omitted.
      END_USER
      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.
      SUPERUSER
      All available information is to be logged with minimal information loss.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ColumnLayout toColumnLayout​(java.lang.String aValue)
      Case insensitive convenience method for converting a String to an according enumeration.
      static ColumnLayout valueOf​(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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.

      • DEVELOPER

        public static final ColumnLayout DEVELOPER
        Just the information is logged which classical loggers log, no method name or line numbers or the like are logged.

      • DEVOPS

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

      • END_USER

        public static final ColumnLayout END_USER
        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 Detail

      • values

        public static ColumnLayout[] 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 (ColumnLayout c : ColumnLayout.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ColumnLayout 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

      • toColumnLayout

        public static ColumnLayout toColumnLayout​(java.lang.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.