OpenJDK 27 · jdk.internal.org.jline.keymap.BindingReader

Modifier and Type	Field and Description
protected String	lastBinding
protected final StringBuilder	opBuffer
protected final Deque<Integer>	pushBackChar
protected final NonBlockingReader	reader

Access	Constructor and Description
public	BindingReader(NonBlockingReader reader)

Method Summary

Modifier and Type	Method and Description
public String	getCurrentBuffer()
public String	getLastBinding()
public int	peekCharacter(long timeout)
public < the type of bindings to be read T> T	Returns: the decoded binding or `null` if the end of stream has been reached readBinding(KeyMap<T> the KeyMap to use for decoding the input stream keys) Read from the input stream and decode an operation from the key map.
public <T> T	readBinding(KeyMap<T> keys, KeyMap<T> local)
public <T> T	readBinding(KeyMap<T> keys, KeyMap<T> local, boolean block)
public int	Returns: the character, or -1 if an EOF is received. readCharacter() Read a codepoint from the terminal.
public int	readCharacterBuffered()
public String	readStringUntil(String sequence)
public void	runMacro(String macro)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

lastBinding	back to summary
protected String lastBinding

opBuffer	back to summary
protected final StringBuilder opBuffer

pushBackChar	back to summary
protected final Deque<Integer> pushBackChar

reader	back to summary
protected final NonBlockingReader reader

BindingReader	back to summary
public BindingReader(NonBlockingReader reader)

Method Detail

getCurrentBuffer	back to summary
public String getCurrentBuffer()

getLastBinding	back to summary
public String getLastBinding()

peekCharacter	back to summary
public int peekCharacter(long timeout)

readBinding back to summary

readBinding	back to summary
public <T> T readBinding(KeyMap<T> keys) Read from the input stream and decode an operation from the key map. The input stream will be read character by character until a matching binding can be found. Characters that can't possibly be matched to any binding will be send with the `KeyMap#getNomatch()` binding. Unicode (>= 128) characters will be matched to `KeyMap#getUnicode()`. If the current key sequence is ambiguous, i.e. the sequence is bound but it's also a prefix to other sequences, then the `KeyMap#getAmbiguousTimeout()` timeout will be used to wait for another incoming character. If a character comes, the disambiguation will be done. If the timeout elapses and no character came in, or if the timeout is <= 0, the current bound operation will be returned. Parameters <T> the type of bindings to be read keys:KeyMap<T> the KeyMap to use for decoding the input stream Returns:T the decoded binding or `null` if the end of stream has been reached

public <T> T readBinding(KeyMap<T> keys)

Read from the input stream and decode an operation from the key map. The input stream will be read character by character until a matching binding can be found. Characters that can't possibly be matched to any binding will be send with the KeyMap#getNomatch() binding. Unicode (>= 128) characters will be matched to KeyMap#getUnicode(). If the current key sequence is ambiguous, i.e. the sequence is bound but it's also a prefix to other sequences, then the KeyMap#getAmbiguousTimeout() timeout will be used to wait for another incoming character. If a character comes, the disambiguation will be done. If the timeout elapses and no character came in, or if the timeout is <= 0, the current bound operation will be returned.

Parameters

<T>: the type of bindings to be read
keys:KeyMap<T>: the KeyMap to use for decoding the input stream

Returns:T

the decoded binding or null if the end of stream has been reached

readBinding	back to summary
public <T> T readBinding(KeyMap<T> keys, KeyMap<T> local)

readBinding	back to summary
public <T> T readBinding(KeyMap<T> keys, KeyMap<T> local, boolean block)

readCharacter	back to summary
public int readCharacter() Read a codepoint from the terminal. Returns:int the character, or -1 if an EOF is received.

readCharacter

back to summary

public int readCharacter()

Read a codepoint from the terminal.

Returns:int: the character, or -1 if an EOF is received.

readCharacterBuffered	back to summary
public int readCharacterBuffered()

readStringUntil	back to summary
public String readStringUntil(String sequence)

runMacro	back to summary
public void runMacro(String macro)

public Class BindingReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail