Buffer

java.lang.Object
- org.jboss.aesh.console.Buffer

```
public class Buffer
extends java.lang.Object
```
A simple buffer to keep track of one line in the console and the cursor position.

Field Summary

Fields
Modifier and Type	Field and Description
`private static boolean`	`ansi`
`private int`	`cursor`
`private int`	`delta`
`private boolean`	`disablePrompt`
`private java.lang.StringBuilder`	`line`
`private boolean`	`multiLine`
`private java.lang.StringBuilder`	`multiLineBuffer`
`private Prompt`	`prompt`
`private static int`	`TAB`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Buffer(boolean ansi)`
`protected`	`Buffer(boolean ansi, Prompt prompt)` Instantiate a Buffer with given prompt
`protected`	`Buffer(Prompt prompt)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`changeCase()` Switch case if the current character is a letter.
`protected void`	`clear()`
`protected boolean`	`containRedirection()`
`protected void`	`delete(int start, int end)`
`protected void`	`disablePrompt(boolean disable)` Need to disable prompt in calculations involving search.
`protected int`	`getCursor()`
`protected int`	`getCursorWithPrompt()`
`int`	`getDelta()`
`java.lang.String`	`getLine()`
`protected char[]`	`getLineFrom(int position)` Get line from given param
`java.lang.String`	`getLineNoMask()`
`java.lang.String`	`getLineWithPrompt()` Get the complete line (including prompt)
`int`	`getMultiCursor()`
`java.lang.String`	`getMultiLine()`
`protected java.lang.String`	`getMultiLineBuffer()`
`protected Prompt`	`getPrompt()`
`protected int`	`getRedirectionPosition()`
`protected void`	`insert(int start, java.lang.String in)`
`boolean`	`isMasking()`
`protected boolean`	`isMultiLine()`
`protected boolean`	`isPromptDisabled()`
`protected int`	`length()`
`protected char[]`	`move(int move, int termWidth)` Move the cursor left if the param is negative, and right if its positive.
`protected char[]`	`move(int move, int termWidth, boolean viMode)`
`private int`	`moveCursor(int move, boolean viMode)` Make sure that the cursor do not move ob (out of bounds)
`private static char[]`	`printAnsi(char[] out)` Return a ansified string based on param
`static char[]`	`printAnsi(java.lang.String out)` Return a ansified string based on param
`protected void`	`replaceChar(char rChar)`
`protected void`	`replaceChar(char rChar, int pos)`
`protected void`	`reset()` Reset the buffer, keep the existing prompt
`protected void`	`reset(Prompt prompt)` Reset the buffer
`protected void`	`setCursor(int cursor)`
`protected void`	`setLine(java.lang.String line)`
`protected void`	`setMultiLine(boolean m)`
`protected int`	`totalLength()`
`protected void`	`updateMultiLineBuffer()`
`protected void`	`updatePrompt(Prompt prompt)`
`void`	`write(char c)` Write a char to the line and update cursor accordingly
`void`	`write(java.lang.String str)` Write a string to the line and update cursor accordingly

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cursor
```
private int cursor
```

line
```
private java.lang.StringBuilder line
```

prompt
```
private Prompt prompt
```

delta
```
private int delta
```

disablePrompt
```
private boolean disablePrompt
```

multiLine
```
private boolean multiLine
```

multiLineBuffer

private java.lang.StringBuilder multiLineBuffer

ansi
```
private static boolean ansi
```

TAB
```
private static final int TAB
```
See Also:

Constant Field Values

Constructor Detail

Buffer
```
protected Buffer(boolean ansi)
```

Buffer

protected Buffer(boolean ansi,
                 Prompt prompt)

Instantiate a Buffer with given prompt

Parameters:: prompt - set prompt

Buffer
```
protected Buffer(Prompt prompt)
```

Method Detail

reset
```
protected void reset(Prompt prompt)
```
Reset the buffer

Parameters:

prompt - set prompt

reset
```
protected void reset()
```
Reset the buffer, keep the existing prompt

updatePrompt

protected void updatePrompt(Prompt prompt)

length
```
protected int length()
```
Returns:

length of the line without prompt

totalLength
```
protected int totalLength()
```

getCursor
```
protected int getCursor()
```

getCursorWithPrompt
```
protected int getCursorWithPrompt()
```

getPrompt
```
protected Prompt getPrompt()
```

setCursor
```
protected void setCursor(int cursor)
```

isMultiLine
```
protected boolean isMultiLine()
```

setMultiLine

protected void setMultiLine(boolean m)

updateMultiLineBuffer

protected void updateMultiLineBuffer()

getMultiLineBuffer

protected java.lang.String getMultiLineBuffer()

isMasking
```
public boolean isMasking()
```

disablePrompt
```
protected void disablePrompt(boolean disable)
```
Need to disable prompt in calculations involving search.

Parameters:

disable - prompt or not

isPromptDisabled
```
protected boolean isPromptDisabled()
```

move
```
protected char[] move(int move,
                      int termWidth)
```
Move the cursor left if the param is negative, and right if its positive. Return ansi code to represent the move

Parameters:

move - where to move

termWidth - terminal width

Returns:

ansi string that represent the move

move

protected char[] move(int move,
                      int termWidth,
                      boolean viMode)

printAnsi
```
public static char[] printAnsi(java.lang.String out)
```
Return a ansified string based on param

Parameters:

out - string

Returns:

ansified string

printAnsi
```
private static char[] printAnsi(char[] out)
```
Return a ansified string based on param

Parameters:

out - what will be ansified

Returns:

ansified string

moveCursor
```
private int moveCursor(int move,
                       boolean viMode)
```
Make sure that the cursor do not move ob (out of bounds)

Parameters:

move - left if its negative, right if its positive

viMode - if viMode we need other restrictions compared to emacs movement

Returns:

adjusted movement

getLineFrom
```
protected char[] getLineFrom(int position)
```
Get line from given param

Parameters:

position - in line

Returns:

line from position

getLine
```
public java.lang.String getLine()
```

getLineNoMask

public java.lang.String getLineNoMask()

setLine

protected void setLine(java.lang.String line)

getMultiLine

public java.lang.String getMultiLine()

getMultiCursor
```
public int getMultiCursor()
```

delete

protected void delete(int start,
                      int end)

insert

protected void insert(int start,
                      java.lang.String in)

getLineWithPrompt
```
public java.lang.String getLineWithPrompt()
```
Get the complete line (including prompt)

Returns:

complete line

write
```
public void write(char c)
```
Write a char to the line and update cursor accordingly

Parameters:

c - char

write
```
public void write(java.lang.String str)
```
Write a string to the line and update cursor accordingly

Parameters:

str - string

clear
```
protected void clear()
```

getDelta
```
public int getDelta()
```

changeCase
```
protected boolean changeCase()
```
Switch case if the current character is a letter.

Returns:

false if the character is not a letter, else true

replaceChar

protected void replaceChar(char rChar)

replaceChar

protected void replaceChar(char rChar,
                           int pos)

containRedirection

protected boolean containRedirection()

getRedirectionPosition

protected int getRedirectionPosition()

Class Buffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cursor

line

prompt

delta

disablePrompt

multiLine

multiLineBuffer

ansi

TAB

Constructor Detail

Buffer

Buffer

Buffer

Method Detail

reset

reset

updatePrompt

length

totalLength

getCursor

getCursorWithPrompt

getPrompt

setCursor

isMultiLine

setMultiLine

updateMultiLineBuffer

getMultiLineBuffer

isMasking

disablePrompt

isPromptDisabled

move

move

printAnsi

printAnsi

moveCursor

getLineFrom

getLine

getLineNoMask

setLine

getMultiLine

getMultiCursor

delete

insert

getLineWithPrompt

write

write

clear

getDelta

changeCase

replaceChar

replaceChar

containRedirection

getRedirectionPosition