README.md

   

kivakit-commandline   

This project facilitates object-oriented parsing of command line arguments and switches.

Index

Summary

Dependencies | Class Diagrams | Package Diagrams | Javadoc

Dependencies   

Dependency Diagram

Maven Dependency

<dependency>
    <groupId>com.telenav.kivakit</groupId>
    <artifactId>kivakit-commandline</artifactId>
    <version>1.5.0</version>
</dependency>

Summary

The kivakit-core commandline project is used by the kivakit-core-application project to provide easy command line parsing to KivaKit applications. A detailed example on how to parse command line arguments and switches is available in the Javadoc for the Application class.

Class Diagrams    

Argument Parsing
Command Line
Command Line Validation
Switch Parsing

Package Diagrams   

com.telenav.kivakit.commandline
com.telenav.kivakit.commandline.lexakai
com.telenav.kivakit.commandline.parsing

Javadoc   

Javadoc coverage for this project is 78.2%.

   

The following significant classes are undocumented:

• SwitchParsers

Class	Documentation Sections
ApplicationMetadata
Argument
ArgumentList
ArgumentListValidator
ArgumentParser	Parser Builders
	Built-In Parsers
ArgumentParser.Builder
ArgumentParserList
CommandLine	Retrieving Switches and Arguments
	Error Handling
CommandLineParser	Example
	Parsing a Command Line
	Switch Conventions
DiagramArgument
DiagramCommandLine
DiagramSwitch
DiagramValidation
Quantifier
Switch
SwitchList
SwitchListValidator
SwitchParser	Parser Builders
	Built-In Parsers
SwitchParser.Builder
SwitchParserList
SwitchParsers

_{Copyright © 2011-2021 Telenav, Inc. Distributed under Apache License, Version 2.0
This documentation was generated by Lexakai. UML diagrams courtesy of PlantUML.}