Package org.fusesource.jansi

Class Ansi

java.lang.Object
org.fusesource.jansi.Ansi
All Implemented Interfaces:
Appendable
public class Ansi extends Object implements Appendable
Provides a fluent API for generating ANSI escape sequences. This class comes from Jansi and is provided for backward compatibility with maven-shared-utils, while Maven has migrated to JLine (into which Jansi has been merged since JLine 3.25.0).

  • Constructor Details

    • Ansi

      public Ansi()

    • Ansi

      public Ansi(Ansi parent)

    • Ansi

      public Ansi(int size)

    • Ansi

      public Ansi(StringBuilder builder)

  • Method Details

    • isEnabled

      public static boolean isEnabled()

    • setEnabled

      public static void setEnabled(boolean flag)

    • ansi

      public static Ansi ansi()

    • ansi

      public static Ansi ansi(StringBuilder builder)

    • ansi

      public static Ansi ansi(int size)

    • fg

      public Ansi fg(Ansi.Color color)

    • 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(Ansi.Color color)

    • 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()

    • fgBright

      public Ansi fgBright(Ansi.Color color)

    • 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()

    • bgBright

      public Ansi bgBright(Ansi.Color color)

    • bgBrightCyan

      public Ansi bgBrightCyan()

    • bgBrightDefault

      public Ansi bgBrightDefault()

    • bgBrightGreen

      public Ansi bgBrightGreen()

    • bgBrightMagenta

      public Ansi bgBrightMagenta()

    • bgBrightRed

      public Ansi bgBrightRed()

    • bgBrightYellow

      public Ansi bgBrightYellow()

    • a

      public Ansi a(Ansi.Attribute attribute)

    • cursor

      public Ansi cursor(int row, int column)
      Moves the cursor to row n, column m. The values are 1-based. Any values less than 1 are mapped to 1.
      Parameters:
      row - row (1-based) from top
      column - column (1 based) from left
      Returns:
      this Ansi instance

    • cursorToColumn

      public Ansi cursorToColumn(int x)
      Moves the cursor to column n. The parameter n is 1-based. If n is less than 1 it is moved to the first column.
      Parameters:
      x - the index (1-based) of the column to move to
      Returns:
      this Ansi instance

    • cursorUp

      public Ansi cursorUp(int y)
      Moves the cursor up. If the parameter y is negative it moves the cursor down.
      Parameters:
      y - the number of lines to move up
      Returns:
      this Ansi instance

    • cursorDown

      public Ansi cursorDown(int y)
      Moves the cursor down. If the parameter y is negative it moves the cursor up.
      Parameters:
      y - the number of lines to move down
      Returns:
      this Ansi instance

    • cursorRight

      public Ansi cursorRight(int x)
      Moves the cursor right. If the parameter x is negative it moves the cursor left.
      Parameters:
      x - the number of characters to move right
      Returns:
      this Ansi instance

    • cursorLeft

      public Ansi cursorLeft(int x)
      Moves the cursor left. If the parameter x is negative it moves the cursor right.
      Parameters:
      x - the number of characters to move left
      Returns:
      this Ansi instance

    • cursorMove

      public Ansi cursorMove(int x, int y)
      Moves the cursor relative to the current position. The cursor is moved right if x is positive, left if negative and down if y is positive and up if negative.
      Parameters:
      x - the number of characters to move horizontally
      y - the number of lines to move vertically
      Returns:
      this Ansi instance
      Since:
      2.2

    • cursorDownLine

      public Ansi cursorDownLine()
      Moves the cursor to the beginning of the line below.
      Returns:
      this Ansi instance

    • cursorDownLine

      public Ansi cursorDownLine(int n)
      Moves the cursor to the beginning of the n-th line below. If the parameter n is negative it moves the cursor to the beginning of the n-th line above.
      Parameters:
      n - the number of lines to move the cursor
      Returns:
      this Ansi instance

    • cursorUpLine

      public Ansi cursorUpLine()
      Moves the cursor to the beginning of the line above.
      Returns:
      this Ansi instance

    • cursorUpLine

      public Ansi cursorUpLine(int n)
      Moves the cursor to the beginning of the n-th line above. If the parameter n is negative it moves the cursor to the beginning of the n-th line below.
      Parameters:
      n - the number of lines to move the cursor
      Returns:
      this Ansi instance

    • eraseScreen

      public Ansi eraseScreen()

    • eraseScreen

      public Ansi eraseScreen(Ansi.Erase kind)

    • eraseLine

      public Ansi eraseLine()

    • eraseLine

      public Ansi eraseLine(Ansi.Erase kind)

    • scrollUp

      public Ansi scrollUp(int rows)

    • scrollDown

      public Ansi scrollDown(int rows)

    • restorCursorPosition

      @Deprecated public Ansi restorCursorPosition()
      Deprecated.

    • saveCursorPosition

      public Ansi saveCursorPosition()

    • saveCursorPositionSCO

      public Ansi saveCursorPositionSCO()

    • saveCursorPositionDEC

      public Ansi saveCursorPositionDEC()

    • restoreCursorPosition

      public Ansi restoreCursorPosition()

    • restoreCursorPositionSCO

      public Ansi restoreCursorPositionSCO()

    • restoreCursorPositionDEC

      public Ansi restoreCursorPositionDEC()

    • reset

      public Ansi reset()

    • bold

      public Ansi bold()

    • boldOff

      public Ansi boldOff()

    • a

      public Ansi a(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(CharSequence value, int start, int end)

    • a

      public Ansi a(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(Object value)

    • a

      public Ansi a(StringBuffer value)

    • newline

      public Ansi newline()

    • format

      public Ansi format(String pattern, Object... args)

    • apply

      public Ansi apply(Ansi.Consumer fun)
      Applies another function to this Ansi instance.
      Parameters:
      fun - the function to apply
      Returns:
      this Ansi instance
      Since:
      2.2

    • render

      public Ansi render(String text)
      Uses the AnsiRenderer to generate the ANSI escape sequences for the supplied text.
      Parameters:
      text - text
      Returns:
      this
      Since:
      2.2

    • render

      public Ansi render(String text, Object... args)
      String formats and renders the supplied arguments. Uses the AnsiRenderer to generate the ANSI escape sequences.
      Parameters:
      text - format
      args - arguments
      Returns:
      this
      Since:
      2.2

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • append

      public Ansi append(CharSequence csq)
      Specified by:
      append in interface Appendable

    • append

      public Ansi append(CharSequence csq, int start, int end)
      Specified by:
      append in interface Appendable

    • append

      public Ansi append(char c)
      Specified by:
      append in interface Appendable