|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object jline.ArgumentCompletor
A Completor
implementation that invokes a child completor
using the appropriate separator argument. This
can be used instead of the individual completors having to
know about argument parsing semantics.
Example 1: Any argument of the command line can use file completion.
consoleReader.addCompletor (new ArgumentCompletor (
new FileNameCompletor
()))
Example 2: The first argument of the command line can be completed with any of "foo", "bar", or "baz", and remaining arguments can be completed with a file name.
consoleReader.addCompletor (new ArgumentCompletor ( newSimpleCompletor
(new String [] { "foo", "bar", "baz"}))); consoleReader.addCompletor (new ArgumentCompletor ( newFileNameCompletor
()));
When the argument index is past the last embedded completors, the last
completors is always used. To disable this behavior, have the last
completor be a NullCompletor
. For example:
consoleReader.addCompletor (new ArgumentCompletor ( newSimpleCompletor
(new String [] { "foo", "bar", "baz"}), newSimpleCompletor
(new String [] { "xxx", "yyy", "xxx"}), newNullCompletor
));
TODO: handle argument quoting and escape characters
Nested Class Summary | |
static class |
ArgumentCompletor.AbstractArgumentDelimiter
Abstract implementation of a delimiter that uses the ArgumentCompletor.AbstractArgumentDelimiter.isDelimiter(java.lang.String, int) method to determine if a particular
character should be used as a delimiter. |
static interface |
ArgumentCompletor.ArgumentDelimiter
The ArgumentCompletor.ArgumentDelimiter allows custom
breaking up of a String into individual arguments in
order to dispatch the arguments to the nested Completor . |
static class |
ArgumentCompletor.ArgumentList
The result of a delimited buffer. |
static class |
ArgumentCompletor.WhitespaceArgumentDelimiter
ArgumentCompletor.ArgumentDelimiter
implementation that counts all
whitespace (as reported by Character.isWhitespace(char) )
as being a delimiter. |
Constructor Summary | |
ArgumentCompletor(Completor completor)
Constuctor: create a new completor with the default argument separator of " ". |
|
ArgumentCompletor(Completor[] completors)
Constuctor: create a new completor with the default argument separator of " ". |
|
ArgumentCompletor(Completor[] completors,
ArgumentCompletor.ArgumentDelimiter delim)
Constuctor: create a new completor with the specified argument delimiter. |
|
ArgumentCompletor(Completor completor,
ArgumentCompletor.ArgumentDelimiter delim)
Constuctor: create a new completor with the specified argument delimiter. |
|
ArgumentCompletor(List completors)
Constuctor: create a new completor with the default argument separator of " ". |
Method Summary | |
int |
complete(String buffer,
int cursor,
List candidates)
Populates candidates with a list of possible completions for the buffer. |
boolean |
getStrict()
Returns whether a completion at argument index N will succees if all the completions from arguments 0-(N-1) also succeed. |
void |
setStrict(boolean strict)
If true, a completion at argument index N will only succeed if all the completions from 0-(N-1) also succeed. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ArgumentCompletor(Completor completor)
completor
- the embedded completorpublic ArgumentCompletor(List completors)
completors
- the List of completors to usepublic ArgumentCompletor(Completor[] completors)
completors
- the embedded argument completorspublic ArgumentCompletor(Completor completor, ArgumentCompletor.ArgumentDelimiter delim)
completor
- the embedded completordelim
- the delimiter for parsing argumentspublic ArgumentCompletor(Completor[] completors, ArgumentCompletor.ArgumentDelimiter delim)
completors
- the embedded completorsdelim
- the delimiter for parsing argumentsMethod Detail |
public void setStrict(boolean strict)
public boolean getStrict()
public int complete(String buffer, int cursor, List candidates)
Completor
List
before returning.
complete
in interface Completor
buffer
- the buffercandidates
- the List
of candidates to populate
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |