Class CommandOptionValue

java.lang.Object

org.episteme.natural.chemistry.loaders.cml.util.CommandOptionValue

public class CommandOptionValue
extends Object

Represents a descriptor for an allowed value for a CommandOption.

Since:

1.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Constructor Summary

Constructors

Constructor	Description
CommandOptionValue(String name, String desc)	Creates a new CommandOptionValue object.

Method Summary

Modifier and Type	Method	Description
String	usage()	Returns a string representing the usage documentation for this value.

Methods inherited from class Object

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

Constructor Details

CommandOptionValue

public CommandOptionValue(String name,
 String desc)

Creates a new CommandOptionValue object.

Parameters:

name - the literal value name

desc - the description of this value

Method Details

usage

public String usage()

Returns a string representing the usage documentation for this value.

Returns:

the usage string