org.jboss.aesh.complete

Class CompleteOperation

java.lang.Object

org.jboss.aesh.complete.CompleteOperation

public class CompleteOperation
extends java.lang.Object

A payload object to store completion data

Field Summary

Fields

Modifier and Type	Field and Description
private AeshContext	aeshContext
private boolean	appendSeparator
private java.lang.String	buffer
private java.util.List<TerminalString>	completionCandidates
private int	cursor
private boolean	ignoreNonEscapedSpace
private boolean	ignoreOffset
private boolean	ignoreStartsWith
private java.lang.String	nonTrimmedBuffer
private int	offset
private char	separator
private boolean	trimmed

Constructor Summary

Constructors

Constructor and Description
CompleteOperation(AeshContext aeshContext, java.lang.String buffer, int cursor)

Method Summary

Modifier and Type	Method and Description
void	addCompletionCandidate(java.lang.String completionCandidate)
void	addCompletionCandidate(TerminalString completionCandidate)
void	addCompletionCandidates(java.util.List<java.lang.String> completionCandidates)
void	addCompletionCandidatesTerminalString(java.util.List<TerminalString> completionCandidates)
private void	addStringCandidate(java.lang.String completionCandidate)
private void	addStringCandidates(java.util.List<java.lang.String> completionCandidates)
void	doAppendSeparator(boolean appendSeparator) Set if this CompletionOperation would allow an separator to be appended.
boolean	doIgnoreNonEscapedSpace()
boolean	doIgnoreOffset()
AeshContext	getAeshContext()
java.lang.String	getBuffer()
java.util.List<TerminalString>	getCompletionCandidates()
int	getCursor()
java.lang.String	getFormattedCompletion(java.lang.String completion)
java.util.List<java.lang.String>	getFormattedCompletionCandidates()
java.util.List<TerminalString>	getFormattedCompletionCandidatesTerminalString()
java.lang.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? By default this is true.
boolean	isIgnoreStartsWith()
boolean	isTrimmed()
void	removeEscapedSpacesFromCompletionCandidates()
private void	setBuffer(java.lang.String buffer)
void	setCompletionCandidates(java.util.List<java.lang.String> completionCandidates)
void	setCompletionCandidatesTerminalString(java.util.List<TerminalString> completionCandidates)
private void	setCursor(int cursor)
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

buffer

private java.lang.String buffer

cursor

private int cursor

offset

private int offset

completionCandidates

private java.util.List<TerminalString> completionCandidates

trimmed

private boolean trimmed

ignoreStartsWith

private boolean ignoreStartsWith

nonTrimmedBuffer

private java.lang.String nonTrimmedBuffer

aeshContext

private final AeshContext aeshContext

ignoreNonEscapedSpace

private boolean ignoreNonEscapedSpace

separator

private char separator

appendSeparator

private boolean appendSeparator

ignoreOffset

private boolean ignoreOffset

Constructor Detail

CompleteOperation

public CompleteOperation(AeshContext aeshContext,
                         java.lang.String buffer,
                         int cursor)

Method Detail

getBuffer

public java.lang.String getBuffer()

setBuffer

private void setBuffer(java.lang.String buffer)

isTrimmed

public boolean isTrimmed()

getTrimmedSize

public int getTrimmedSize()

getNonTrimmedBuffer

public java.lang.String getNonTrimmedBuffer()

getCursor

public int getCursor()

setCursor

private void setCursor(int cursor)

getOffset

public int getOffset()

setOffset

public void setOffset(int offset)

setIgnoreOffset

public void setIgnoreOffset(boolean ignoreOffset)

doIgnoreOffset

public boolean doIgnoreOffset()

getAeshContext

public AeshContext getAeshContext()

getSeparator

public char getSeparator()

Get the separator character, by default its space

Returns:

separator

setSeparator

public void setSeparator(char separator)

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

Parameters:

separator - separator

hasAppendSeparator

public boolean hasAppendSeparator()

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

Returns:

appendSeparator

doAppendSeparator

public void doAppendSeparator(boolean appendSeparator)

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

Parameters:

appendSeparator - appendSeparator

getCompletionCandidates

public java.util.List<TerminalString> getCompletionCandidates()

setCompletionCandidates

public void setCompletionCandidates(java.util.List<java.lang.String> completionCandidates)

setCompletionCandidatesTerminalString

public void setCompletionCandidatesTerminalString(java.util.List<TerminalString> completionCandidates)

addCompletionCandidate

public void addCompletionCandidate(TerminalString completionCandidate)

addCompletionCandidate

public void addCompletionCandidate(java.lang.String completionCandidate)

addCompletionCandidates

public void addCompletionCandidates(java.util.List<java.lang.String> completionCandidates)

addCompletionCandidatesTerminalString

public void addCompletionCandidatesTerminalString(java.util.List<TerminalString> completionCandidates)

removeEscapedSpacesFromCompletionCandidates

public void removeEscapedSpacesFromCompletionCandidates()

addStringCandidate

private void addStringCandidate(java.lang.String completionCandidate)

addStringCandidates

private void addStringCandidates(java.util.List<java.lang.String> completionCandidates)

getFormattedCompletionCandidates

public java.util.List<java.lang.String> getFormattedCompletionCandidates()

getFormattedCompletionCandidatesTerminalString

public java.util.List<TerminalString> getFormattedCompletionCandidatesTerminalString()

getFormattedCompletion

public java.lang.String getFormattedCompletion(java.lang.String completion)

isIgnoreStartsWith

public boolean isIgnoreStartsWith()

setIgnoreStartsWith

public void setIgnoreStartsWith(boolean ignoreStartsWith)

doIgnoreNonEscapedSpace

public boolean doIgnoreNonEscapedSpace()

setIgnoreNonEscapedSpace

public void setIgnoreNonEscapedSpace(boolean ignoreNonEscapedSpace)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object