Cytoscape 3.0.0-beta1 API

org.cytoscape.work
Interface TunableRecorder<T extends TunableHandler>

Type Parameters:
T - The generic TunableHandler type of this TunableRecorder.

public interface TunableRecorder<T extends TunableHandler>

TunableRecorder is a special type of tunable interceptor that reads the state of the tunables but does not modify the value of the tunables.
When implementing this interface, it is recommended that you use the AbstractTunableInterceptor class to do so.


Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary
 void recordTunableState(Object objs)
          The method called for each tunable object processed by a TaskManager.
 

Method Detail

recordTunableState

void recordTunableState(Object objs)
The method called for each tunable object processed by a TaskManager. This method may observe and record the state of tunables associated with the argument object, but may NOT modify the tunable values.

Parameters:
objs - The object containing fields and methods annotated with the Tunable annotation.

Cytoscape 3.0.0-beta1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.