Package org.jline.console

Class CmdDesc

java.lang.Object

org.jline.console.CmdDesc

public class CmdDesc
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<ArgDesc>	argsDesc
private boolean	command
private int	errorIndex
private java.util.regex.Pattern	errorPattern
private boolean	highlighted
private java.util.List<AttributedString>	mainDesc
private java.util.TreeMap<java.lang.String,java.util.List<AttributedString>>	optsDesc
private boolean	subcommand
private boolean	valid

Constructor Summary

Constructors

Constructor	Description
CmdDesc()
CmdDesc(boolean valid)
CmdDesc(java.util.List<ArgDesc> argsDesc)
CmdDesc(java.util.List<ArgDesc> argsDesc, java.util.Map<java.lang.String,java.util.List<AttributedString>> optsDesc)
CmdDesc(java.util.List<AttributedString> mainDesc, java.util.List<ArgDesc> argsDesc, java.util.Map<java.lang.String,java.util.List<AttributedString>> optsDesc)

Method Summary

Modifier and Type	Method	Description
java.util.List<ArgDesc>	getArgsDesc()
int	getErrorIndex()
java.util.regex.Pattern	getErrorPattern()
java.util.List<AttributedString>	getMainDesc()
java.util.TreeMap<java.lang.String,java.util.List<AttributedString>>	getOptsDesc()
boolean	isCommand()
boolean	isHighlighted()
boolean	isSubcommand()
boolean	isValid()
CmdDesc	mainDesc(java.util.List<AttributedString> mainDesc)
AttributedString	optionDescription(java.lang.String key)
boolean	optionWithValue(java.lang.String option)
void	setErrorIndex(int errorIndex)
void	setErrorPattern(java.util.regex.Pattern errorPattern)
void	setHighlighted(boolean highlighted)
void	setMainDesc(java.util.List<AttributedString> mainDesc)
void	setSubcommand(boolean subcommand)

Methods inherited from class java.lang.Object

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

Field Detail

mainDesc

private java.util.List<AttributedString> mainDesc

argsDesc

private java.util.List<ArgDesc> argsDesc

optsDesc

private java.util.TreeMap<java.lang.String,java.util.List<AttributedString>> optsDesc

errorPattern

private java.util.regex.Pattern errorPattern

errorIndex

private int errorIndex

valid

private boolean valid

command

private boolean command

subcommand

private boolean subcommand

highlighted

private boolean highlighted

Constructor Detail

CmdDesc

public CmdDesc()

CmdDesc

public CmdDesc(boolean valid)

CmdDesc

public CmdDesc(java.util.List<ArgDesc> argsDesc)

CmdDesc

public CmdDesc(java.util.List<ArgDesc> argsDesc,
               java.util.Map<java.lang.String,java.util.List<AttributedString>> optsDesc)

CmdDesc

public CmdDesc(java.util.List<AttributedString> mainDesc,
               java.util.List<ArgDesc> argsDesc,
               java.util.Map<java.lang.String,java.util.List<AttributedString>> optsDesc)

Method Detail

isValid

public boolean isValid()

isCommand

public boolean isCommand()

setSubcommand

public void setSubcommand(boolean subcommand)

isSubcommand

public boolean isSubcommand()

setHighlighted

public void setHighlighted(boolean highlighted)

isHighlighted

public boolean isHighlighted()

mainDesc

public CmdDesc mainDesc(java.util.List<AttributedString> mainDesc)

setMainDesc

public void setMainDesc(java.util.List<AttributedString> mainDesc)

getMainDesc

public java.util.List<AttributedString> getMainDesc()

getOptsDesc

public java.util.TreeMap<java.lang.String,java.util.List<AttributedString>> getOptsDesc()

setErrorPattern

public void setErrorPattern(java.util.regex.Pattern errorPattern)

getErrorPattern

public java.util.regex.Pattern getErrorPattern()

setErrorIndex

public void setErrorIndex(int errorIndex)

getErrorIndex

public int getErrorIndex()

getArgsDesc

public java.util.List<ArgDesc> getArgsDesc()

optionWithValue

public boolean optionWithValue(java.lang.String option)

optionDescription

public AttributedString optionDescription(java.lang.String key)