org.opends.server.util.args
Class ArgumentGroup

java.lang.Object
  org.opends.server.util.args.ArgumentGroup

All Implemented Interfaces:

java.lang.Comparable<ArgumentGroup>

public class ArgumentGroup
extends java.lang.Object
implements java.lang.Comparable<ArgumentGroup>

Class for organizing options into logical groups when arguement usage is printed. To use an argument group, create an instance and use #addArgument(Argument, ArgumentGroup) when adding arguments for to the parser.

Constructor Summary

ArgumentGroup(Message description, int priority)
Creates a parameterized instance.

Method Summary

int	compareTo(ArgumentGroup o)
Message	getDescription() Gets the description for this group of arguments.
void	setDescription(Message description) Sets the description for this group of arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentGroup

public ArgumentGroup(Message description,
                     int priority)

Creates a parameterized instance.

Parameters:

description - for options in this group that is printed before argument descriptions in usage output

priority - number governing the position of this group within the usage statement. Groups with higher priority values appear before groups with lower priority.

Method Detail

getDescription

public Message getDescription()

Gets the description for this group of arguments.

Returns:

description for this argument group

setDescription

public void setDescription(Message description)

Sets the description for this group of arguments.

Parameters:

description - for this argument group

compareTo

public int compareTo(ArgumentGroup o)

Specified by:

compareTo in interface java.lang.Comparable<ArgumentGroup>