Package org.apache.karaf.features.command.completers

Class FeatureCompleterSupport

java.lang.Object

org.apache.karaf.features.command.completers.FeatureCompleterSupport

All Implemented Interfaces:

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

Direct Known Subclasses:

AllFeatureCompleter, AvailableFeatureCompleter, RequiredFeatureCompleter, ResolvedFeatureCompleter, StartedFeatureCompleter

public abstract class FeatureCompleterSupport
extends Object
implements org.apache.karaf.shell.api.console.Completer

Base completer for feature commands.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.karaf.features.FeaturesService	featuresService	Feature service.

Constructor Summary

Constructors

Constructor	Description
FeatureCompleterSupport()

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	acceptsFeature(org.apache.karaf.features.Feature feature)	Method for filtering features.
protected void	add(List<org.apache.karaf.shell.api.console.Candidate> candidates, org.apache.karaf.features.Feature feature)
int	complete(org.apache.karaf.shell.api.console.Session session, org.apache.karaf.shell.api.console.CommandLine commandLine, List<String> candidates)
void	completeCandidates(org.apache.karaf.shell.api.console.Session session, org.apache.karaf.shell.api.console.CommandLine commandLine, List<org.apache.karaf.shell.api.console.Candidate> candidates)
void	setFeaturesService(org.apache.karaf.features.FeaturesService featuresService)

Methods inherited from class java.lang.Object

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

Field Detail

featuresService

protected org.apache.karaf.features.FeaturesService featuresService

Feature service.

Constructor Detail

FeatureCompleterSupport

public FeatureCompleterSupport()

Method Detail

setFeaturesService

public void setFeaturesService(org.apache.karaf.features.FeaturesService featuresService)

complete

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

Specified by:

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

completeCandidates

public void completeCandidates(org.apache.karaf.shell.api.console.Session session,
                               org.apache.karaf.shell.api.console.CommandLine commandLine,
                               List<org.apache.karaf.shell.api.console.Candidate> candidates)

Specified by:

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

add

protected void add(List<org.apache.karaf.shell.api.console.Candidate> candidates,
                   org.apache.karaf.features.Feature feature)

acceptsFeature

protected abstract boolean acceptsFeature(org.apache.karaf.features.Feature feature)

Method for filtering features.

Parameters:

feature - The feature.

Returns:

True if feature should be available in completer.