XML Calabash Application/com.xmlcalabash.app/CommandLine

CommandLine

class CommandLine(source)

The parser for options, arguments, and parameters passed on the command line.

This class parses an array of strings (as might appear as arguments on the command line). The resulting object has properties for all the options provided. If an option is not provided, and it is not required, the value of the corresponding property will be null.

Types

object Companion

Provides a static method to create a CommandLine from a list of arguments. You cannot instantiate a CommandLine directly.

Properties

val args: Array<out String>

The array of command line arguments to parse.

val assertions: AssertionsLevel?

Evaluate assertions?

val command: String

The command.

val config: File?

The configuration file specified.

val debug: Boolean?

Enable debugging output?

val debugger: Boolean?

Enable the debugger?

val errors: List<XProcException>

Did any parse errors occur?

val explainErrors: Boolean

Shall we try to explain errors?

val help: Boolean

Display command line help instructions?

val initializers: List<String>

Function initializers (--init initializers for Saxon)

val inputs: Map<String, List<Pair<URI, MediaType>>>

The pipeline inputs.

val licensed: Boolean

Enable licensed features?

val namespaces: Map<String, NamespaceUri>

In-scope namespace declarations for argument parsing.

val nogo: Boolean

Compile and possibly graph the pipeline but don't actually run it.

val options: Map<String, List<String>>

The pipeline options.

val outputs: Map<String, OutputFilename>

The pipeline outputs.

val pipe: Boolean?

Enable Unix-style pipeline processing of stdin and stdout?

val pipeline: File?

The pipeline or library document containing the pipeline to run.

val pipelineGraphs: String?

The pipeline graph output directory.

val step: String?

The step (in a library) to run.

val trace: File?

Did the user specify a trace output file?

val traceDocuments: File?

Did the user specify a trace documents directory?

val tryNamespaces: Boolean?

Try namespace URIs for schemas?

useLocationHints

val useLocationHints: Boolean?

Use location hints for schemas?

val validationMode: ValidationMode

The validation mode.

val verbosity: Verbosity?

How chatty shall we be?

val visualizer: String?

Did we select a visualizer?

visualizerOptions

val visualizerOptions: Map<String, String>

Did it have options?

val xmlCatalogs: List<URI>

Catalog files specified on the command line.

val xmlSchemas: List<URI>

XML Schema documents.