Package software.amazon.smithy.cli
Interface Style
-
- All Known Implementing Classes:
Style.SingularCode
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface Style
Parameters used to change the ANSI public style of text.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Style.SingularCode
A simple implementation ofStyle
that pushes a single code.
-
Field Summary
Fields Modifier and Type Field Description static Style
BG_BLACK
static Style
BG_BLUE
static Style
BG_BRIGHT_BLACK
static Style
BG_BRIGHT_BLUE
static Style
BG_BRIGHT_CYAN
static Style
BG_BRIGHT_GREEN
static Style
BG_BRIGHT_MAGENTA
static Style
BG_BRIGHT_RED
static Style
BG_BRIGHT_WHITE
static Style
BG_BRIGHT_YELLOW
static Style
BG_CYAN
static Style
BG_GREEN
static Style
BG_MAGENTA
static Style
BG_RED
static Style
BG_WHITE
static Style
BG_YELLOW
static Style
BLACK
static Style
BLUE
static Style
BOLD
static Style
BRIGHT_BLACK
static Style
BRIGHT_BLUE
static Style
BRIGHT_CYAN
static Style
BRIGHT_GREEN
static Style
BRIGHT_MAGENTA
static Style
BRIGHT_RED
static Style
BRIGHT_WHITE
static Style
BRIGHT_YELLOW
static Style
CYAN
static Style
FAINT
static Style
GREEN
static Style
ITALIC
static Style
MAGENTA
static Style
RED
static Style
UNDERLINE
static Style
WHITE
static Style
YELLOW
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static java.lang.String
format(java.lang.String text, Style... styles)
Formats the given text with ANSI escapes.void
pushCodes(java.util.function.IntConsumer codeConsumer)
Pushes one or more ANSI color codes to the consumer.
-
-
-
Field Detail
-
BOLD
static final Style BOLD
-
FAINT
static final Style FAINT
-
ITALIC
static final Style ITALIC
-
UNDERLINE
static final Style UNDERLINE
-
BLACK
static final Style BLACK
-
RED
static final Style RED
-
GREEN
static final Style GREEN
-
YELLOW
static final Style YELLOW
-
BLUE
static final Style BLUE
-
MAGENTA
static final Style MAGENTA
-
CYAN
static final Style CYAN
-
WHITE
static final Style WHITE
-
BRIGHT_BLACK
static final Style BRIGHT_BLACK
-
BRIGHT_RED
static final Style BRIGHT_RED
-
BRIGHT_GREEN
static final Style BRIGHT_GREEN
-
BRIGHT_YELLOW
static final Style BRIGHT_YELLOW
-
BRIGHT_BLUE
static final Style BRIGHT_BLUE
-
BRIGHT_MAGENTA
static final Style BRIGHT_MAGENTA
-
BRIGHT_CYAN
static final Style BRIGHT_CYAN
-
BRIGHT_WHITE
static final Style BRIGHT_WHITE
-
BG_BLACK
static final Style BG_BLACK
-
BG_RED
static final Style BG_RED
-
BG_GREEN
static final Style BG_GREEN
-
BG_YELLOW
static final Style BG_YELLOW
-
BG_BLUE
static final Style BG_BLUE
-
BG_MAGENTA
static final Style BG_MAGENTA
-
BG_CYAN
static final Style BG_CYAN
-
BG_WHITE
static final Style BG_WHITE
-
BG_BRIGHT_BLACK
static final Style BG_BRIGHT_BLACK
-
BG_BRIGHT_RED
static final Style BG_BRIGHT_RED
-
BG_BRIGHT_GREEN
static final Style BG_BRIGHT_GREEN
-
BG_BRIGHT_YELLOW
static final Style BG_BRIGHT_YELLOW
-
BG_BRIGHT_BLUE
static final Style BG_BRIGHT_BLUE
-
BG_BRIGHT_MAGENTA
static final Style BG_BRIGHT_MAGENTA
-
BG_BRIGHT_CYAN
static final Style BG_BRIGHT_CYAN
-
BG_BRIGHT_WHITE
static final Style BG_BRIGHT_WHITE
-
-
Method Detail
-
pushCodes
void pushCodes(java.util.function.IntConsumer codeConsumer)
Pushes one or more ANSI color codes to the consumer.Most implementations will push a single code, but multiple codes are needed to do things like use 8-bit colors (e.g., 38+5+206 to make pink foreground text).
- Parameters:
codeConsumer
- Consumer to push integers to.
-
format
static java.lang.String format(java.lang.String text, Style... styles)
Formats the given text with ANSI escapes.Each
styles
is one or more ANSI escape codes in the format of "1", "38;5;206" to create an 8-bit color, etc.- Parameters:
text
- Text to format.styles
- Styles to apply.- Returns:
- Returns the formatted text, and then resets the formatting.
- See Also:
- ANSI console codes
-
-