net.dpml.cli.option

Class DefaultOption

Implemented Interfaces:
Option, Parent

public class DefaultOption
extends ParentImpl

A Parent implementation representing normal options.
Version:
@PROJECT-VERSION@
Author:
@PUBLISHER-NAME@

Field Summary

static boolean
DEFAULT_BURST_ENABLED
The default value for the burstEnabled constructor parameter
static String
DEFAULT_LONG_PREFIX
The default token used to prefix a long option
static String
DEFAULT_SHORT_PREFIX
The default token used to prefix a short option

Constructor Summary

DefaultOption(String shortPrefix, String longPrefix, boolean burstEnabled, String preferredName, String description, Set aliases, Set burstAliases, boolean required, Argument argument, Group children, int id)
Creates a new DefaultOption

Method Summary

void
appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
Appends usage information to the specified StringBuffer
boolean
canProcess(WriteableCommandLine commandLine, String argument)
Indicates whether this Option will be able to process the particular argument.
String
getPreferredName()
The preferred name of an option is used for generating help and usage information.
Set
getPrefixes()
Identifies the argument prefixes that should be considered options.
Set
getTriggers()
Identifies the argument prefixes that should trigger this option.
void
processParent(WriteableCommandLine commandLine, ListIterator arguments)
Process the parent.
void
validate(WriteableCommandLine commandLine)
Checks that the supplied CommandLine is valid with respect to this option.

Methods inherited from class net.dpml.cli.option.ParentImpl

appendUsage, canProcess, defaults, findOption, getArgument, getChildren, getDescription, getPrefixes, helpLines, process, validate

Methods inherited from class net.dpml.cli.option.OptionImpl

canProcess, checkPrefixes, defaults, equals, findOption, getId, hashCode, isRequired, toString

Field Details

DEFAULT_BURST_ENABLED

public static final boolean DEFAULT_BURST_ENABLED
The default value for the burstEnabled constructor parameter
Field Value:
true

DEFAULT_LONG_PREFIX

public static final String DEFAULT_LONG_PREFIX
The default token used to prefix a long option

DEFAULT_SHORT_PREFIX

public static final String DEFAULT_SHORT_PREFIX
The default token used to prefix a short option

Constructor Details

DefaultOption

public DefaultOption(String shortPrefix,
                     String longPrefix,
                     boolean burstEnabled,
                     String preferredName,
                     String description,
                     Set aliases,
                     Set burstAliases,
                     boolean required,
                     Argument argument,
                     Group children,
                     int id)
            throws IllegalArgumentException
Creates a new DefaultOption
Parameters:
shortPrefix - the prefix used for short options
longPrefix - the prefix used for long options
burstEnabled - should option bursting be enabled
preferredName - the preferred name for this Option, this should begin with either shortPrefix or longPrefix
description - a description of this Option
aliases - the alternative names for this Option
burstAliases - the aliases that can be burst
required - whether the Option is strictly required
argument - the Argument belonging to this Parent, or null
children - the Group children belonging to this Parent, ot null
id - the unique identifier for this Option

Method Details

appendUsage

public void appendUsage(StringBuffer buffer,
                        Set helpSettings,
                        Comparator comp)
Appends usage information to the specified StringBuffer
Specified by:
appendUsage in interface Option
Overrides:
appendUsage in interface ParentImpl
Parameters:
buffer - the buffer to append to
helpSettings - a set of display settings @see DisplaySetting
comp - a comparator used to sort the Options

canProcess

public boolean canProcess(WriteableCommandLine commandLine,
                          String argument)
Indicates whether this Option will be able to process the particular argument.
Specified by:
canProcess in interface Option
Overrides:
canProcess in interface ParentImpl
Parameters:
commandLine - the CommandLine object to store defaults in
argument - the argument to be tested
Returns:
true if the argument can be processed by this Option

getPreferredName

public String getPreferredName()
The preferred name of an option is used for generating help and usage information.
Specified by:
getPreferredName in interface Option
Returns:
The preferred name of the option

getPrefixes

public Set getPrefixes()
Identifies the argument prefixes that should be considered options. This is used to identify whether a given string looks like an option or an argument value. Typically an option would return the set [--,-] while switches might offer [-,+]. The returned Set must not be null.
Specified by:
getPrefixes in interface Option
Overrides:
getPrefixes in interface ParentImpl
Returns:
The set of prefixes for this Option

getTriggers

public Set getTriggers()
Identifies the argument prefixes that should trigger this option. This is used to decide which of many Options should be tried when processing a given argument string. The returned Set must not be null.
Specified by:
getTriggers in interface Option
Returns:
The set of triggers for this Option

processParent

public void processParent(WriteableCommandLine commandLine,
                          ListIterator arguments)
            throws OptionException
Process the parent.
Specified by:
processParent in interface Parent
Parameters:
commandLine - the CommandLine object to store defaults in
arguments - the ListIterator over String arguments
Throws:
OptionException - if an error occurs

validate

public void validate(WriteableCommandLine commandLine)
            throws OptionException
Checks that the supplied CommandLine is valid with respect to this option.
Specified by:
validate in interface Option
Overrides:
validate in interface ParentImpl
Parameters:
commandLine - the CommandLine to check.
Throws:
OptionException - if the CommandLine is not valid.