Top Description Methods
org.glassfish.pfl.tf.timer.spi

public Interface Controllable

extends Named
Known Direct Subinterfaces
org.glassfish.pfl.tf.timer.spi.Timer, org.glassfish.pfl.tf.timer.spi.TimerGroup
Known Direct Implementers
org.glassfish.pfl.tf.timer.impl.ControllableBase
Imports
java.util.Set

Represents a named object that can be enabled or disabled. It may also contain other Controllable instances.

Method Summary

Modifier and TypeMethod and Description
public Set<? extends Controllable>
contents()

Return an unmodifiable set of the contents of this Controllable.

public String
description()

A longer description giving some details of the meaning of this Controllable.

public void
disable()

Disable this controllable.

public void
enable()

Enable this controllable.

public int
id()

A small id for this controllable.

public boolean
isEnabled()

Return true if enable() was called, otherwise false if enable() was never called, or disable() was last called.

Inherited from org.glassfish.pfl.tf.timer.spi.Named:
factoryname

Method Detail

contentsback to summary
public Set<? extends Controllable> contents()

Return an unmodifiable set of the contents of this Controllable. May always be empty for some subclasses of Controllable.

descriptionback to summary
public String description()

A longer description giving some details of the meaning of this Controllable.

disableback to summary
public void disable()

Disable this controllable.

enableback to summary
public void enable()

Enable this controllable. All Timers that are either enabled, or reachable via contents() from an enabled Controllable are activated, and will cause TimerEvents to be generated when passed to the TimerEventController enter and exit methods.

idback to summary
public int id()

A small id for this controllable. Each controllable created from the same TimerFactory will have a unique ID. All ids will be small integers starting at 0 (so indexing tables by timer ID is supported).

isEnabledback to summary
public boolean isEnabled()

Return true if enable() was called, otherwise false if enable() was never called, or disable() was last called.