Class CompleteOperationImpl

java.lang.Object

org.aesh.readline.completion.CompleteOperationImpl

All Implemented Interfaces:

CompleteOperation

public class CompleteOperationImpl
extends Object
implements CompleteOperation

A payload object to store completion data

Author:

Ståle W. Pedersen invalid input: '<'stale.pedersen@jboss.org>

Constructor Summary

Constructors

Constructor	Description
CompleteOperationImpl(String buffer, int cursor)

Method Summary

Modifier and Type	Method	Description
void	addCompletionCandidate(String completionCandidate)
void	addCompletionCandidate(TerminalString completionCandidate)
void	addCompletionCandidates(List<String> completionCandidates)
void	addCompletionCandidatesTerminalString(List<TerminalString> completionCandidates)
void	doAppendSeparator(boolean appendSeparator)	Set if this CompletionOperation would allow an separator to be appended.
boolean	doIgnoreNonEscapedSpace()
boolean	doIgnoreOffset()
String	getBuffer()
List<TerminalString>	getCompletionCandidates()
int	getCursor()
String	getFormattedCompletion(String completion)
List<String>	getFormattedCompletionCandidates()
List<TerminalString>	getFormattedCompletionCandidatesTerminalString()
String	getNonTrimmedBuffer()
int	getOffset()
char	getSeparator()	Get the separator character, by default its space
int	getTrimmedSize()
boolean	hasAppendSeparator()	Do this completion allow for appending a separator after completion?
boolean	isIgnoreStartsWith()
boolean	isTrimmed()
void	removeEscapedSpacesFromCompletionCandidates()
void	setCompletionCandidates(List<String> completionCandidates)
void	setCompletionCandidatesTerminalString(List<TerminalString> completionCandidates)
void	setIgnoreNonEscapedSpace(boolean ignoreNonEscapedSpace)
void	setIgnoreOffset(boolean ignoreOffset)
void	setIgnoreStartsWith(boolean ignoreStartsWith)
void	setOffset(int offset)
void	setSeparator(char separator)	By default the separator is one space char, but it can be overridden here.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CompleteOperationImpl

public CompleteOperationImpl(String buffer,
 int cursor)

Method Details

getBuffer

public String getBuffer()

Specified by:

getBuffer in interface CompleteOperation

isTrimmed

public boolean isTrimmed()

getTrimmedSize

public int getTrimmedSize()

getNonTrimmedBuffer

public String getNonTrimmedBuffer()

getCursor

public int getCursor()

Specified by:

getCursor in interface CompleteOperation

getOffset

public int getOffset()

Specified by:

getOffset in interface CompleteOperation

setOffset

public void setOffset(int offset)

Specified by:

setOffset in interface CompleteOperation

setIgnoreOffset

public void setIgnoreOffset(boolean ignoreOffset)

Specified by:

setIgnoreOffset in interface CompleteOperation

doIgnoreOffset

public boolean doIgnoreOffset()

Specified by:

doIgnoreOffset in interface CompleteOperation

getSeparator

public char getSeparator()

Get the separator character, by default its space

Specified by:

getSeparator in interface CompleteOperation

Returns:

separator

setSeparator

public void setSeparator(char separator)

By default the separator is one space char, but it can be overridden here.

Specified by:

setSeparator in interface CompleteOperation

Parameters:

separator - separator

hasAppendSeparator

public boolean hasAppendSeparator()

Do this completion allow for appending a separator after completion? By default this is true.

Specified by:

hasAppendSeparator in interface CompleteOperation

Returns:

appendSeparator

doAppendSeparator

public void doAppendSeparator(boolean appendSeparator)

Set if this CompletionOperation would allow an separator to be appended. By default this is true.

Specified by:

doAppendSeparator in interface CompleteOperation

Parameters:

appendSeparator - appendSeparator

getCompletionCandidates

public List<TerminalString> getCompletionCandidates()

Specified by:

getCompletionCandidates in interface CompleteOperation

setCompletionCandidates

public void setCompletionCandidates(List<String> completionCandidates)

setCompletionCandidatesTerminalString

public void setCompletionCandidatesTerminalString(List<TerminalString> completionCandidates)

addCompletionCandidate

public void addCompletionCandidate(TerminalString completionCandidate)

Specified by:

addCompletionCandidate in interface CompleteOperation

addCompletionCandidate

public void addCompletionCandidate(String completionCandidate)

Specified by:

addCompletionCandidate in interface CompleteOperation

addCompletionCandidates

public void addCompletionCandidates(List<String> completionCandidates)

Specified by:

addCompletionCandidates in interface CompleteOperation

addCompletionCandidatesTerminalString

public void addCompletionCandidatesTerminalString(List<TerminalString> completionCandidates)

Specified by:

addCompletionCandidatesTerminalString in interface CompleteOperation

removeEscapedSpacesFromCompletionCandidates

public void removeEscapedSpacesFromCompletionCandidates()

Specified by:

removeEscapedSpacesFromCompletionCandidates in interface CompleteOperation

getFormattedCompletionCandidates

public List<String> getFormattedCompletionCandidates()

Specified by:

getFormattedCompletionCandidates in interface CompleteOperation

getFormattedCompletionCandidatesTerminalString

public List<TerminalString> getFormattedCompletionCandidatesTerminalString()

Specified by:

getFormattedCompletionCandidatesTerminalString in interface CompleteOperation

getFormattedCompletion

public String getFormattedCompletion(String completion)

Specified by:

getFormattedCompletion in interface CompleteOperation

isIgnoreStartsWith

public boolean isIgnoreStartsWith()

Specified by:

isIgnoreStartsWith in interface CompleteOperation

setIgnoreStartsWith

public void setIgnoreStartsWith(boolean ignoreStartsWith)

Specified by:

setIgnoreStartsWith in interface CompleteOperation

doIgnoreNonEscapedSpace

public boolean doIgnoreNonEscapedSpace()

Specified by:

doIgnoreNonEscapedSpace in interface CompleteOperation

setIgnoreNonEscapedSpace

public void setIgnoreNonEscapedSpace(boolean ignoreNonEscapedSpace)

Specified by:

setIgnoreNonEscapedSpace in interface CompleteOperation

toString

public String toString()

Overrides:

toString in class Object