Enum Class AnsiColorFormatter

All Implemented Interfaces:
Serializable, Comparable<AnsiColorFormatter>, Constable, ColorFormatter

public enum AnsiColorFormatter extends Enum<AnsiColorFormatter> implements ColorFormatter
Styles text using ANSI color codes.
  • Enum Constant Details

    • NO_COLOR

      public static final AnsiColorFormatter NO_COLOR
      Does not write any color.

      public static final AnsiColorFormatter FORCE_COLOR
      Writes with ANSI colors.
    • AUTO

      public static final AnsiColorFormatter AUTO
      Writes using ANSI colors if it detects that the environment supports color.
  • Method Details

    • values

      public static AnsiColorFormatter[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static AnsiColorFormatter valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • detect

      public static AnsiColorFormatter detect()
      Detects if ANSI colors are supported and returns the appropriate Ansi enum variant.

      This method differs from using the AUTO variant directly because it will detect any changes to the environment that might enable or disable colors.

      Returns the detected ANSI color enum variant.