Jargser

A smart command line argument parser for java.

License	The MIT License
GroupId	me.mervinz
ArtifactId	jargser
Last Version	0.2.0
Release Date	Nov 19, 2016
Type	jar
Description	Jargser A smart command line argument parser for java.
Source Code Management	https://github.com/mofei2816/jargser.git

Download jargser

Filename	Size
jargser-0.2.0.pom
jargser-0.2.0.jar	6 KB
jargser-0.2.0-sources.jar	5 KB
jargser-0.2.0-javadoc.jar	24 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/me.mervinz/jargser/ -->
<dependency>
    <groupId>me.mervinz</groupId>
    <artifactId>jargser</artifactId>
    <version>0.2.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/me.mervinz/jargser/
implementation 'me.mervinz:jargser:0.2.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/me.mervinz/jargser/
implementation ("me.mervinz:jargser:0.2.0")

Apache Buildr

'me.mervinz:jargser:jar:0.2.0'

Apache Ivy

<dependency org="me.mervinz" name="jargser" rev="0.2.0">
  <artifact name="jargser" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='me.mervinz', module='jargser', version='0.2.0')
)

Scala SBT

libraryDependencies += "me.mervinz" % "jargser" % "0.2.0"

Leiningen

[me.mervinz/jargser "0.2.0"]

Dependencies

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.12

Project Modules

There are no modules declared in this project.

Jargser

Jargser is a smart command line argument parser for java.

Installation

Download the latest JAR or using Maven:

<dependency>
  <groupId>me.mervinz</groupId>
  <artifactId>jargser</artifactId>
  <version>0.2.0</version>
</dependency>

or Gradle:

compile group: 'me.mervinz', name: 'jargser', version: '0.2.0'

Get start

Init application information

• setAppName(String appName): ArgumentParser
• setAppVerion(String appVersion): ArgumentParser

Setup commands

• addCommand(String command, String desc): ArgumentParser

Setup options

• addOption(String s, String flag, String desc): ArgumentParser
• addOption(String s, String flag, String desc, String defaultValue): ArgumentParser

Parse command line arguments

• parse(String args[]): void

Generate and display usage information

• usage(): String
• printUsage(): void

Get parsed results

• hasParsedOption(String flag): bool
• parsedOption(String flag): String
• parsedCommand(): String
• parsedComamndValue(): String

Demo

package me.mervinz.demo;

import me.mervinz.jargser.ArgumentParser;

public class Demo {
    public static void main(String[] args) {
        // Init parser
        ArgumentParser parser = new ArgumentParser();
        parser.setAppName("demo");
        parser.setAppVersion("1.0.0");
        // Setup commands
        parser.addCommand("install", "Install application.");
        parser.addCommand("help", "Display help content.");
        // Setup options
        parser.addOption("c", "config", "Config file path.");
        parser.addOption("v", "verbose", "Show more output.");
        // Parse arguments
        parser.parse(args);
        
        // Get results
        
        // Command
        switch (parse.parsedCommand()) {
        case "install":
            // Install... 
            break;
        default:
            parser.printUsage();
            System.exit(1);
        }
        
        // Option
        
        // Check option
        if (parser.hasParsedOption("verbose")) {
            // Found flag 'verbose'.
        }
        
        // Get option value
        String config = parser.parsedOption("config");
        // ...
    }
}

The usage that Jargser generated below:

demo 1.0.0

Usage:
  demo <command> [options]
  
Commands:
  install                     Install application
  help                        Display help content
  
Options:
  -c  --config                Config file path
  -v  --verbose               Show more output

---

Dependencies

For detail see pom.xml.

Contributing

1. Fork it.
2. Create your feature branch. ($ git checkout feature/my-feature-branch)
3. Commit your changes. ($ git commit -am 'What feature I just added.')
4. Push to the branch. ($ git push origin feature/my-feature-branch)
5. Create a new Pull Request

Authors

• Mervin | Website | Github | Mail

License

The MIT License (MIT). For detail see LICENSE.

Versions

Version
0.2.0 Nov 19, 2016
0.1.0 Nov 19, 2016