Enum Class TerminalColor

java.lang.Object
java.lang.Enum<TerminalColor>
com.github.oowekyala.ooxml.messages.TerminalColor
All Implemented Interfaces:
Serializable, Comparable<TerminalColor>, Constable
public enum TerminalColor extends Enum<TerminalColor>
ANSI escape sequences for colors, to style text in terminal environments.

  • Enum Constant Details

  • Field Details

  • Constructor Details

    • TerminalColor

      private TerminalColor(int fgCode)

  • Method Details

    • values

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

    • valueOf

      public static TerminalColor 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.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getEscape

      private String getEscape(boolean bright, boolean background, boolean bold)

    • getCode

      private int getCode(boolean bright, boolean background)

    • apply

      public String apply(String text, boolean bright, boolean background, boolean bold)
      Style the given string with this color. All text attributes are reset at the end.
      Parameters:
      text - Text to color
      bright - Whether to use a bright version of this color
      background - Whether to set the color on the text background rather than on the color
      bold - Whether to set the text as bold
      Returns:
      A string surrounded by escape sequences

    • style

      public static String style(String text, TerminalColor foreground, TerminalColor background, boolean brightFg, boolean brightBg, boolean boldText)
      Style both foreground and background. Returns a new string containing the parameter, which uses this ANSI code at the beginning, and resets all text attributes at the end.
      Parameters:
      text - Text to color
      foreground - Text color
      background - Background color
      brightFg - Whether text color is bright
      brightBg - Whether background color is bright
      boldText - Whether to set the text as bold
      Returns:
      A string surrounded by escape sequences