Package org.apache.karaf.shell.console.completer

Class ArgumentCompleter

java.lang.Object

org.apache.karaf.shell.console.completer.ArgumentCompleter

All Implemented Interfaces:

Completer

@Deprecated
public class ArgumentCompleter
extends Object
implements Completer

Deprecated.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArgumentCompleter.ArgumentList	Deprecated. The result of a delimited buffer.
static class	ArgumentCompleter.ProxyServiceCompleter	Deprecated.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ArgumentCompleter(org.apache.felix.service.command.CommandSession session, CommandWithAction function, String command)	Deprecated.

Method Summary

Modifier and Type	Method	Description
int	complete(String buffer, int cursor, List<String> candidates)	Deprecated.
ArgumentCompleter.ArgumentList	delimit(String buffer, int cursor)	Deprecated.
boolean	getStrict()	Deprecated. Return whether a completion at argument index N will success if all the completions from arguments 0-(N-1) also succeed.
boolean	isDelimiter(String buffer, int pos)	Deprecated. Return true if the specified character is a whitespace parameter.
boolean	isDelimiterChar(String buffer, int pos)	Deprecated. The character is a delimiter if it is whitespace, and the preceding character is not an escape character.
boolean	isEscaped(String buffer, int pos)	Deprecated.
void	setStrict(boolean strict)	Deprecated. 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)	Deprecated.

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

Deprecated.

See Also:

Constant Field Values

COMMANDS

public static final String COMMANDS

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ArgumentCompleter

public ArgumentCompleter(org.apache.felix.service.command.CommandSession session,
                         CommandWithAction function,
                         String command)

Deprecated.

Method Detail

setStrict

public void setStrict(boolean strict)

Deprecated.

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

Deprecated.

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

Returns:

The value of the strict flag.

complete

public int complete(String buffer,
                    int cursor,
                    List<String> candidates)

Deprecated.

Specified by:

complete in interface Completer

verifyCompleter

protected boolean verifyCompleter(Completer completer,
                                  String argument)

Deprecated.

delimit

public ArgumentCompleter.ArgumentList delimit(String buffer,
                                              int cursor)

Deprecated.

isDelimiter

public boolean isDelimiter(String buffer,
                           int pos)

Deprecated.

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)

Deprecated.

isDelimiterChar

public boolean isDelimiterChar(String buffer,
                               int pos)

Deprecated.

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