Module org.jline.console

Package org.jline.console

Class CmdDesc

java.lang.Object

org.jline.console.CmdDesc

public class CmdDesc
extends Object

Constructor Summary

Constructors

Constructor	Description
CmdDesc()
CmdDesc(boolean valid)
CmdDesc(List<ArgDesc> argsDesc)
CmdDesc(List<ArgDesc> argsDesc, Map<String,List<org.jline.utils.AttributedString>> optsDesc)
CmdDesc(List<org.jline.utils.AttributedString> mainDesc, List<ArgDesc> argsDesc, Map<String,List<org.jline.utils.AttributedString>> optsDesc)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdDesc

public CmdDesc()

CmdDesc

public CmdDesc(boolean valid)

CmdDesc

public CmdDesc(List<ArgDesc> argsDesc)

CmdDesc

public CmdDesc(List<ArgDesc> argsDesc,
               Map<String,List<org.jline.utils.AttributedString>> optsDesc)

CmdDesc

public CmdDesc(List<org.jline.utils.AttributedString> mainDesc,
               List<ArgDesc> argsDesc,
               Map<String,List<org.jline.utils.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(List<org.jline.utils.AttributedString> mainDesc)

setMainDesc

public void setMainDesc(List<org.jline.utils.AttributedString> mainDesc)

getMainDesc

public List<org.jline.utils.AttributedString> getMainDesc()

getOptsDesc

public TreeMap<String,List<org.jline.utils.AttributedString>> getOptsDesc()

setErrorPattern

public void setErrorPattern(Pattern errorPattern)

getErrorPattern

public Pattern getErrorPattern()

setErrorIndex

public void setErrorIndex(int errorIndex)

getErrorIndex

public int getErrorIndex()

getArgsDesc

public List<ArgDesc> getArgsDesc()

optionWithValue

public boolean optionWithValue(String option)

optionDescription

public org.jline.utils.AttributedString optionDescription(String key)