org.limitless.util
Class CommandLineArgumentParser.Details

java.lang.Object
  org.limitless.util.CommandLineArgumentParser.Details

Enclosing class:

CommandLineArgumentParser

public static class CommandLineArgumentParser.Details
extends java.lang.Object

This holds the processed set of command line arguments with no leading dashes on anything. In the case there are no entries in the array, the array will be empty and NEVER null.

Author:

Brian Jones, Brian Sanders

Field Summary

private java.util.List	arguments Unmodifiable list of arguments (String).
private java.util.List	flags Unmodifiable list of flags (String).
private java.util.List	options Unmodifiable list of options (Option).

Constructor Summary

CommandLineArgumentParser.Details(java.lang.String[] f, CommandLineArgumentParser.Option[] o, java.lang.String[] a)
This constructor is made public so builders created in any package can freely create these.

Method Summary

private java.lang.StringBuffer	dumpEntry(java.lang.StringBuffer buf, java.lang.String name, java.util.List l) Private worker to do a pretty list dump.
java.util.List	getArguments() Return a List object containing all arguments.
java.util.List	getFlags() Return a List object containing all flag names.
java.util.List	getOptions() Return a List object containing all options.
java.lang.String	toString() Dump out a human-readable version.

Methods inherited from class java.lang.Object

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

Field Detail

flags

private final java.util.List flags

Unmodifiable list of flags (String).

options

private final java.util.List options

Unmodifiable list of options (Option).

arguments

private final java.util.List arguments

Unmodifiable list of arguments (String).

Constructor Detail

CommandLineArgumentParser.Details

public CommandLineArgumentParser.Details(java.lang.String[] f,
                                         CommandLineArgumentParser.Option[] o,
                                         java.lang.String[] a)

This constructor is made public so builders created in any package can freely create these.

Parameters:

f - Array of flags (with no flag-markers attached)

o - Array of Option objects

a - Array of "arguments" which are anything else

Method Detail

getFlags

public java.util.List getFlags()

Return a List object containing all flag names.

getArguments

public java.util.List getArguments()

Return a List object containing all arguments.

getOptions

public java.util.List getOptions()

Return a List object containing all options.

dumpEntry

private java.lang.StringBuffer dumpEntry(java.lang.StringBuffer buf,
                                         java.lang.String name,
                                         java.util.List l)

Private worker to do a pretty list dump.

Parameters:

buf - StringBuffer to put result into

name - Name to pre-pend to the dump part

l - The list to dump

Returns:

The StringBuffer to allow this to be followed

toString

public java.lang.String toString()

Dump out a human-readable version.

Overrides:

toString in class java.lang.Object