org.apache.karaf.shell.compat

Class ArgumentCompleter

java.lang.Object

org.apache.karaf.shell.compat.ArgumentCompleter

public class ArgumentCompleter
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArgumentCompleter.ProxyServiceCompleter

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARGUMENTS_LIST
static String	COMMANDS

Constructor Summary

Constructors

Constructor and Description
ArgumentCompleter(CommandWithAction function, String scope, String name, boolean scoped)

Method Summary

Methods

Modifier and Type	Method and Description
int	complete(org.apache.karaf.shell.api.console.Session session, org.apache.karaf.shell.api.console.CommandLine list, List<String> candidates)
boolean	getStrict() Returns whether a completion at argument index N will succees if all the completions from arguments 0-(N-1) also succeed.
boolean	isDelimiter(String buffer, int pos) Returns true if the specified character is a whitespace parameter.
boolean	isDelimiterChar(String buffer, int pos) The character is a delimiter if it is whitespace, and the preceeding character is not an escape character.
boolean	isEscaped(String buffer, int pos)
void	setStrict(boolean strict) If true, a completion at argument index N will only succeed if all the completions from 0-(N-1) also succeed.
protected boolean	verifyCompleter(Completer completer, String argument)

Methods inherited from class java.lang.Object

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

Field Detail

ARGUMENTS_LIST

public static final String ARGUMENTS_LIST

See Also:

Constant Field Values

COMMANDS

public static final String COMMANDS

See Also:

Constant Field Values

Constructor Detail

ArgumentCompleter

public ArgumentCompleter(CommandWithAction function,
                 String scope,
                 String name,
                 boolean scoped)

Method Detail

setStrict

public void setStrict(boolean strict)

If true, a completion at argument index N will only succeed if all the completions from 0-(N-1) also succeed.

getStrict

public boolean getStrict()

Returns whether a completion at argument index N will succees if all the completions from arguments 0-(N-1) also succeed.

complete

public int complete(org.apache.karaf.shell.api.console.Session session,
           org.apache.karaf.shell.api.console.CommandLine list,
           List<String> candidates)

verifyCompleter

protected boolean verifyCompleter(Completer completer,
                      String argument)

isDelimiter

public boolean isDelimiter(String buffer,
                  int pos)

Returns true if the specified character is a whitespace parameter. Check to ensure that the character is not escaped and returns true from isDelimiterChar(java.lang.String, int).

Parameters:

buffer - the complete command buffer

pos - the index of the character in the buffer

Returns:

true if the character should be a delimiter

isEscaped

public boolean isEscaped(String buffer,
                int pos)

isDelimiterChar

public boolean isDelimiterChar(String buffer,
                      int pos)

The character is a delimiter if it is whitespace, and the preceeding character is not an escape character.