Class Ansi

  • All Implemented Interfaces:
    java.lang.Appendable
    Direct Known Subclasses:
    Ansi.NoAnsi

    public class Ansi
    extends java.lang.Object
    implements java.lang.Appendable
    Provides a fluent API for generating ANSI escape sequences.
    Since:
    1.0
    • Field Detail

      • DISABLE

        public static final java.lang.String DISABLE
      • detector

        private static java.util.concurrent.Callable<java.lang.Boolean> detector
      • holder

        private static final java.lang.InheritableThreadLocal<java.lang.Boolean> holder
      • builder

        private final java.lang.StringBuilder builder
      • attributeOptions

        private final java.util.ArrayList<java.lang.Integer> attributeOptions
    • Constructor Detail

      • Ansi

        public Ansi()
      • Ansi

        public Ansi​(Ansi parent)
      • Ansi

        public Ansi​(int size)
      • Ansi

        public Ansi​(java.lang.StringBuilder builder)
    • Method Detail

      • setDetector

        public static void setDetector​(java.util.concurrent.Callable<java.lang.Boolean> detector)
      • isDetected

        public static boolean isDetected()
      • setEnabled

        public static void setEnabled​(boolean flag)
      • isEnabled

        public static boolean isEnabled()
      • ansi

        public static Ansi ansi()
      • ansi

        public static Ansi ansi​(java.lang.StringBuilder builder)
      • ansi

        public static Ansi ansi​(int size)
      • fg

        public Ansi fg​(int color)
      • fgRgb

        public Ansi fgRgb​(int color)
      • fgRgb

        public Ansi fgRgb​(int r,
                          int g,
                          int b)
      • fgBlack

        public Ansi fgBlack()
      • fgBlue

        public Ansi fgBlue()
      • fgCyan

        public Ansi fgCyan()
      • fgDefault

        public Ansi fgDefault()
      • fgGreen

        public Ansi fgGreen()
      • fgMagenta

        public Ansi fgMagenta()
      • fgRed

        public Ansi fgRed()
      • fgYellow

        public Ansi fgYellow()
      • bg

        public Ansi bg​(int color)
      • bgRgb

        public Ansi bgRgb​(int color)
      • bgRgb

        public Ansi bgRgb​(int r,
                          int g,
                          int b)
      • bgCyan

        public Ansi bgCyan()
      • bgDefault

        public Ansi bgDefault()
      • bgGreen

        public Ansi bgGreen()
      • bgMagenta

        public Ansi bgMagenta()
      • bgRed

        public Ansi bgRed()
      • bgYellow

        public Ansi bgYellow()
      • fgBrightBlack

        public Ansi fgBrightBlack()
      • fgBrightBlue

        public Ansi fgBrightBlue()
      • fgBrightCyan

        public Ansi fgBrightCyan()
      • fgBrightDefault

        public Ansi fgBrightDefault()
      • fgBrightGreen

        public Ansi fgBrightGreen()
      • fgBrightMagenta

        public Ansi fgBrightMagenta()
      • fgBrightRed

        public Ansi fgBrightRed()
      • fgBrightYellow

        public Ansi fgBrightYellow()
      • bgBrightCyan

        public Ansi bgBrightCyan()
      • bgBrightDefault

        public Ansi bgBrightDefault()
      • bgBrightGreen

        public Ansi bgBrightGreen()
      • bgBrightMagenta

        public Ansi bgBrightMagenta()
      • bgBrightRed

        public Ansi bgBrightRed()
      • bgBrightYellow

        public Ansi bgBrightYellow()
      • cursor

        public Ansi cursor​(int row,
                           int column)
        Moves the cursor to row n, column m. The values are 1-based, and default to 1 (top left corner) if omitted. A sequence such as CSI ;5H is a synonym for CSI 1;5H as well as CSI 17;H is the same as CSI 17H and CSI 17;1H
        Parameters:
        row - row (1-based) from top
        column - column (1 based) from left
        Returns:
        Ansi
      • cursorToColumn

        public Ansi cursorToColumn​(int x)
      • cursorUp

        public Ansi cursorUp​(int y)
      • cursorDown

        public Ansi cursorDown​(int y)
      • cursorRight

        public Ansi cursorRight​(int x)
      • cursorLeft

        public Ansi cursorLeft​(int x)
      • cursorDownLine

        public Ansi cursorDownLine()
      • cursorDownLine

        public Ansi cursorDownLine​(int n)
      • cursorUpLine

        public Ansi cursorUpLine()
      • cursorUpLine

        public Ansi cursorUpLine​(int n)
      • eraseScreen

        public Ansi eraseScreen()
      • eraseLine

        public Ansi eraseLine()
      • scrollUp

        public Ansi scrollUp​(int rows)
      • scrollDown

        public Ansi scrollDown​(int rows)
      • saveCursorPosition

        public Ansi saveCursorPosition()
      • restorCursorPosition

        @Deprecated
        public Ansi restorCursorPosition()
        Deprecated.
      • restoreCursorPosition

        public Ansi restoreCursorPosition()
      • reset

        public Ansi reset()
      • bold

        public Ansi bold()
      • boldOff

        public Ansi boldOff()
      • a

        public Ansi a​(java.lang.String value)
      • a

        public Ansi a​(boolean value)
      • a

        public Ansi a​(char value)
      • a

        public Ansi a​(char[] value,
                      int offset,
                      int len)
      • a

        public Ansi a​(char[] value)
      • a

        public Ansi a​(java.lang.CharSequence value,
                      int start,
                      int end)
      • a

        public Ansi a​(java.lang.CharSequence value)
      • a

        public Ansi a​(double value)
      • a

        public Ansi a​(float value)
      • a

        public Ansi a​(int value)
      • a

        public Ansi a​(long value)
      • a

        public Ansi a​(java.lang.Object value)
      • a

        public Ansi a​(java.lang.StringBuffer value)
      • newline

        public Ansi newline()
      • format

        public Ansi format​(java.lang.String pattern,
                           java.lang.Object... args)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • appendEscapeSequence

        private Ansi appendEscapeSequence​(char command)
      • appendEscapeSequence

        private Ansi appendEscapeSequence​(char command,
                                          int option)
      • appendEscapeSequence

        private Ansi appendEscapeSequence​(char command,
                                          java.lang.Object... options)
      • flushAttributes

        private void flushAttributes()
      • _appendEscapeSequence

        private Ansi _appendEscapeSequence​(char command,
                                           java.lang.Object... options)
      • append

        public Ansi append​(java.lang.CharSequence csq)
        Specified by:
        append in interface java.lang.Appendable
      • append

        public Ansi append​(java.lang.CharSequence csq,
                           int start,
                           int end)
        Specified by:
        append in interface java.lang.Appendable
      • append

        public Ansi append​(char c)
        Specified by:
        append in interface java.lang.Appendable