org.apache.commons.cli
Class OptionGroup

java.lang.Object
  |
  +--org.apache.commons.cli.OptionGroup

public class OptionGroup

extends java.lang.Object

A group of mutually exclusive options.

Version:

$Revision: 1.2 $

Author:

John Keyes ( john at integralsource.com )

Constructor Summary

OptionGroup()

Method Summary

OptionGroup	addOption(Option opt) add opt to this group
java.util.Collection	getNames()
java.util.Collection	getOptions()
java.lang.String	getSelected()
boolean	isRequired() Returns whether this option group is required.
void	setRequired(boolean required)
void	setSelected(Option opt) set the selected option of this group to name.
java.lang.String	toString() Returns the stringified version of this OptionGroup.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionGroup

public OptionGroup()

Method Detail

addOption

public OptionGroup addOption(Option opt)

add opt to this group

Parameters:

opt - the option to add to this group

Returns:

this option group with opt added

getNames

public java.util.Collection getNames()

Returns:

the names of the options in this group as a Collection

getOptions

public java.util.Collection getOptions()

Returns:

the options in this group as a Collection

setSelected

public void setSelected(Option opt)
                 throws AlreadySelectedException

set the selected option of this group to name.

Parameters:

opt - the option that is selected

Throws:

AlreadySelectedException - if an option from this group has already been selected.

getSelected

public java.lang.String getSelected()

Returns:

the selected option name

setRequired

public void setRequired(boolean required)

Parameters:

required - specifies if this group is required

isRequired

public boolean isRequired()

Returns whether this option group is required.

toString

public java.lang.String toString()

Returns the stringified version of this OptionGroup.

Overrides:

toString in class java.lang.Object

Returns:

the stringified representation of this group