Class CLOCategory

Object

CLOCategory

public class CLOCategory
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
static final CLOCategory	Global	The category for global options.
static final CLOCategory	GUI	The category for user interface specific options.
(package private) String	header	The brief category description.
static final CLOCategory	Model	The category for model specific options.
static final CLOCategory	Module	The category for module specific options.
(package private) int	priority	The priority of this category.
static final CLOCategory	Simulation	The category for simulation specific options.

Constructor Summary

Constructors

Constructor	Description
CLOCategory(String header)	Create a new category with the header header.
CLOCategory(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.

Note: the description string may contain any UTF-8 characters as well as HTML character entities. If necessary they will be escaped and converted to UTF-8 for display in XML documents.

priority

int priority

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

Global

public static final CLOCategory Global

The category for global options.

GUI

public static final CLOCategory GUI

The category for user interface specific options.

Simulation

public static final CLOCategory Simulation

The category for simulation specific options.

Model

public static final CLOCategory Model

The category for model specific options.

Module

public static final CLOCategory Module

The category for module specific options.

Constructor Details

CLOCategory

public CLOCategory(String header)

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

Parameters:

header - the header of the category

CLOCategory

public CLOCategory(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