EnumCompleter (CRaSH reference documentation 1.2.10 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.crsh.cli.completers
Class EnumCompleter

java.lang.Object
  org.crsh.cli.completers.EnumCompleter

All Implemented Interfaces:: Completer

public class EnumCompleter

extends Object

implements Completer

Field Summary
`private static EnumCompleter`	`instance` .

Constructor Summary
`EnumCompleter()`

Method Summary
`Completion`	`complete(ParameterDescriptor parameter, String prefix)` Query the completer for a set of completions for the given prefix.
`static EnumCompleter`	`getInstance()` Returns the empty completer instance.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

instance

private static final EnumCompleter instance

Constructor Detail

EnumCompleter

public EnumCompleter()

Method Detail

getInstance

public static EnumCompleter getInstance()

Returns the empty completer instance.

Returns:: the instance

complete

public Completion complete(ParameterDescriptor parameter,
                           String prefix)
                    throws Exception

Description copied from interface: Completer

Query the completer for a set of completions for the given prefix. The returned Completion object provides the possible completion matching the prefix argument.

Specified by:: complete in interface Completer

Parameters:: parameter - the completed parameter; prefix - the prefix to complete
Returns:: the possible suffix map
Throws:: Exception - any exception that would prevent completion to perform correctly