ml.comet.experiment.config

Class ConfigItem

java.lang.Object

ml.comet.experiment.config.ConfigItem

public class ConfigItem
extends Object

Represents specific configuration item holding information about key in the configuration file and environment variable key.

Constructor Summary

Constructors

Constructor and Description
ConfigItem()

Method Summary

Modifier and Type	Method and Description
Duration	getDuration() Returns value of this item as Duration or throw an ConfigException if value is missing or have wrong type.
int	getInt() Returns value of this item as int or throw an ConfigException if value is missing or have wrong type.
Optional<String>	getOptionalString() Returns optional value for this item as string.
String	getString() Return value of this item as string or throw an ConfigException if value is missing.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigItem

public ConfigItem()

Method Detail

getString

public String getString()
                 throws ConfigException

Return value of this item as string or throw an ConfigException if value is missing.

Returns:

value for this item as string.

Throws:

ConfigException - if value is missing or of the wrong type.

getOptionalString

public Optional<String> getOptionalString()

Returns optional value for this item as string.

Returns:

the optional value for this item as string.

getInt

public int getInt()
           throws ConfigException

Returns value of this item as int or throw an ConfigException if value is missing or have wrong type.

Returns:

value of this item as int.

Throws:

ConfigException - if value is missing or of the wrong type.

getDuration

public Duration getDuration()
                     throws ConfigException

Returns value of this item as Duration or throw an ConfigException if value is missing or have wrong type.

Returns:

the value of this item as Duration

Throws:

ConfigException - if value is missing or of the wrong type.

toString

public String toString()

Overrides:

toString in class Object