org.ow2.shelbie.core.internal.handler.completer

Class ScopeCompleter

java.lang.Object

org.ow2.shelbie.core.internal.handler.completer.ScopeCompleter

All Implemented Interfaces:

jline.console.completer.Completer

public class ScopeCompleter
extends java.lang.Object
implements jline.console.completer.Completer

This completer is used to prefix the command name with the available scope. This is useful when the user do not type the command scope.

Constructor Summary

Constructors

Constructor and Description
ScopeCompleter(jline.console.completer.Completer delegate, org.apache.felix.service.command.CommandSession session)

Method Summary

Methods

Modifier and Type	Method and Description
int	complete(java.lang.String buffer, int cursor, java.util.List<java.lang.CharSequence> candidates) Populates candidates with a list of possible completions for the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopeCompleter

public ScopeCompleter(jline.console.completer.Completer delegate,
              org.apache.felix.service.command.CommandSession session)

Method Detail

complete

public int complete(java.lang.String buffer,
           int cursor,
           java.util.List<java.lang.CharSequence> candidates)

Populates candidates with a list of possible completions for the buffer. The candidates list will not be sorted before being displayed to the user: thus, the complete method should sort the List before returning.

Specified by:

complete in interface jline.console.completer.Completer

Parameters:

buffer - the buffer

candidates - the List of candidates to populate

Returns:

the index of the buffer for which the completion will be relative