Package madkit.kernel
Enum Class Madkit.Option
- All Implemented Interfaces:
Serializable
,Comparable<Madkit.Option>
,java.lang.constant.Constable
,MadkitOption
- Enclosing class:
- Madkit
MaDKit options which are valued with a string representing parameters. These
options could be used from the command line or using the main method of
MaDKit.
- Since:
- MaDKit 5.0.0.10
- Version:
- 0.9
- Author:
- Fabien Michel
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionthe agent frame class which should be used by the GUI manager, default isAgentFrame
Can be used to specify multiple properties at once, using a regular properties filethe desktop frame class which should be used, default isMDKDesktopFrame
the directory containing the MDK i18n filesUsed to launch agents at start up.Used to specify the directory wherein the logs should be done when theMadkit.BooleanOption.createLogFiles
is activated. -
Method Summary
Modifier and TypeMethodDescriptiontoString()
Returns the constant's name prefixed by "--
" so that it could interpreted as an option of the command line or inMadkit(String...)
.static Madkit.Option
Returns the enum constant of this class with the specified name.static Madkit.Option[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
Methods inherited from interface madkit.kernel.MadkitOption
name
-
Enum Constant Details
-
launchAgents
Used to launch agents at start up. This option can be used from the command line or using the main method of MaDKit.SYNOPSIS
--launchAgents
AGENT_CLASS_NAME[,GUI][,NB][;OTHERS]- AGENT_CLASS_NAME: the agent class to launch
- GUI (boolean optional): with a default GUI if
true
- NB (integer optional): number of desired instances
DESCRIPTION
The optional parameters could be used to (1) launch several different types of agents, (2) launch the agents with a default GUI and/or (3) specify the number of desired instances of each type.DEFAULT VALUE
Default value is "null", meaning that no agent has to be launched.Default values for the optional parameters are
- GUI :
false
- NB : 1
EXAMPLES
- --launchAgents myPackage.MyAgent
- --launchAgents myPackage.MyAgent,true
- --launchAgents myPackage.MyAgent,false,3
- --launchAgents myPackage.MyAgent;other.OtherAgent
- --launchAgents myPackage.MyAgent,true;other.OtherAgent,true
- --launchAgents myPackage.MyAgent;other.OtherAgent,true,3;madkit.kernel.Agent
-
logDirectory
Used to specify the directory wherein the logs should be done when theMadkit.BooleanOption.createLogFiles
is activated.SYNOPSIS
--logDirectory
DIRECTORY_NAMEDESCRIPTION
Specify the desired directory. It could be an absolute or a relative path. At runtime, a log directory named with the current date (second precision) will be created in the log directory for each MaDKit session. E.g. /home/neo/madkit_5/logs/2012.02.23.16.23.53DEFAULT VALUE
Default value is "logs", so that a directory named "logs" will be created in the application working directory.EXAMPLES
- --logDirectory bin
- --logDirectory /home/neo/madkit_logs
- See Also:
-
desktopFrameClass
the desktop frame class which should be used, default isMDKDesktopFrame
-
i18nDirectory
the directory containing the MDK i18n files -
configFile
Can be used to specify multiple properties at once, using a regular properties file -
agentFrameClass
the agent frame class which should be used by the GUI manager, default isAgentFrame
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
toString
Returns the constant's name prefixed by "--
" so that it could interpreted as an option of the command line or inMadkit(String...)
.- Specified by:
toString
in interfaceMadkitOption
- Overrides:
toString
in classEnum<Madkit.Option>
- Returns:
- The command line form for this option, with -- in front of
the option's name, i.e.
--optionName
-