com.varmateo.yawg.cli

Class CliParameter

java.lang.Object

com.varmateo.yawg.cli.CliParameter

public final class CliParameter
extends Object

A description of a command line option.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CliParameter.Builder A builder of CliParameter instances.

Method Summary

Modifier and Type	Method and Description
String	argName() Informative only.
static CliParameter.Builder	builder() Creates a new builder with no initializations.
String	description()
boolean	isWithArg()
String	literal()
String	longName()
String	name()
String	shortName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static CliParameter.Builder builder()

Creates a new builder with no initializations.

Returns:

A newly created Builder instance.

shortName

public String shortName()

longName

public String longName()

description

public String description()

isWithArg

public boolean isWithArg()

argName

public String argName()

Informative only.

name

public String name()

literal

public String literal()