AbstractUI.OptionalArgument (Braille Utils)

java.lang.Object

org.daisy.cli.AbstractUI.Definition

org.daisy.cli.AbstractUI.Argument

org.daisy.cli.AbstractUI.OptionalArgument

Enclosing class:: AbstractUI

public static class AbstractUI.OptionalArgument extends AbstractUI.Argument

Provides the information needed by an optional argument.

Author:: Joel Håkansson

Constructor Summary

Constructors

Constructor

Description

OptionalArgument(String name, String description, String defaultValue)

Creates a new optional argument

OptionalArgument(String name, String description, List<AbstractUI.Definition> values, String defaultValue)

Creates a new optional argument with a finite list of acceptable values.
Method Summary

Modifier and Type

Method

Description

String

getDefault()

Gets the default value.

Methods inherited from class org.daisy.cli.AbstractUI.Argument
getValues, hasValues

Methods inherited from class org.daisy.cli.AbstractUI.Definition
getDescription, getName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- OptionalArgument
  
  public OptionalArgument(String name, String description, String defaultValue)
  
  Creates a new optional argument
  
  Parameters:
  
  name - the name of the argument
  
  description - the description of the argument
  
  defaultValue - the default value for the argument
- OptionalArgument
  
  public OptionalArgument(String name, String description, List<AbstractUI.Definition> values, String defaultValue)
  
  Creates a new optional argument with a finite list of acceptable values.
  
  Parameters:
  
  name - the name of the argument
  
  description - the description of the argument
  
  values - the list of acceptable values
  
  defaultValue - the default value for the argument
Method Details
- getDefault
  
  public String getDefault()
  
  Gets the default value.
  
  Returns:
  
  returns the default value for the argument