Modifier and Type	Class and Description
public class	DefaultParser.ArgumentList The result of a delimited buffer.
public static class	DefaultParser.BlockCommentDelims
public static enum	DefaultParser.Bracket
private class	DefaultParser.BracketChecker

Modifier and Type	Field and Description
private DefaultParser.BlockCommentDelims	blockCommentDelims
private char[]	closingBrackets
private int	commandGroup
private boolean	eofOnEscapedNewLine
private boolean	eofOnUnclosedQuote
private char[]	escapeChars
private String[]	lineCommentDelims
private char[]	openingBrackets
private char[]	quoteChars
private String	regexCommand
private String	regexVariable

Access	Constructor and Description
public	DefaultParser()

Method Summary

Modifier and Type	Method and Description
public DefaultParser	blockCommentDelims(final DefaultParser.BlockCommentDelims blockCommentDelims)
public DefaultParser	commandGroup(int commandGroup)
public DefaultParser	eofOnEscapedNewLine(boolean eofOnEscapedNewLine)
public DefaultParser	eofOnUnclosedBracket(DefaultParser.Bracket... brackets)
public DefaultParser	eofOnUnclosedQuote(boolean eofOnUnclosedQuote)
public DefaultParser	escapeChars(final char[] chars)
public DefaultParser.BlockCommentDelims	getBlockCommentDelims()
public String	getCommand(final String line) Overrides default jdk.internal.org.jline.reader.Parser.getCommand.
public char[]	getEscapeChars()
public String[]	getLineCommentDelims()
public char[]	getQuoteChars()
public String	getVariable(final String line) Overrides default jdk.internal.org.jline.reader.Parser.getVariable.
private int	handleDelimiterAndGetRawWordLength(StringBuilder current, List<String> words, int rawWordStart, int rawWordCursor, int rawWordLength, int pos)
private boolean	isCommentDelim(final CharSequence buffer, final int pos, final String pattern)
public boolean	Returns: True if the character should be a delimiter isDelimiter(final CharSequence The complete command buffer buffer, final int The index of the character in the buffer pos) Returns true if the specified character is a whitespace parameter.
public boolean	Returns: true if the character at the specified position in the given buffer is a delimiter. isDelimiterChar(CharSequence the buffer to check in buffer, int the position of the character to check pos) Returns true if the character at the specified position if a delimiter.
public boolean	isEofOnEscapedNewLine()
public boolean	isEofOnUnclosedQuote()
public boolean	isEscapeChar(char ch) Overrides default jdk.internal.org.jline.reader.Parser.isEscapeChar.
public boolean	Returns: true if the character at the specified position in the given buffer is an escape character and the character immediately preceding it is not an escape character. isEscapeChar(final CharSequence the buffer to check in buffer, final int the position of the character to check pos) Check if this character is a valid escape char (i.e. one that has not been escaped)
public boolean	Returns: true if the character at the specified position in the given buffer is an escape character and the character immediately preceding it is an escape character. isEscaped(final CharSequence the buffer to check in buffer, final int the position of the character to check pos) Check if a character is escaped (i.e. if the previous character is an escape)
public boolean	isLineCommentStarted(final CharSequence buffer, final int pos)
public boolean	isQuoteChar(final CharSequence buffer, final int pos)
public boolean	isQuoted(final CharSequence buffer, final int pos)
private boolean	isRawEscapeChar(char key)
private boolean	isRawQuoteChar(char key)
public DefaultParser	lineCommentDelims(final String[] lineCommentDelims)
public ParsedLine	parse(final String line, final int cursor, Parser.ParseContext context) Implements jdk.internal.org.jline.reader.Parser.parse.
public DefaultParser	quoteChars(final char[] chars)
public DefaultParser	regexCommand(String regexCommand)
public DefaultParser	regexVariable(String regexVariable)
public void	setBlockCommentDelims(DefaultParser.BlockCommentDelims blockCommentDelims)
public void	setCommandGroup(int commandGroup)
public void	setEofOnEscapedNewLine(boolean eofOnEscapedNewLine)
public void	setEofOnUnclosedBracket(DefaultParser.Bracket... brackets)
public void	setEofOnUnclosedQuote(boolean eofOnUnclosedQuote)
public void	setEscapeChars(final char[] chars)
public void	setLineCommentDelims(String[] lineCommentDelims)
public void	setQuoteChars(final char[] chars)
public void	setRegexCommand(String regexCommand)
public void	setRegexVariable(String regexVariable)
public boolean	validCommandName(String name) Overrides default jdk.internal.org.jline.reader.Parser.validCommandName.
public boolean	validVariableName(String name) Overrides default jdk.internal.org.jline.reader.Parser.validVariableName.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

blockCommentDelims	back to summary
private DefaultParser.BlockCommentDelims blockCommentDelims

closingBrackets	back to summary
private char[] closingBrackets

commandGroup	back to summary
private int commandGroup

eofOnEscapedNewLine	back to summary
private boolean eofOnEscapedNewLine

eofOnUnclosedQuote	back to summary
private boolean eofOnUnclosedQuote

escapeChars	back to summary
private char[] escapeChars

lineCommentDelims	back to summary
private String[] lineCommentDelims

openingBrackets	back to summary
private char[] openingBrackets

quoteChars	back to summary
private char[] quoteChars

regexCommand	back to summary
private String regexCommand

regexVariable	back to summary
private String regexVariable

Constructor Detail

DefaultParser	back to summary
public DefaultParser()

Method Detail

blockCommentDelims	back to summary
public DefaultParser blockCommentDelims(final DefaultParser.BlockCommentDelims blockCommentDelims)

commandGroup	back to summary
public DefaultParser commandGroup(int commandGroup)

eofOnEscapedNewLine	back to summary
public DefaultParser eofOnEscapedNewLine(boolean eofOnEscapedNewLine)

eofOnUnclosedBracket	back to summary
public DefaultParser eofOnUnclosedBracket(DefaultParser.Bracket... brackets)

eofOnUnclosedQuote	back to summary
public DefaultParser eofOnUnclosedQuote(boolean eofOnUnclosedQuote)

escapeChars	back to summary
public DefaultParser escapeChars(final char[] chars)

getBlockCommentDelims	back to summary
public DefaultParser.BlockCommentDelims getBlockCommentDelims()

getCommand	back to summary
public String getCommand(final String line) Overrides default jdk.internal.org.jline.reader.Parser.getCommand. Annotations @Override

getCommand

back to summary

public String getCommand(final String line)

Overrides default jdk.internal.org.jline.reader.Parser.getCommand.

Annotations

@Override

getEscapeChars	back to summary
public char[] getEscapeChars()

getLineCommentDelims	back to summary
public String[] getLineCommentDelims()

getQuoteChars	back to summary
public char[] getQuoteChars()

getVariable	back to summary
public String getVariable(final String line) Overrides default jdk.internal.org.jline.reader.Parser.getVariable. Annotations @Override

getVariable

back to summary

public String getVariable(final String line)

Overrides default jdk.internal.org.jline.reader.Parser.getVariable.

Annotations

@Override

handleDelimiterAndGetRawWordLength	back to summary
private int handleDelimiterAndGetRawWordLength(StringBuilder current, List<String> words, int rawWordStart, int rawWordCursor, int rawWordLength, int pos)

isCommentDelim	back to summary
private boolean isCommentDelim(final CharSequence buffer, final int pos, final String pattern)

isDelimiter back to summary

isDelimiter	back to summary
public boolean isDelimiter(final CharSequence buffer, final int pos) Returns true if the specified character is a whitespace parameter. Check to ensure that the character is not escaped by any of `getQuoteChars`, and is not escaped by any of the `getEscapeChars`, and returns true from `isDelimiterChar`. Parameters buffer:CharSequence The complete command buffer pos:int The index of the character in the buffer Returns:boolean True if the character should be a delimiter

public boolean isDelimiter(final CharSequence buffer, final int pos)

Returns true if the specified character is a whitespace parameter. Check to ensure that the character is not escaped by any of getQuoteChars, and is not escaped by any of the getEscapeChars, and returns true from isDelimiterChar.

Parameters

buffer:CharSequence: The complete command buffer
pos:int: The index of the character in the buffer

Returns:boolean

True if the character should be a delimiter

isDelimiterChar back to summary

isDelimiterChar	back to summary
public boolean isDelimiterChar(CharSequence 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 the `getQuoteChars`, and is not escaped by any of the `getEscapeChars`. To perform escaping manually, override `isDelimiter` instead. Parameters buffer:CharSequence the buffer to check in pos:int the position of the character to check Returns:boolean true if the character at the specified position in the given buffer is a delimiter.

public boolean isDelimiterChar(CharSequence 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 the getQuoteChars, and is not escaped by any of the getEscapeChars. To perform escaping manually, override isDelimiter instead.

Parameters

buffer:CharSequence: the buffer to check in
pos:int: the position of the character to check

Returns:boolean

true if the character at the specified position in the given buffer is a delimiter.

isEofOnEscapedNewLine	back to summary
public boolean isEofOnEscapedNewLine()

isEofOnUnclosedQuote	back to summary
public boolean isEofOnUnclosedQuote()

isEscapeChar	back to summary
public boolean isEscapeChar(char ch) Overrides default jdk.internal.org.jline.reader.Parser.isEscapeChar. Annotations @Override

isEscapeChar

back to summary

public boolean isEscapeChar(char ch)

Overrides default jdk.internal.org.jline.reader.Parser.isEscapeChar.

Annotations

@Override

isEscapeChar	back to summary
public boolean isEscapeChar(final CharSequence buffer, final int pos) Check if this character is a valid escape char (i.e. one that has not been escaped) Parameters buffer:CharSequence the buffer to check in pos:int the position of the character to check Returns:boolean true if the character at the specified position in the given buffer is an escape character and the character immediately preceding it is not an escape character.

isEscapeChar

back to summary

public boolean isEscapeChar(final CharSequence buffer, final int pos)

Check if this character is a valid escape char (i.e. one that has not been escaped)

Parameters

buffer:CharSequence: the buffer to check in
pos:int: the position of the character to check

Returns:boolean

true if the character at the specified position in the given buffer is an escape character and the character immediately preceding it is not an escape character.

isEscaped	back to summary
public boolean isEscaped(final CharSequence buffer, final int pos) Check if a character is escaped (i.e. if the previous character is an escape) Parameters buffer:CharSequence the buffer to check in pos:int the position of the character to check Returns:boolean true if the character at the specified position in the given buffer is an escape character and the character immediately preceding it is an escape character.

isEscaped

back to summary

public boolean isEscaped(final CharSequence buffer, final int pos)

Check if a character is escaped (i.e. if the previous character is an escape)

Parameters

buffer:CharSequence: the buffer to check in
pos:int: the position of the character to check

Returns:boolean

true if the character at the specified position in the given buffer is an escape character and the character immediately preceding it is an escape character.

isLineCommentStarted	back to summary
public boolean isLineCommentStarted(final CharSequence buffer, final int pos)

isQuoteChar	back to summary
public boolean isQuoteChar(final CharSequence buffer, final int pos)

isQuoted	back to summary
public boolean isQuoted(final CharSequence buffer, final int pos)

isRawEscapeChar	back to summary
private boolean isRawEscapeChar(char key)

isRawQuoteChar	back to summary
private boolean isRawQuoteChar(char key)

lineCommentDelims	back to summary
public DefaultParser lineCommentDelims(final String[] lineCommentDelims)

parse	back to summary
public ParsedLine parse(final String line, final int cursor, Parser.ParseContext context) Implements jdk.internal.org.jline.reader.Parser.parse.

quoteChars	back to summary
public DefaultParser quoteChars(final char[] chars)

regexCommand	back to summary
public DefaultParser regexCommand(String regexCommand)

regexVariable	back to summary
public DefaultParser regexVariable(String regexVariable)

setBlockCommentDelims	back to summary
public void setBlockCommentDelims(DefaultParser.BlockCommentDelims blockCommentDelims)

setCommandGroup	back to summary
public void setCommandGroup(int commandGroup)

setEofOnEscapedNewLine	back to summary
public void setEofOnEscapedNewLine(boolean eofOnEscapedNewLine)

setEofOnUnclosedBracket	back to summary
public void setEofOnUnclosedBracket(DefaultParser.Bracket... brackets)

setEofOnUnclosedQuote	back to summary
public void setEofOnUnclosedQuote(boolean eofOnUnclosedQuote)

setEscapeChars	back to summary
public void setEscapeChars(final char[] chars)

setLineCommentDelims	back to summary
public void setLineCommentDelims(String[] lineCommentDelims)

setQuoteChars	back to summary
public void setQuoteChars(final char[] chars)

setRegexCommand	back to summary
public void setRegexCommand(String regexCommand)

setRegexVariable	back to summary
public void setRegexVariable(String regexVariable)

validCommandName

back to summary

public boolean validCommandName(String name)

Overrides default jdk.internal.org.jline.reader.Parser.validCommandName.

Annotations

@Override

validVariableName

back to summary

public boolean validVariableName(String name)

Overrides default jdk.internal.org.jline.reader.Parser.validVariableName.

Annotations

@Override

jdk.internal.org.jline.reader.impl back to summary

public Class DefaultParser.ArgumentList

Class Inheritance

extends Object
implements ParsedLine, CompletingParsedLine

java.lang.Object
jdk.internal.org.jline.reader.impl.DefaultParser.ArgumentList

All Implemented Interfaces

jdk.internal.org.jline.reader.CompletingParsedLine, jdk.internal.org.jline.reader.ParsedLine

The result of a delimited buffer.

Author: Marc Prud'hommeaux

Field Summary

Modifier and Type	Field and Description
private final int	cursor
private final String	line
private final String	openingQuote
private final int	rawWordCursor
private final int	rawWordLength
private final int	wordCursor
private final int	wordIndex
private final List<String>	words

Constructor Summary

Access

Constructor and Description

public

ArgumentList(final String line, final List<String> words, final int wordIndex, final int wordCursor, final int cursor)

Deprecated

public

ArgumentList(final String

the command line being edited

line, final List<String>

the list of words

words, final int

the index of the current word in the list of words

wordIndex, final int

the cursor position within the current word

wordCursor, final int

the cursor position within the line

cursor, final String

the opening quote (usually '\"' or '\'') or null

openingQuote, final int

the cursor position inside the raw word (i.e. including quotes and escape characters)

rawWordCursor, final int

the raw word length, including quotes and escape characters

rawWordLength)

Method Summary

Modifier and Type	Method and Description
public int	cursor() Implements jdk.internal.org.jline.reader.ParsedLine.cursor. The cursor position within the line.
public CharSequence	escape(CharSequence candidate, boolean complete) Implements jdk.internal.org.jline.reader.CompletingParsedLine.escape.
public String	line() Implements jdk.internal.org.jline.reader.ParsedLine.line. The unparsed line.
public int	rawWordCursor() Implements jdk.internal.org.jline.reader.CompletingParsedLine.rawWordCursor.
public int	rawWordLength() Implements jdk.internal.org.jline.reader.CompletingParsedLine.rawWordLength.
public String	word() Implements jdk.internal.org.jline.reader.ParsedLine.word. The current word being completed.
public int	wordCursor() Implements jdk.internal.org.jline.reader.ParsedLine.wordCursor. The cursor position within the current word.
public int	wordIndex() Implements jdk.internal.org.jline.reader.ParsedLine.wordIndex. The index of the current word in the list of words.
public List<String>	words() Implements jdk.internal.org.jline.reader.ParsedLine.words. The list of words.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cursor	back to summary
private final int cursor

line	back to summary
private final String line

openingQuote	back to summary
private final String openingQuote

rawWordCursor	back to summary
private final int rawWordCursor

rawWordLength	back to summary
private final int rawWordLength

wordCursor	back to summary
private final int wordCursor

wordIndex	back to summary
private final int wordIndex

words	back to summary
private final List<String> words

Constructor Detail

ArgumentList	back to summary
public ArgumentList(final String line, final List<String> words, final int wordIndex, final int wordCursor, final int cursor) Deprecated Annotations @Deprecated

ArgumentList

back to summary

public ArgumentList(final String line, final List<String> words, final int wordIndex, final int wordCursor, final int cursor, final String openingQuote, final int rawWordCursor, final int rawWordLength)

Parameters

line:String: the command line being edited
words:List<String>: the list of words
wordIndex:int: the index of the current word in the list of words
wordCursor:int: the cursor position within the current word
cursor:int: the cursor position within the line
openingQuote:String: the opening quote (usually '\"' or '\'') or null
rawWordCursor:int: the cursor position inside the raw word (i.e. including quotes and escape characters)
rawWordLength:int: the raw word length, including quotes and escape characters

Method Detail

cursor

back to summary

public int cursor()

Implements jdk.internal.org.jline.reader.ParsedLine.cursor.

Doc from jdk.internal.org.jline.reader.ParsedLine.cursor.

The cursor position within the line.

escape	back to summary
public CharSequence escape(CharSequence candidate, boolean complete) Implements jdk.internal.org.jline.reader.CompletingParsedLine.escape.

line

back to summary

public String line()

Implements jdk.internal.org.jline.reader.ParsedLine.line.

Doc from jdk.internal.org.jline.reader.ParsedLine.line.

The unparsed line.

rawWordCursor

back to summary

public int rawWordCursor()

Implements jdk.internal.org.jline.reader.CompletingParsedLine.rawWordCursor.

Annotations

@Override

rawWordLength

back to summary

public int rawWordLength()

Implements jdk.internal.org.jline.reader.CompletingParsedLine.rawWordLength.

Annotations

@Override

word

back to summary

public String word()

Implements jdk.internal.org.jline.reader.ParsedLine.word.

Doc from jdk.internal.org.jline.reader.ParsedLine.word.

The current word being completed. If the cursor is after the last word, an empty string is returned.

wordCursor

back to summary

public int wordCursor()

Implements jdk.internal.org.jline.reader.ParsedLine.wordCursor.

Doc from jdk.internal.org.jline.reader.ParsedLine.wordCursor.

The cursor position within the current word.

wordIndex

back to summary

public int wordIndex()

Implements jdk.internal.org.jline.reader.ParsedLine.wordIndex.

Doc from jdk.internal.org.jline.reader.ParsedLine.wordIndex.

The index of the current word in the list of words.

words

back to summary

public List<String> words()

Implements jdk.internal.org.jline.reader.ParsedLine.words.

Doc from jdk.internal.org.jline.reader.ParsedLine.words.

The list of words.

jdk.internal.org.jline.reader.impl back to summary

public Class DefaultParser.BlockCommentDelims

Class Inheritance

extends Object

java.lang.Object
jdk.internal.org.jline.reader.impl.DefaultParser.BlockCommentDelims

Field Summary

Modifier and Type	Field and Description
private final String	end
private final String	start

Constructor Summary

Access	Constructor and Description
public	BlockCommentDelims(String start, String end)

Method Summary

Modifier and Type	Method and Description
public String	getEnd()
public String	getStart()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

end	back to summary
private final String end

start	back to summary
private final String start

Constructor Detail

BlockCommentDelims	back to summary
public BlockCommentDelims(String start, String end)

Method Detail

getEnd	back to summary
public String getEnd()

getStart	back to summary
public String getStart()

jdk.internal.org.jline.reader.impl back to summary

public final Enum DefaultParser.Bracket

Class Inheritance

extends Enum<DefaultParser.Bracket>

java.lang.Object
java.lang.Enum
jdk.internal.org.jline.reader.impl.DefaultParser.Bracket

Field Summary

Modifier and Type	Field and Description
public static final DefaultParser.Bracket	ANGLE
public static final DefaultParser.Bracket	CURLY
public static final DefaultParser.Bracket	ROUND
public static final DefaultParser.Bracket	SQUARE

Constructor Summary

Access	Constructor and Description
private	Bracket()

Method Summary

Modifier and Type	Method and Description
public static DefaultParser.Bracket	valueOf(String name)
public static DefaultParser.Bracket[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ANGLE	back to summary
public static final DefaultParser.Bracket ANGLE

CURLY	back to summary
public static final DefaultParser.Bracket CURLY

ROUND	back to summary
public static final DefaultParser.Bracket ROUND

SQUARE	back to summary
public static final DefaultParser.Bracket SQUARE

Constructor Detail

Bracket	back to summary
private Bracket()

Method Detail

valueOf	back to summary
public static DefaultParser.Bracket valueOf(String name)

values	back to summary
public static DefaultParser.Bracket[] values()

jdk.internal.org.jline.reader.impl back to summary

private Class DefaultParser.BracketChecker

Class Inheritance

extends Object

java.lang.Object
jdk.internal.org.jline.reader.impl.DefaultParser.BracketChecker

Field Summary

Modifier and Type	Field and Description
private int	cursor
private int	missingOpeningBracket
private List<Integer>	nested
private String	nextClosingBracket
private int	openBrackets

Constructor Summary

Access	Constructor and Description
public	BracketChecker(int cursor)

Method Summary

Modifier and Type	Method and Description
private int	bracketId(final char[] brackets, final CharSequence buffer, final int pos)
public void	check(final CharSequence buffer, final int pos)
public String	getMissingClosingBrackets()
public String	getMissingOpeningBracket()
public String	getNextClosingBracket()
public int	getOpenBrackets()
public boolean	isClosingBracketMissing()
public boolean	isOpeningBracketMissing()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cursor	back to summary
private int cursor

missingOpeningBracket	back to summary
private int missingOpeningBracket

nested	back to summary
private List<Integer> nested

nextClosingBracket	back to summary
private String nextClosingBracket

openBrackets	back to summary
private int openBrackets

Constructor Detail

BracketChecker	back to summary
public BracketChecker(int cursor)

Method Detail

bracketId	back to summary
private int bracketId(final char[] brackets, final CharSequence buffer, final int pos)

check	back to summary
public void check(final CharSequence buffer, final int pos)

getMissingClosingBrackets	back to summary
public String getMissingClosingBrackets()

getMissingOpeningBracket	back to summary
public String getMissingOpeningBracket()

getNextClosingBracket	back to summary
public String getNextClosingBracket()

getOpenBrackets	back to summary
public int getOpenBrackets()

isClosingBracketMissing	back to summary
public boolean isClosingBracketMissing()

isOpeningBracketMissing	back to summary
public boolean isOpeningBracketMissing()

public Class DefaultParser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class DefaultParser.ArgumentList

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class DefaultParser.BlockCommentDelims

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DefaultParser.Bracket

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultParser.BracketChecker

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail