Package org.evoludo.util

Class CLOption.Category

Object

Category

Enclosing class:

CLOption

public static class CLOption.Category
extends Object

Handle different categories of options. This is mostly used to provide a more readable and useful help screen for options organized in categories.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	header	The brief category description.
(package private) int	priority	The priority of this category.

Constructor Summary

Constructors

Constructor	Description
Category(String header)	Create a new category with the header header.
Category(String header, int priority)	Create a new category with header and priority.

Method Summary

Modifier and Type	Method	Description
String	getHeader()	Get the header of category for help display.
int	getPriority()	Get the priority of this category.
void	setHeader(String header)	Set the header of category for help display.

Methods inherited from class Object

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

Field Details

header

String header

The brief category description. Section header in help screen.

priority

int priority

The priority of this category. Higher priorities are printed first.

Constructor Details

Category

public Category(String header)

Create a new category with the header header. The priority is set to 0.

Parameters:

header - the header of the category

Category

public Category(String header,
 int priority)

Create a new category with header and priority.

Parameters:

header - the header of the category

priority - the priority of the category

Method Details

getPriority

public int getPriority()

Get the priority of this category. Parameters are grouped by priority in help display.

Returns:

the priority

setHeader

public void setHeader(String header)

Set the header of category for help display.

Parameters:

header - the header

getHeader

public String getHeader()

Get the header of category for help display.

Returns:

the header