uk.ac.ed.epcc.webapp.apps

Class Option.Instance

java.lang.Object

uk.ac.ed.epcc.webapp.apps.Option.Instance

Enclosing class:

Option

public class Option.Instance
extends java.lang.Object

An Instance of an Option contains values assigned to an option. Objects of this class make sure they adhere to constraints applied to their related Option.

Constructor Summary

Constructors

Constructor and Description
Instance()

Method Summary

Modifier and Type	Method and Description
Option.Instance	addValue(java.lang.String argument) Adds a value to this option instance.
java.lang.String	getName()
java.lang.String	getValue() Returns the value of an option if it has one, or null if none have been set.
java.lang.String	getValue(int index) Returns the nth value of an option where n is set by the variable index.
java.util.List<java.lang.String>	getValues()
boolean	hasNoValues()

Methods inherited from class java.lang.Object

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

Constructor Detail

Instance

public Instance()

Method Detail

addValue

public Option.Instance addValue(java.lang.String argument)
                         throws java.lang.IllegalArgumentException

Adds a value to this option instance. If the option's value separator is set and this option takes multiple argument, the argument will be separated into one or more values using the value separator.

Parameters:

argument - The value or values to assign to this option instance

Returns:

This option instance

Throws:

java.lang.IllegalArgumentException - If the value cannot be added to the option because the option cannot take more values or because the option doesn't take values at all

getName

public java.lang.String getName()

Returns:

The identity of the option this object is an instance of

See Also:

Option.getId()

getValue

public java.lang.String getValue()

Returns the value of an option if it has one, or null if none have been set. If this option takes multiple values, the first value is returned.

Returns:

This option's value or null if none was set or this option does not take values

getValue

public java.lang.String getValue(int index)
                          throws java.lang.IndexOutOfBoundsException

Returns the nth value of an option where n is set by the variable index. If this option has no values, null is returned. The first value is at index=0

Parameters:

index - The number of the value to return

Returns:

This option's value or null if this option does not take values

Throws:

java.lang.IndexOutOfBoundsException - If this option instance takes values but there is as many as index of them.

getValues

public java.util.List<java.lang.String> getValues()

Returns:

All values this option instance has, or null if this option instance does not take values

hasNoValues

public boolean hasNoValues()

Returns:

true if no values have been set in this option instance. false otherwise.