moapi
Class ModBooleanOption

java.lang.Object
  extended by moapi.ModOption<java.lang.Boolean>
      extended by moapi.ModBooleanOption

public class ModBooleanOption
extends ModOption<java.lang.Boolean>

Boolean Option API

Since:
0.1

Field Summary
 
Fields inherited from class moapi.ModOption
callback, global, localValue, name, value
 
Constructor Summary
ModBooleanOption(java.lang.String name)
          Creates an On/Off toggle
ModBooleanOption(java.lang.String id, java.lang.String name)
          Creates an On/Off toggle with the given ID
ModBooleanOption(java.lang.String name, java.lang.String onVal, java.lang.String offVal)
          Creates an On/Off toggle with specified labels
ModBooleanOption(java.lang.String id, java.lang.String name, java.lang.String onVal, java.lang.String offVal)
          Creates an On/Off toggle with the specified labels and ID
 
Method Summary
 java.lang.String getStringValue(boolean value)
          Returns the string value of boolean based on this option
 
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

ModBooleanOption

public ModBooleanOption(java.lang.String name)
Creates an On/Off toggle

Parameters:
name - Name of this toggle option

ModBooleanOption

public ModBooleanOption(java.lang.String name,
                        java.lang.String onVal,
                        java.lang.String offVal)
Creates an On/Off toggle with specified labels

Parameters:
name - Name of this toggle option
onVal - Value to display when this option is "on"
offVal - Value to display when this option is "off"

ModBooleanOption

public ModBooleanOption(java.lang.String id,
                        java.lang.String name,
                        java.lang.String onVal,
                        java.lang.String offVal)
Creates an On/Off toggle with the specified labels and ID

Parameters:
id - ID for this toggle to use
name - Name of this toggle option
onVal - Value to display when this option is "on"
offVal - Value to display when this option is "off"
Since:
0.8

ModBooleanOption

public ModBooleanOption(java.lang.String id,
                        java.lang.String name)
Creates an On/Off toggle with the given ID

Since:
0.8
Method Detail

getStringValue

public java.lang.String getStringValue(boolean value)
Returns the string value of boolean based on this option

Parameters:
value - Value to get string for
Returns:
String representation