Package jline
Class ArgumentCompletor.AbstractArgumentDelimiter
- java.lang.Object
-
- jline.ArgumentCompletor.AbstractArgumentDelimiter
-
- All Implemented Interfaces:
ArgumentCompletor.ArgumentDelimiter
- Direct Known Subclasses:
ArgumentCompletor.WhitespaceArgumentDelimiter
- Enclosing class:
- ArgumentCompletor
public abstract static class ArgumentCompletor.AbstractArgumentDelimiter extends java.lang.Object implements ArgumentCompletor.ArgumentDelimiter
Abstract implementation of a delimiter that uses theisDelimiter(java.lang.String, int)
method to determine if a particular character should be used as a delimiter.- Author:
- Marc Prud'hommeaux
-
-
Constructor Summary
Constructors Constructor Description AbstractArgumentDelimiter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description ArgumentCompletor.ArgumentList
delimit(java.lang.String buffer, int cursor)
Break the specified buffer into individual tokens that can be completed on their own.char[]
getEscapeChars()
char[]
getQuoteChars()
boolean
isDelimiter(java.lang.String buffer, int pos)
Returns true if the specified character is a whitespace parameter.abstract boolean
isDelimiterChar(java.lang.String buffer, int pos)
Returns true if the character at the specified position if a delimiter.boolean
isEscaped(java.lang.String buffer, int pos)
boolean
isQuoted(java.lang.String buffer, int pos)
void
setEscapeChars(char[] escapeChars)
void
setQuoteChars(char[] quoteChars)
-
-
-
Constructor Detail
-
AbstractArgumentDelimiter
public AbstractArgumentDelimiter()
-
-
Method Detail
-
setQuoteChars
public void setQuoteChars(char[] quoteChars)
-
getQuoteChars
public char[] getQuoteChars()
-
setEscapeChars
public void setEscapeChars(char[] escapeChars)
-
getEscapeChars
public char[] getEscapeChars()
-
delimit
public ArgumentCompletor.ArgumentList delimit(java.lang.String buffer, int cursor)
Description copied from interface:ArgumentCompletor.ArgumentDelimiter
Break the specified buffer into individual tokens that can be completed on their own.- Specified by:
delimit
in interfaceArgumentCompletor.ArgumentDelimiter
- Parameters:
buffer
- the buffer to splitcursor
- the current position of the cursor in the buffer- Returns:
- the tokens
-
isDelimiter
public boolean isDelimiter(java.lang.String buffer, int pos)
Returns true if the specified character is a whitespace parameter. Check to ensure that the character is not escaped by any ofgetQuoteChars()
, and is not escaped by ant of thegetEscapeChars()
, and returns true fromisDelimiterChar(java.lang.String, int)
.- Specified by:
isDelimiter
in interfaceArgumentCompletor.ArgumentDelimiter
- Parameters:
buffer
- the complete command bufferpos
- the index of the character in the buffer- Returns:
- true if the character should be a delimiter
-
isQuoted
public boolean isQuoted(java.lang.String buffer, int pos)
-
isEscaped
public boolean isEscaped(java.lang.String buffer, int pos)
-
isDelimiterChar
public abstract boolean isDelimiterChar(java.lang.String buffer, int pos)
Returns true if the character at the specified position if a delimiter. This method will only be called if the character is not enclosed in any of thegetQuoteChars()
, and is not escaped by ant of thegetEscapeChars()
. To perform escaping manually, overrideisDelimiter(java.lang.String, int)
instead.
-
-