org.apache.karaf.shell.compat

Class OldArgumentCompleter

java.lang.Object

org.apache.karaf.shell.compat.OldArgumentCompleter

public class OldArgumentCompleter
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OldArgumentCompleter.ArgumentList The result of a delimited buffer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARGUMENTS_LIST

Constructor Summary

Constructors

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

Method Summary

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() Return 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) Return 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 preceding 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

Constructor Detail

OldArgumentCompleter

public OldArgumentCompleter(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.

Parameters:

strict - The new value of the strict flag.

getStrict

public boolean getStrict()

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

Returns:

The current value of the strict flag.

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)

Return 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, false else.

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 preceding character is not an escape character.

Parameters:

buffer - The complete command buffer.

pos - The index of the character in the buffer.

Returns:

True if the character is delimiter, false else.