Package org.onosproject.cli

Class AbstractChoicesCompleter

java.lang.Object

org.onosproject.cli.AbstractCompleter

org.onosproject.cli.AbstractChoicesCompleter

All Implemented Interfaces:

org.apache.karaf.shell.api.console.Completer

Direct Known Subclasses:

AllApplicationNamesCompleter, AnnotationKeysCompleter, ApplicationCommandCompleter, ConfigKeyCompleter, GroupStatusCompleter, GroupTypeCompleter, IntentIdCompleter, InterfaceNameCompleter, LinkTypeCompleter, McastGroupCompleter, MetricNameCompleter, PeerConnectPointCompleter, PortNumberCompleter, PortStateCompleter, RegionIdCompleter, RegionTypeCompleter, StartStopCompleter, SubjectClassKeyCompleter, SubjectKeyCompleter, UpDownCompleter

public abstract class AbstractChoicesCompleter
extends AbstractCompleter

Abstraction of a completer with preset choices.

Field Summary

Fields

Modifier and Type	Field	Description
org.apache.karaf.shell.api.console.CommandLine	commandLine
org.apache.karaf.shell.api.console.Session	session

Constructor Summary

Constructors

Constructor	Description
AbstractChoicesCompleter()

Method Summary

Modifier and Type	Method	Description
protected abstract java.util.List<java.lang.String>	choices()
int	complete(org.apache.karaf.shell.api.console.Session session, org.apache.karaf.shell.api.console.CommandLine commandLine, java.util.List<java.lang.String> candidates)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.karaf.shell.api.console.Completer

completeCandidates

Field Detail

commandLine

public org.apache.karaf.shell.api.console.CommandLine commandLine

session

public org.apache.karaf.shell.api.console.Session session

Constructor Detail

AbstractChoicesCompleter

public AbstractChoicesCompleter()

Method Detail

choices

protected abstract java.util.List<java.lang.String> choices()

complete

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

Specified by:

complete in interface org.apache.karaf.shell.api.console.Completer

Overrides:

complete in class AbstractCompleter