OpenJDK 1.23 · com.sun.management.internal.DiagnosticCommandArgumentInfo

Diagnostic Command Argument information. It contains the description of one parameter of the diagnostic command. A parameter can either be an option or an argument. Options are identified by the option name while arguments are identified by their position in the command line. The generic syntax of a diagnostic command is:

<command name> [<option>=<value>] [<argument_value>]

Example:

command_name option1=value1 option2=value argumentA argumentB argumentC

In this command line, the diagnostic command receives five parameters, two options named option1 and option2, and three arguments. argumentA's position is 0, argumentB's position is 1 and argumentC's position is 2.

Modifier and Type	Field and Description
private final String	defaultValue
private final String	description
private final boolean	mandatory
private final boolean	multiple
private final String	name
private final boolean	option
private final int	position
private final String	type

Constructor Summary

Access	Constructor and Description
pack-priv	DiagnosticCommandArgumentInfo(String name, String description, String type, String defaultValue, boolean mandatory, boolean option, boolean multiple, int position)

Method Summary

Modifier and Type	Method and Description
pack-priv String	Returns: the default value as a String if a default value is defined, null otherwise. getDefault() Returns the default value as a String if a default value is defined, null otherwise.
pack-priv String	Returns: the argument description getDescription() Returns the argument description.
pack-priv String	Returns: the argument name getName() Returns the argument name.
pack-priv int	Returns: the expected position of this argument if it is not an option, -1 otherwise. getPosition() Returns the expected position of this argument if it is not an option, -1 otherwise.
pack-priv String	Returns: the argument type getType() Returns the argument type.
pack-priv boolean	Returns: `true` if the argument is mandatory, `false` otherwise isMandatory() Returns `true` if the argument is mandatory, `false` otherwise.
pack-priv boolean	Returns: `true` if the argument can be specified multiple times, `false` otherwise isMultiple() Returns `true` if the argument can be specified multiple times, `false` otherwise.
pack-priv boolean	Returns: `true` if the argument is an option, `false` otherwise isOption() Returns `true` if the argument is an option, `false` otherwise.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

defaultValue	back to summary
private final String defaultValue

description	back to summary
private final String description

mandatory	back to summary
private final boolean mandatory

multiple	back to summary
private final boolean multiple

name	back to summary
private final String name

option	back to summary
private final boolean option

position	back to summary
private final int position

type	back to summary
private final String type

Constructor Detail

DiagnosticCommandArgumentInfo	back to summary
pack-priv DiagnosticCommandArgumentInfo(String name, String description, String type, String defaultValue, boolean mandatory, boolean option, boolean multiple, int position)

Method Detail

getDefault	back to summary
pack-priv String getDefault() Returns the default value as a String if a default value is defined, null otherwise. Returns:String the default value as a String if a default value is defined, null otherwise.

getDefault

back to summary

pack-priv String getDefault()

Returns the default value as a String if a default value is defined, null otherwise.

Returns:String: the default value as a String if a default value is defined, null otherwise.

getDescription	back to summary
pack-priv String getDescription() Returns the argument description. Returns:String the argument description

getDescription

back to summary

pack-priv String getDescription()

Returns the argument description.

Returns:String: the argument description

getName	back to summary
pack-priv String getName() Returns the argument name. Returns:String the argument name

getName

back to summary

pack-priv String getName()

Returns the argument name.

Returns:String: the argument name

getPosition	back to summary
pack-priv int getPosition() Returns the expected position of this argument if it is not an option, -1 otherwise. Argument position if defined from left to right, starting at zero and ignoring the diagnostic command name and options. Returns:int the expected position of this argument if it is not an option, -1 otherwise.

getPosition

back to summary

pack-priv int getPosition()

Returns the expected position of this argument if it is not an option, -1 otherwise. Argument position if defined from left to right, starting at zero and ignoring the diagnostic command name and options.

Returns:int: the expected position of this argument if it is not an option, -1 otherwise.

getType	back to summary
pack-priv String getType() Returns the argument type. Returns:String the argument type

getType

back to summary

pack-priv String getType()

Returns the argument type.

Returns:String: the argument type

isMandatory back to summary

isMandatory	back to summary
pack-priv boolean isMandatory() Returns `true` if the argument is mandatory, `false` otherwise. Returns:boolean `true` if the argument is mandatory, `false` otherwise

pack-priv boolean isMandatory()

Returns true if the argument is mandatory, false otherwise.

Returns:boolean: true if the argument is mandatory, false otherwise

isMultiple back to summary

isMultiple	back to summary
pack-priv boolean isMultiple() Returns `true` if the argument can be specified multiple times, `false` otherwise. Returns:boolean `true` if the argument can be specified multiple times, `false` otherwise

pack-priv boolean isMultiple()

Returns true if the argument can be specified multiple times, false otherwise.

Returns:boolean: true if the argument can be specified multiple times, false otherwise

isOption back to summary

isOption	back to summary
pack-priv boolean isOption() Returns `true` if the argument is an option, `false` otherwise. Options have to be specified using the <key>=<value> syntax on the command line, while other arguments are specified with a single <value> field and are identified by their position on command line. Returns:boolean `true` if the argument is an option, `false` otherwise

pack-priv boolean isOption()

Returns true if the argument is an option, false otherwise. Options have to be specified using the <key>=<value> syntax on the command line, while other arguments are specified with a single <value> field and are identified by their position on command line.

Returns:boolean: true if the argument is an option, false otherwise

pack-priv Class DiagnosticCommandArgumentInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail