Package io.micronaut.core.util

Enum Class AnsiColour

java.lang.Object
java.lang.Enum<AnsiColour>
io.micronaut.core.util.AnsiColour
All Implemented Interfaces:
Serializable, Comparable<AnsiColour>, Constable
public enum AnsiColour extends Enum<AnsiColour>
Ansi color coding.
Since:
4.8.0

  • Enum Constant Details

    • RESET

      public static final AnsiColour RESET

    • BLACK

      public static final AnsiColour BLACK

    • RED

      public static final AnsiColour RED

    • GREEN

      public static final AnsiColour GREEN

    • YELLOW

      public static final AnsiColour YELLOW

    • BLUE

      public static final AnsiColour BLUE

    • MAGENTA

      public static final AnsiColour MAGENTA

    • CYAN

      public static final AnsiColour CYAN

    • WHITE

      public static final AnsiColour WHITE

    • BLACK_BOLD

      public static final AnsiColour BLACK_BOLD

    • RED_BOLD

      public static final AnsiColour RED_BOLD

    • GREEN_BOLD

      public static final AnsiColour GREEN_BOLD

    • YELLOW_BOLD

      public static final AnsiColour YELLOW_BOLD

    • BLUE_BOLD

      public static final AnsiColour BLUE_BOLD

    • MAGENTA_BOLD

      public static final AnsiColour MAGENTA_BOLD

    • CYAN_BOLD

      public static final AnsiColour CYAN_BOLD

    • WHITE_BOLD

      public static final AnsiColour WHITE_BOLD

    • BLACK_UNDERLINED

      public static final AnsiColour BLACK_UNDERLINED

    • RED_UNDERLINED

      public static final AnsiColour RED_UNDERLINED

    • GREEN_UNDERLINED

      public static final AnsiColour GREEN_UNDERLINED

    • YELLOW_UNDERLINED

      public static final AnsiColour YELLOW_UNDERLINED

    • BLUE_UNDERLINED

      public static final AnsiColour BLUE_UNDERLINED

    • MAGENTA_UNDERLINED

      public static final AnsiColour MAGENTA_UNDERLINED

    • CYAN_UNDERLINED

      public static final AnsiColour CYAN_UNDERLINED

    • WHITE_UNDERLINED

      public static final AnsiColour WHITE_UNDERLINED

    • BLACK_BACKGROUND

      public static final AnsiColour BLACK_BACKGROUND

    • RED_BACKGROUND

      public static final AnsiColour RED_BACKGROUND

    • GREEN_BACKGROUND

      public static final AnsiColour GREEN_BACKGROUND

    • YELLOW_BACKGROUND

      public static final AnsiColour YELLOW_BACKGROUND

    • BLUE_BACKGROUND

      public static final AnsiColour BLUE_BACKGROUND

    • MAGENTA_BACKGROUND

      public static final AnsiColour MAGENTA_BACKGROUND

    • CYAN_BACKGROUND

      public static final AnsiColour CYAN_BACKGROUND

    • WHITE_BACKGROUND

      public static final AnsiColour WHITE_BACKGROUND

    • BLACK_BRIGHT

      public static final AnsiColour BLACK_BRIGHT

    • RED_BRIGHT

      public static final AnsiColour RED_BRIGHT

    • GREEN_BRIGHT

      public static final AnsiColour GREEN_BRIGHT

    • YELLOW_BRIGHT

      public static final AnsiColour YELLOW_BRIGHT

    • BLUE_BRIGHT

      public static final AnsiColour BLUE_BRIGHT

    • MAGENTA_BRIGHT

      public static final AnsiColour MAGENTA_BRIGHT

    • CYAN_BRIGHT

      public static final AnsiColour CYAN_BRIGHT

    • WHITE_BRIGHT

      public static final AnsiColour WHITE_BRIGHT

    • BLACK_BOLD_BRIGHT

      public static final AnsiColour BLACK_BOLD_BRIGHT

    • RED_BOLD_BRIGHT

      public static final AnsiColour RED_BOLD_BRIGHT

    • GREEN_BOLD_BRIGHT

      public static final AnsiColour GREEN_BOLD_BRIGHT

    • YELLOW_BOLD_BRIGHT

      public static final AnsiColour YELLOW_BOLD_BRIGHT

    • BLUE_BOLD_BRIGHT

      public static final AnsiColour BLUE_BOLD_BRIGHT

    • MAGENTA_BOLD_BRIGHT

      public static final AnsiColour MAGENTA_BOLD_BRIGHT

    • CYAN_BOLD_BRIGHT

      public static final AnsiColour CYAN_BOLD_BRIGHT

    • WHITE_BOLD_BRIGHT

      public static final AnsiColour WHITE_BOLD_BRIGHT

    • BLACK_BACKGROUND_BRIGHT

      public static final AnsiColour BLACK_BACKGROUND_BRIGHT

    • RED_BACKGROUND_BRIGHT

      public static final AnsiColour RED_BACKGROUND_BRIGHT

    • GREEN_BACKGROUND_BRIGHT

      public static final AnsiColour GREEN_BACKGROUND_BRIGHT

    • YELLOW_BACKGROUND_BRIGHT

      public static final AnsiColour YELLOW_BACKGROUND_BRIGHT

    • BLUE_BACKGROUND_BRIGHT

      public static final AnsiColour BLUE_BACKGROUND_BRIGHT

    • MAGENTA_BACKGROUND_BRIGHT

      public static final AnsiColour MAGENTA_BACKGROUND_BRIGHT

    • CYAN_BACKGROUND_BRIGHT

      public static final AnsiColour CYAN_BACKGROUND_BRIGHT

    • WHITE_BACKGROUND_BRIGHT

      public static final AnsiColour WHITE_BACKGROUND_BRIGHT

  • Method Details

    • values

      public static AnsiColour[] 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 AnsiColour 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

    • cyan

      public static String cyan(String text)
      Highlight cyan if supported.
      Parameters:
      text - The text
      Returns:
      the string

    • brightCyan

      public static String brightCyan(String text)
      Highlight bright cyan if supported.
      Parameters:
      text - The text
      Returns:
      the string

    • yellow

      public static String yellow(@NonNull @NonNull String text)
      Highlight in yellow.
      Parameters:
      text - The text
      Returns:
      The formatted string

    • brightBlue

      public static String brightBlue(String text)
      Highlight in bright blue.
      Parameters:
      text - The text
      Returns:
      The formatted string

    • magentaBold

      public static String magentaBold(String text)
      Output in magenta bold.
      Parameters:
      text - The text
      Returns:
      The formatted text.

    • green

      public static String green(String text)
      Output green.
      Parameters:
      text - The text
      Returns:
      The formatted text

    • brightYellow

      public static String brightYellow(String text)
      Output bright yellow.
      Parameters:
      text - The text
      Returns:
      The formatted text

    • formatObject

      @NonNull public static @NonNull String formatObject(@Nullable @Nullable Object object)
      Format an object for display.
      Parameters:
      object - The object
      Returns:
      The formatted object

    • blue

      @NonNull public static @NonNull String blue(@NonNull @NonNull String text)
      Format blue.
      Parameters:
      text - The text
      Returns:
      The formatted text

    • toString

      public String toString()
      Overrides:
      toString in class Enum<AnsiColour>

    • isSupported

      public static boolean isSupported()
      Are ANSI colors supported.
      Returns:
      True if they are