CommandParser

Instance Constructors

new CommandParser(appVendor: String, appName: String, appVersion: String)

appVendor
the name of the app vendor
appName
the name of the app
appVersion
the current app version

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getComponentAutoCompleteData: Map[String, Seq[ActionDescriptor]]

Retrieves the auto-complete data associated with the parser.
Retrieves the auto-complete data associated with the parser.
returns
the requested data
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parse(input: Seq[String], config: CommandConfig): Option[CommandConfig]

Parses the supplied sequence of input parameters.
Parses the supplied sequence of input parameters.
input
the input to parse
config
the pre-build config to use
returns
the parsed command configuration
def parse(rawInput: String, config: CommandConfig = CommandConfig()): Option[CommandConfig]

Parses the supplied raw input string.
Parses the supplied raw input string.
rawInput
the string to parse
config
the pre-built config to use (if any)
returns
the parsed command configuration
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def usageMessage(withCommandFilter: Option[String] = None): String

Retrieves the help/usage message.
Retrieves the help/usage message.
withCommandFilter
the command to filter the usage/help by (if any)
returns
the requested usage message
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withComponent(component: ComponentDescriptor): Unit

Adds a new component to the parser.
Adds a new component to the parser.
component
the component descriptor to be used

Related Docs: object CommandParser | package cli

class CommandParser extends AnyRef

Instance Constructors

new CommandParser(appVendor: String, appName: String, appVersion: String)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getComponentAutoCompleteData: Map[String, Seq[ActionDescriptor]]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parse(input: Seq[String], config: CommandConfig): Option[CommandConfig]

def parse(rawInput: String, config: CommandConfig = CommandConfig()): Option[CommandConfig]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def usageMessage(withCommandFilter: Option[String] = None): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withComponent(component: ComponentDescriptor): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped