net.dpml.cli.option

Class DefaultOption

java.lang.Object

net.dpml.cli.option.OptionImpl

net.dpml.cli.option.ParentImpl

net.dpml.cli.option.DefaultOption

All Implemented Interfaces:

Option, Parent

public class DefaultOption
extends ParentImpl

A Parent implementation representing normal options.

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_BURST_ENABLED The default value for the burstEnabled constructor parameter
static java.lang.String	DEFAULT_LONG_PREFIX The default token used to prefix a long option
static java.lang.String	DEFAULT_SHORT_PREFIX The default token used to prefix a short option

Constructor Summary

Constructors

Constructor and Description
DefaultOption(java.lang.String shortPrefix, java.lang.String longPrefix, boolean burstEnabled, java.lang.String preferredName, java.lang.String description, java.util.Set aliases, java.util.Set burstAliases, boolean required, Argument argument, Group children, int id) Creates a new DefaultOption

Method Summary

Methods

Modifier and Type	Method and Description
void	appendUsage(java.lang.StringBuffer buffer, java.util.Set helpSettings, java.util.Comparator comp) Appends usage information to the specified StringBuffer
boolean	canProcess(WriteableCommandLine commandLine, java.lang.String argument) Indicates whether this Option will be able to process the particular argument.
java.lang.String	getPreferredName() The preferred name of an option is used for generating help and usage information.
java.util.Set	getPrefixes() Identifies the argument prefixes that should be considered options.
java.util.Set	getTriggers() Identifies the argument prefixes that should trigger this option.
void	processParent(WriteableCommandLine commandLine, java.util.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

defaults, findOption, getArgument, getChildren, getDescription, helpLines, process

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dpml.cli.Option

canProcess, getId, isRequired

Field Detail

DEFAULT_SHORT_PREFIX

public static final java.lang.String DEFAULT_SHORT_PREFIX

The default token used to prefix a short option

See Also:

Constant Field Values

DEFAULT_LONG_PREFIX

public static final java.lang.String DEFAULT_LONG_PREFIX

The default token used to prefix a long option

See Also:

Constant Field Values

DEFAULT_BURST_ENABLED

public static final boolean DEFAULT_BURST_ENABLED

The default value for the burstEnabled constructor parameter

See Also:

Constant Field Values

Constructor Detail

DefaultOption

public DefaultOption(java.lang.String shortPrefix,
             java.lang.String longPrefix,
             boolean burstEnabled,
             java.lang.String preferredName,
             java.lang.String description,
             java.util.Set aliases,
             java.util.Set burstAliases,
             boolean required,
             Argument argument,
             Group children,
             int id)
              throws java.lang.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

Throws:

java.lang.IllegalArgumentException - if the preferredName or an alias isn't prefixed with shortPrefix or longPrefix

Method Detail

canProcess

public boolean canProcess(WriteableCommandLine commandLine,
                 java.lang.String argument)

Indicates whether this Option will be able to process the particular argument.

Specified by:

canProcess in interface Option

Overrides:

canProcess in class 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

processParent

public void processParent(WriteableCommandLine commandLine,
                 java.util.ListIterator arguments)
                   throws OptionException

Process the parent.

Parameters:

commandLine - the CommandLine object to store defaults in

arguments - the ListIterator over String arguments

Throws:

OptionException - if an error occurs

See Also:

Option.process(WriteableCommandLine, ListIterator)

getTriggers

public java.util.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.

Returns:

The set of triggers for this Option

getPrefixes

public java.util.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 class ParentImpl

Returns:

The set of prefixes for this Option

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 class ParentImpl

Parameters:

commandLine - the CommandLine to check.

Throws:

OptionException - if the CommandLine is not valid.

appendUsage

public void appendUsage(java.lang.StringBuffer buffer,
               java.util.Set helpSettings,
               java.util.Comparator comp)

Appends usage information to the specified StringBuffer

Specified by:

appendUsage in interface Option

Overrides:

appendUsage in class ParentImpl

Parameters:

buffer - the buffer to append to

helpSettings - a set of display settings @see DisplaySetting

comp - a comparator used to sort the Options

getPreferredName

public java.lang.String getPreferredName()

The preferred name of an option is used for generating help and usage information.

Returns:

The preferred name of the option