moapi
Class ModMappedOption

java.lang.Object
  extended by moapi.ModOption<java.lang.Integer>
      extended by moapi.ModMappedOption

public class ModMappedOption
extends ModOption<java.lang.Integer>

Multiple Selector API with Integer -> String mappings

Since:
0.7

Field Summary
 
Fields inherited from class moapi.ModOption
callback, global, localValue, name, value
 
Constructor Summary
ModMappedOption(java.lang.String name)
          Create a multiple selector with no values
ModMappedOption(java.lang.String name, int[] keys, java.lang.String[] labels)
          Create a multiple selector with the given keys and labels
ModMappedOption(java.lang.String name, java.lang.Integer[] keys, java.lang.String[] labels)
          Create a multiple selector with the given keys and labels
ModMappedOption(java.lang.String id, java.lang.String name)
          Creates a multi selector with the given name/ id and no values
ModMappedOption(java.lang.String id, java.lang.String name, int[] keys, java.lang.String[] labels)
          Create a multiple selector with the given keys and labels
ModMappedOption(java.lang.String id, java.lang.String name, java.lang.Integer[] keys, java.lang.String[] labels)
          Create a multiple selector with the given keys and labels and ID/name
 
Method Summary
 void addValue(java.lang.Integer key, java.lang.String value)
          Add a single value to this selector
 void addValue(int intKey, java.lang.String value)
          Add a single value to this selector
 java.lang.Integer getNextValue(int i)
          Gets the next value in this selector
 java.lang.Integer getNextValue(java.lang.Integer i)
          Gets the next value in this selector
 java.lang.String getStringValue(int key)
          Gets the string representation
 java.lang.String getStringValue(java.lang.Integer key)
          Gets the string representation
 
Methods inherited from class moapi.ModOption
getCallback, getGlobalValue, getID, getLocalValue, getName, getValue, getValue, hasCallback, setCallback, setGlobal, setGlobalValue, setLocalValue, setName, setValue, setValue, useGlobalValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ModMappedOption

public ModMappedOption(java.lang.String name)
Create a multiple selector with no values

Parameters:
name - Name of selector

ModMappedOption

public ModMappedOption(java.lang.String name,
                       java.lang.Integer[] keys,
                       java.lang.String[] labels)
Create a multiple selector with the given keys and labels

Parameters:
name - Name of selector
keys - Values for the selector
labels - Labels for values
Throws:
java.lang.IndexOutOfBoundsException - Thrown when keys and labels differ in length

ModMappedOption

public ModMappedOption(java.lang.String name,
                       int[] keys,
                       java.lang.String[] labels)
Create a multiple selector with the given keys and labels

Parameters:
name - Name of selector
keys - Values for the selector
labels - Labels for values
Throws:
java.lang.IndexOutOfBoundsException - Thrown when keys and labels differ in length

ModMappedOption

public ModMappedOption(java.lang.String id,
                       java.lang.String name,
                       java.lang.Integer[] keys,
                       java.lang.String[] labels)
Create a multiple selector with the given keys and labels and ID/name

Parameters:
id - ID of selector
name - Name of selector
keys - Values for the selector
labels - Labels for values
Throws:
java.lang.IndexOutOfBoundsException - Thrown when keys and labels differ in length
Since:
0.8

ModMappedOption

public ModMappedOption(java.lang.String id,
                       java.lang.String name,
                       int[] keys,
                       java.lang.String[] labels)
Create a multiple selector with the given keys and labels

Parameters:
name - Name of selector
keys - Values for the selector
labels - Labels for values
Throws:
java.lang.IndexOutOfBoundsException - Thrown when keys and labels differ in length
Since:
0.8

ModMappedOption

public ModMappedOption(java.lang.String id,
                       java.lang.String name)
Creates a multi selector with the given name/ id and no values

Parameters:
id - ID of this option
name - Name of this option
Since:
0.8
Method Detail

addValue

public void addValue(java.lang.Integer key,
                     java.lang.String value)
Add a single value to this selector

Parameters:
key - Key to add value to
value - Value to add

addValue

public void addValue(int intKey,
                     java.lang.String value)
Add a single value to this selector

Parameters:
intKey - Key to add value to
value - Value to add

getStringValue

public java.lang.String getStringValue(java.lang.Integer key)
Gets the string representation

Parameters:
key - Key to get string rep of
Returns:
String representation of a value

getStringValue

public java.lang.String getStringValue(int key)
Gets the string representation

Parameters:
key - Key to get string rep of
Returns:
String representation of a value

getNextValue

public java.lang.Integer getNextValue(java.lang.Integer i)
Gets the next value in this selector

Parameters:
i - Current value
Returns:
Next value

getNextValue

public java.lang.Integer getNextValue(int i)
Gets the next value in this selector

Parameters:
i - Current value
Returns:
Next value