com.speckled.specksim.imp.filter
Class LeaderFilter

java.lang.Object
  com.speckled.specksim.state.StateFilter
      com.speckled.specksim.imp.filter.LeaderFilter

All Implemented Interfaces:

Configurable

public class LeaderFilter
extends StateFilter
implements Configurable

Filters based on the leader id

Author:

ryanm

Field Summary

Fields inherited from class com.speckled.specksim.state.StateFilter

stateSink

Constructor Summary

LeaderFilter()

Method Summary

Configurator	getConfigurator() Gets a Configurator object that describes and can manipulate the variables of this Configurable.
boolean	included(int index) Checks whether or not the entry in the state object with the given index should be included.

Methods inherited from class com.speckled.specksim.state.StateFilter

getName, isEnabled, refreshStateListeners, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

LeaderFilter

public LeaderFilter()

Method Detail

included

public boolean included(int index)

Description copied from class: StateFilter

Checks whether or not the entry in the state object with the given index should be included.

Specified by:

included in class StateFilter

Parameters:

index - The index of the element

Returns:

True if the element should be included, false otherwise

getConfigurator

public Configurator getConfigurator()

Description copied from interface: Configurable

Gets a Configurator object that describes and can manipulate the variables of this Configurable. This method must only return null if the Configurable object is Annotated such that an AnnotatedConfigurator can be built from it.

Specified by:

getConfigurator in interface Configurable

Returns:

A configurator object, or null if annotated