net.dpml.cli

Class DisplaySetting

java.lang.Object

net.dpml.cli.DisplaySetting

public final class DisplaySetting
extends java.lang.Object

An enum of possible display settings. These settings are used to control the presence of various features in the String representations of options, CommandLines and usage strings. Usually a Set of DisplaySetting instances will be passed to a method that will lookup the presence of the values.

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set	ALL A Set guarenteed to contain all possible DisplaySetting values
static DisplaySetting	DISPLAY_ALIASES Indicates that aliases should be included
static DisplaySetting	DISPLAY_ARGUMENT_BRACKETED Indicates that arguments should be included bracketed
static DisplaySetting	DISPLAY_ARGUMENT_NUMBERED Indicates that arguments should be included numbered
static DisplaySetting	DISPLAY_GROUP_ARGUMENT Indicates that group arguments should be included
static DisplaySetting	DISPLAY_GROUP_EXPANDED Indicates that groups should be included expanded
static DisplaySetting	DISPLAY_GROUP_NAME Indicates that group names should be included
static DisplaySetting	DISPLAY_GROUP_OUTER Indicates that group outer brackets should be included
static DisplaySetting	DISPLAY_OPTIONAL Indicates that optionality should be included
static DisplaySetting	DISPLAY_PARENT_ARGUMENT Indicates that arguments of Parents should be included
static DisplaySetting	DISPLAY_PARENT_CHILDREN Indicates that children of Parents should be included
static DisplaySetting	DISPLAY_PROPERTY_OPTION Indicates that property options should be included
static DisplaySetting	DISPLAY_SWITCH_DISABLED Indicates that switches should be included disabled
static DisplaySetting	DISPLAY_SWITCH_ENABLED Indicates that switches should be included enabled
static java.util.Set	NONE A Set guarenteed to contain no DisplaySetting values

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object that) Test this object for equality with the supplied object.
int	hashCode() Return the instance hashcode value.
java.lang.String	toString() Return a string representation of the instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final java.util.Set ALL

A Set guarenteed to contain all possible DisplaySetting values

NONE

public static final java.util.Set NONE

A Set guarenteed to contain no DisplaySetting values

DISPLAY_ALIASES

public static final DisplaySetting DISPLAY_ALIASES

Indicates that aliases should be included

DISPLAY_OPTIONAL

public static final DisplaySetting DISPLAY_OPTIONAL

Indicates that optionality should be included

DISPLAY_PROPERTY_OPTION

public static final DisplaySetting DISPLAY_PROPERTY_OPTION

Indicates that property options should be included

DISPLAY_SWITCH_ENABLED

public static final DisplaySetting DISPLAY_SWITCH_ENABLED

Indicates that switches should be included enabled

DISPLAY_SWITCH_DISABLED

public static final DisplaySetting DISPLAY_SWITCH_DISABLED

Indicates that switches should be included disabled

DISPLAY_GROUP_NAME

public static final DisplaySetting DISPLAY_GROUP_NAME

Indicates that group names should be included

DISPLAY_GROUP_EXPANDED

public static final DisplaySetting DISPLAY_GROUP_EXPANDED

Indicates that groups should be included expanded

DISPLAY_GROUP_ARGUMENT

public static final DisplaySetting DISPLAY_GROUP_ARGUMENT

Indicates that group arguments should be included

DISPLAY_GROUP_OUTER

public static final DisplaySetting DISPLAY_GROUP_OUTER

Indicates that group outer brackets should be included

DISPLAY_ARGUMENT_NUMBERED

public static final DisplaySetting DISPLAY_ARGUMENT_NUMBERED

Indicates that arguments should be included numbered

DISPLAY_ARGUMENT_BRACKETED

public static final DisplaySetting DISPLAY_ARGUMENT_BRACKETED

Indicates that arguments should be included bracketed

DISPLAY_PARENT_ARGUMENT

public static final DisplaySetting DISPLAY_PARENT_ARGUMENT

Indicates that arguments of Parents should be included

DISPLAY_PARENT_CHILDREN

public static final DisplaySetting DISPLAY_PARENT_CHILDREN

Indicates that children of Parents should be included

Method Detail

hashCode

public int hashCode()

Return the instance hashcode value.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash value

equals

public boolean equals(java.lang.Object that)

Test this object for equality with the supplied object.

Overrides:

equals in class java.lang.Object

Parameters:

that - the other object

Returns:

true if the objects are equal

toString

public java.lang.String toString()

Return a string representation of the instance.

Overrides:

toString in class java.lang.Object

Returns:

the string