org.kaiwitte.joptions
Interface Options

public interface Options

A set of Options. In the XML declaration file it is defined using the <Options>-tag.

Method Summary

java.lang.String	getName() Returns the name of this set of options.
Option	getOption(java.lang.String key) Returns the Option for the specified key.
Option	getOption(java.lang.String key, Option def) Returns the Option for the specified key or the provided default value.
java.util.Iterator<java.lang.String>	keyNames() Returns an Iterator over the available key names.
int	size() Returns the number of options.

Method Detail

size

int size()

Returns the number of options.

Returns:

the number of options

keyNames

java.util.Iterator<java.lang.String> keyNames()

Returns an Iterator over the available key names.

Returns:

an Iterator over the available key names

getOption

Option getOption(java.lang.String key)

Returns the Option for the specified key.

Parameters:

key - the key for the option. In the XML declaration file it is defined using the <name>-tag.

Returns:

the Option for the specified key

getOption

Option getOption(java.lang.String key,
                 Option def)

Returns the Option for the specified key or the provided default value.

Parameters:

key - the key for the option. In the XML declaration file it is defined using the <name>-tag.

def - the default value to be returned when there is no such option

Returns:

the Option for the specified key

getName

java.lang.String getName()

Returns the name of this set of options. (Whatever that is - might be removed in the beta.)

Returns:

the name