org.jboss.aesh.cl.completer

Class CompleterData

java.lang.Object

org.jboss.aesh.cl.completer.CompleterData

All Implemented Interfaces:

CompleterInvocation

public class CompleterData
extends Object
implements CompleterInvocation

A payload object to store completion values for an Option Offset is only needed to change if the there is only one completion value and the value is not replacing the current given value, but appending. If its only appending then set the offset to the length of completeValue given in OptionCompleter.complete(String completeValue)

Author:

Ståle W. Pedersen

Constructor Summary

Constructors

Constructor and Description
CompleterData(AeshContext aeshContext, String completeValue, Command command)

Method Summary

Modifier and Type	Method and Description
void	addAllCompleterValues(Collection<String> completerValues)
void	addCompleterValue(String value)
void	addCompleterValueTerminalString(TerminalString value)
void	clearCompleterValues()
boolean	doIgnoreOffset()
AeshContext	getAeshContext()
Command	getCommand()
List<TerminalString>	getCompleterValues()
String	getGivenCompleteValue()
int	getOffset()
boolean	isAppendSpace()
boolean	isIgnoreStartsWith()
void	setAppendSpace(boolean appendSpace)
void	setCompleterValues(Collection<String> completerValues)
void	setCompleterValuesTerminalString(List<TerminalString> completerValues)
void	setIgnoreOffset(boolean ignoreOffset)
void	setIgnoreStartsWith(boolean ignoreStartsWith)
void	setOffset(int offset)

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleterData

public CompleterData(AeshContext aeshContext,
                     String completeValue,
                     Command command)

Method Detail

getGivenCompleteValue

public String getGivenCompleteValue()

Specified by:

getGivenCompleteValue in interface CompleterInvocation

getCommand

public Command getCommand()

Specified by:

getCommand in interface CompleterInvocation

getCompleterValues

public List<TerminalString> getCompleterValues()

Specified by:

getCompleterValues in interface CompleterInvocation

setCompleterValues

public void setCompleterValues(Collection<String> completerValues)

Specified by:

setCompleterValues in interface CompleterInvocation

setCompleterValuesTerminalString

public void setCompleterValuesTerminalString(List<TerminalString> completerValues)

Specified by:

setCompleterValuesTerminalString in interface CompleterInvocation

clearCompleterValues

public void clearCompleterValues()

Specified by:

clearCompleterValues in interface CompleterInvocation

addAllCompleterValues

public void addAllCompleterValues(Collection<String> completerValues)

Specified by:

addAllCompleterValues in interface CompleterInvocation

addCompleterValue

public void addCompleterValue(String value)

Specified by:

addCompleterValue in interface CompleterInvocation

addCompleterValueTerminalString

public void addCompleterValueTerminalString(TerminalString value)

Specified by:

addCompleterValueTerminalString in interface CompleterInvocation

isAppendSpace

public boolean isAppendSpace()

Specified by:

isAppendSpace in interface CompleterInvocation

setAppendSpace

public void setAppendSpace(boolean appendSpace)

Specified by:

setAppendSpace in interface CompleterInvocation

doIgnoreOffset

public boolean doIgnoreOffset()

Specified by:

doIgnoreOffset in interface CompleterInvocation

setIgnoreOffset

public void setIgnoreOffset(boolean ignoreOffset)

Specified by:

setIgnoreOffset in interface CompleterInvocation

setOffset

public void setOffset(int offset)

Specified by:

setOffset in interface CompleterInvocation

getOffset

public int getOffset()

Specified by:

getOffset in interface CompleterInvocation

setIgnoreStartsWith

public void setIgnoreStartsWith(boolean ignoreStartsWith)

Specified by:

setIgnoreStartsWith in interface CompleterInvocation

isIgnoreStartsWith

public boolean isIgnoreStartsWith()

Specified by:

isIgnoreStartsWith in interface CompleterInvocation

getAeshContext

public AeshContext getAeshContext()

Specified by:

getAeshContext in interface CompleterInvocation