Package com.tailf.dp

Class CompletionRangeEnumReply

Object

com.tailf.dp.Completion

com.tailf.dp.CompletionRangeEnumReply

public class CompletionRangeEnumReply
extends Completion

Reply structure container for completion callbacks invoked by a tailf:cli-custom-range-enumerator directive. This reply class is used to assemble list instance key completions.

Method Summary

Modifier and Type	Method	Description
void	addEntryKeyValues(String[] keyValues)	Add keys for a list entry.
void	addEntryKeyValues(List<String> keyList)	Add keys for a list entry.

Methods inherited from class com.tailf.dp.Completion

newDefaultReply, newRangeEnumReply, newReply

Methods inherited from class java.lang.Object

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

Method Details

addEntryKeyValues

public void addEntryKeyValues(String[] keyValues)
                       throws DpCallbackException

Add keys for a list entry. The number of keys was specified in the instantiation using Completion.newRangeEnumReply(int) The keyValues parameter array length must be of length keySize or an exception is thrown.

Parameters:

keyValues - String[] of keys for this list entry, must be of keySize length

Throws:

DpCallbackException

addEntryKeyValues

public void addEntryKeyValues(List<String> keyList)
                       throws DpCallbackException

Add keys for a list entry. The number of keys was specified in the instantiation using Completion.newRangeEnumReply(int) The keyList parameter list size() be of length keySize or an exception is thrown.

Parameters:

keyList - List<String> of keys for an entry, must be of size keySize

Throws:

DpCallbackException