com.ryanm.logging
Class StringSink.StringSinkConfigurator

java.lang.Object
  com.ryanm.config.imp.AbstractConfigurator
      com.ryanm.logging.StringSink.StringSinkConfigurator

All Implemented Interfaces:

Configurator, SourceRegistrationListener

Enclosing class:

StringSink

protected class StringSink.StringSinkConfigurator
extends AbstractConfigurator
implements SourceRegistrationListener

Configurator for variables common to all LogSinks that produce String-based output

Author:

ryanm

Field Summary

Fields inherited from interface com.ryanm.config.Configurator

ACTION_TYPE, BOOLEAN_TYPE, COLOUR_TYPE, FILE_TYPE, FLOAT_TYPE, INT_TYPE, STRING_LIST_TYPE, STRING_TYPE, VECTOR_TYPE

Constructor Summary

protected

StringSink.StringSinkConfigurator(java.lang.String title) Constructs a new StringSink.StringSinkConfigurator

Method Summary

protected void	applyValue(java.lang.String name, java.lang.Object value) This should be overridden to actually apply the new value
void	deregistered(java.lang.String oldSource) Called when a source is removed from the LoggingManager
void	registered(java.lang.String newSource) Called when a source is registered with the LoggingManager
java.lang.Object	retrieveValue(java.lang.String name) Get the current value of the named variable

Methods inherited from class com.ryanm.config.imp.AbstractConfigurator

addConfiguratorListener, addValueListener, addVariable, addVariable, buildPaths, copyValues, getDescription, getDescription, getName, getNames, getParent, getPath, getRange, getType, getValue, isGUIEnabled, pathsBuilt, removeConfiguratorListener, removeValueListener, removeVariable, setDescription, setGUIEnabled, setRange, setType, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringSink.StringSinkConfigurator

protected StringSink.StringSinkConfigurator(java.lang.String title)

Constructs a new StringSink.StringSinkConfigurator

Parameters:

title - The name of the LogSink

Method Detail

applyValue

protected void applyValue(java.lang.String name,
                          java.lang.Object value)

Description copied from class: AbstractConfigurator

This should be overridden to actually apply the new value

Specified by:

applyValue in class AbstractConfigurator

Parameters:

name - The name of the variable to change

value - The new value of that variable

retrieveValue

public java.lang.Object retrieveValue(java.lang.String name)

Description copied from class: AbstractConfigurator

Get the current value of the named variable

Specified by:

retrieveValue in class AbstractConfigurator

Parameters:

name - The name of the variable

Returns:

The value of the variable

deregistered

public void deregistered(java.lang.String oldSource)

Description copied from interface: SourceRegistrationListener

Called when a source is removed from the LoggingManager

Specified by:

deregistered in interface SourceRegistrationListener

Parameters:

oldSource - the removed source

registered

public void registered(java.lang.String newSource)

Description copied from interface: SourceRegistrationListener

Called when a source is registered with the LoggingManager

Specified by:

registered in interface SourceRegistrationListener

Parameters:

newSource - The added source