net.sf.colossus.common
Interface IOptions

All Known Implementing Classes:
Options

public interface IOptions

Allows getting and setting options. An attempt to reduce the God-class nature of Client.

Author:
David Ripton

Nested Class Summary
static class IOptions.Listener
          A callback interface for changes to the options.
 
Method Summary
 void addListener(java.lang.String optname, IOptions.Listener listener)
          Adds a listener to get callbacks for changes on the specified option.
 int getIntOption(java.lang.String optname)
           
 boolean getOption(java.lang.String optname)
           
 boolean getOption(java.lang.String optname, boolean defaultValue)
           
 java.lang.String getStringOption(java.lang.String optname)
           
 void removeListener(IOptions.Listener listener)
          Removes the listener from all options it is subscribed to.
 void setOption(java.lang.String optname, boolean value)
           
 void setOption(java.lang.String optname, int value)
           
 void setOption(java.lang.String optname, java.lang.String value)
           
 

Method Detail

addListener

void addListener(java.lang.String optname,
                 IOptions.Listener listener)
Adds a listener to get callbacks for changes on the specified option. The listener should be called only on true changes, not if an option gets set to the value it has anyway.


removeListener

void removeListener(IOptions.Listener listener)
Removes the listener from all options it is subscribed to. TODO there is a chance of leakage if classes subscribe to the options but never remove their listeners.


getOption

boolean getOption(java.lang.String optname)

getOption

boolean getOption(java.lang.String optname,
                  boolean defaultValue)

getStringOption

java.lang.String getStringOption(java.lang.String optname)

getIntOption

int getIntOption(java.lang.String optname)

setOption

void setOption(java.lang.String optname,
               java.lang.String value)

setOption

void setOption(java.lang.String optname,
               boolean value)

setOption

void setOption(java.lang.String optname,
               int value)