Package org.rwtodd.args

Class ParamGroup

java.lang.Object

org.rwtodd.args.ParamGroup

All Implemented Interfaces:

DecorativeParam, Param

public class ParamGroup
extends Object
implements DecorativeParam

This is a named group of Params for the purpose of organizing help text. It is not a param itself, and doesn't add itself to the Parser's map.

Constructor Summary

Constructors

Constructor	Description
ParamGroup(String name, Param... params)	Creates a ParamGroup.

Method Summary

Modifier and Type	Method	Description
void	addHelp(PrintStream ps)	adds help for this parameter to the given stream.
void	addToMap(Map<String,Param> map)	Add the parameter's names to a Map<String,Param>.

Methods inherited from class java.lang.Object

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

Constructor Details

ParamGroup

public ParamGroup(String name,
 Param... params)

Creates a ParamGroup.

Parameters:

name - the name of the group, displayed above the contained params.

params - the parameters in the group.

Method Details

addToMap

public void addToMap(Map<String,Param> map)

Add the parameter's names to a Map<String,Param>.

Specified by:

addToMap in interface Param

Parameters:

map - the Map to which our names should be added.

addHelp

public void addHelp(PrintStream ps)

adds help for this parameter to the given stream.

Specified by:

addHelp in interface Param

Parameters:

ps - the stream to use