StatsCommand

com.reactific.riddl.stats.StatsCommand

Validate Command

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited types

type OptionPlacer[V] = (V, OPT) => OPT

Attributes

Inherited from:
CommandPlugin

Value members

Concrete methods

override def loadOptionsFrom(configFile: Path, commonOptions: CommonOptions): Either[Messages, Options]

Attributes

Definition Classes
override def replaceInputFile(opts: Options, inputFile: Path): Options

Attributes

Definition Classes
override def run(options: Options, commonOptions: CommonOptions, log: Logger, outputDirOverride: Option[Path]): Either[Messages, PassesResult]

Execute the command given the options.

Execute the command given the options. Error should be returned as Left(messages) and not directly logged. The log is for verbose or debug output

Value parameters

commonOptions

The options common to all commands

log

A logger for logging errors, warnings, and info

options

The command specific options

Attributes

Returns

Either a set of Messages on error or a Unit on success

Definition Classes

Inherited methods

override def getConfigReader: ConfigReader[Options]

Provide a typesafe/Config reader for the commands options.

Provide a typesafe/Config reader for the commands options. This reader should read an object having the same name as the command. The fields of that object must correspond to the fields of the OPT type.

Attributes

Returns

A pureconfig.ConfigReader[OPT] that knows how to read OPT

Definition Classes
Inherited from:
InputFileCommandPlugin
def getOptions: (OParser[Unit, Options], Options)

Provide an scopt OParser for the commands options type, OPT

Provide an scopt OParser for the commands options type, OPT

Attributes

Returns

A pair: the OParser and the default values for OPT

Inherited from:
InputFileCommandPlugin
def inputFile(f: () => File): OParser[File, OPT]

Attributes

Inherited from:
CommandPlugin

Attributes

Inherited from:
PluginInterface
def outputDir(f: () => File): OParser[File, OPT]

Attributes

Inherited from:
CommandPlugin

Attributes

Inherited from:
CommandPlugin
final override def pluginVersion: String

Attributes

Definition Classes
Inherited from:
CommandPlugin

Attributes

Inherited from:
PluginInterface

Inherited fields

Attributes

Inherited from:
CommandPlugin