little-cli/little.cli/Application

Application

sealed trait Application

Encapsulates components for providing command line interface.

See also
class Object
trait Matchable
class Any

Value members

Abstract methods

def addOption(opt: Option): Application

Adds option to existing application options.

Adds option to existing application options.

Value Params
opt

option

def addOption(opt: String, description: String): Application

Adds option to existing application options.

Adds option to existing application options.

Value Params
description

option description

opt

short option

def addOption(opt: String, hasArg: Boolean, description: String): Application

Adds option to existing application options.

Adds option to existing application options.

Value Params
description

option description

hasArg

specifies whether option takes an argument

opt

short option

def addOption(opt: String, longOpt: String, hasArg: Boolean, description: String): Application

Adds option to existing application options.

Adds option to existing application options.

Value Params
description

option description

hasArg

specifies whether option takes an argument

longOpt

long option

opt

short option

def addOptionGroup(group: OptionGroup): Application

Adds option group to existing application options.

Adds option group to existing application options.

Value Params
group

option group

def addOptionGroup(opts: Option*): Application

Adds option group to existing application options.

Adds option group to existing application options.

Value Params
opts

options

def addOptions(opts: Optionable*): Application

Adds options to existing application options.

Adds options to existing application options.

Value Params
opts

options

def formatter: HelpFormatter

Gets formatter used for printing help.

Gets formatter used for printing help.

def formatter(fmt: HelpFormatter): Application

Sets formatter used for printing help.

Sets formatter used for printing help.

Value Params
fmt

help formatter

def header: String

Gets header displayed at beginning of help.

Gets header displayed at beginning of help.

def header(text: String): Application

Sets header displayed at beginning of help.

Sets header displayed at beginning of help.

Value Params
text

header text

def help: String

Gets help.

Gets help.

def options: Options

Gets application options.

Gets application options.

def options(opts: Options): Application

Sets application options.

Sets application options.

Value Params
opts

options

def options(opts: Optionable*): Application

Sets application options.

Sets application options.

Value Params
opts

options

def parse(args: Array[String]): CommandLine

Parses supplied arguments according to application options.

Parses supplied arguments according to application options.

Value Params
args

arguments

def parse(args: Array[String], stoppable: Boolean): CommandLine

Parses supplied arguments according to application options.

Parses supplied arguments according to application options.

Value Params
args

arguments

stoppable

specifies whether to stop at first unrecognized argument instead of throwing ParseException

def printHelp(): Unit

Prints help to Sytem.out.

Prints help to Sytem.out.

def printHelp(out: OutputStream): Unit

Prints help to supplied output stream.

Prints help to supplied output stream.

Value Params
out

output stream to which help is printed

def printHelp(out: PrintWriter): Unit

Prints help to supplied writer.

Prints help to supplied writer.

Value Params
out

writer to which help is printed

def tryParse(args: Array[String]): Try[CommandLine]

Tries to parse supplied arguments according to application options.

Tries to parse supplied arguments according to application options.

Value Params
args

arguments

def tryParse(args: Array[String], stoppable: Boolean): Try[CommandLine]

Tries to parse supplied arguments according to application options.

Tries to parse supplied arguments according to application options.

Value Params
args

arguments

stoppable

specifies whether to stop at first unrecognized argument instead of failing with ParseException

def usage: String

Gets usage syntax.

Gets usage syntax.

def usage(syntax: String): Application

Sets usage syntax.

Sets usage syntax.

Value Params
syntax

usage syntax

def width: Int

Gets maximum number of characters printed per line in help.

Gets maximum number of characters printed per line in help.

def width(max: Int): Application

Sets maximum number of characters printed per line in help.

Sets maximum number of characters printed per line in help.

Value Params
max

number of characters per line