Package org.glassfish.gmbal.impl

Interface TimerAnnotationHelper.ManagedControllable

All Superinterfaces:
Controllable, Named, TimerAnnotationHelper.ManagedNamed
All Known Subinterfaces:
TimerAnnotationHelper.ManagedTimer, TimerAnnotationHelper.ManagedTimerFactory, TimerAnnotationHelper.ManagedTimerGroup
Enclosing class:
TimerAnnotationHelper
@ManagedObject @IncludeSubclass({Timer.class,TimerGroup.class,TimerFactory.class}) public static interface TimerAnnotationHelper.ManagedControllable extends Controllable, TimerAnnotationHelper.ManagedNamed

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<? extends Controllable>
    contents()
    Return an unmodifiable set of the contents of this Controllable.
    String
    description()
    A longer description giving some details of the meaning of this Controllable.
    void
    disable()
    Disable this controllable.
    void
    enable()
    Enable this controllable.
    int
    id()
    A small id for this controllable.
    boolean
    isEnabled()
    Return true if enable() was called, otherwise false if enable() was never called, or disable() was last called.

    Methods inherited from interface org.glassfish.gmbal.impl.TimerAnnotationHelper.ManagedNamed

    factory, name

  • Method Details

    • description

      @ManagedAttribute @Description("The purpose of the Timer or TimerGroup") String description()
      Description copied from interface: Controllable
      A longer description giving some details of the meaning of this Controllable.
      Specified by:
      description in interface Controllable

    • id

      @ManagedAttribute @Description("An internal identifier for the Timer or TimerGroup") int id()
      Description copied from interface: Controllable
      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).
      Specified by:
      id in interface Controllable

    • contents

      @ManagedAttribute @Description("Set of Timers or TimerGroups contained in a TimerGroup") Set<? extends Controllable> contents()
      Description copied from interface: Controllable
      Return an unmodifiable set of the contents of this Controllable. May always be empty for some subclasses of Controllable.
      Specified by:
      contents in interface Controllable

    • enable

      @ManagedOperation @Description("Enable this Timer, or all Timers and TimerGroups contained in this TimerGroup") void enable()
      Description copied from interface: Controllable
      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.
      Specified by:
      enable in interface Controllable

    • disable

      @ManagedOperation @Description("Disable this Timer, or all Timers and TimerGroups contained in this TimerGroup") void disable()
      Description copied from interface: Controllable
      Disable this controllable.
      Specified by:
      disable in interface Controllable

    • isEnabled

      @ManagedOperation @Description("True if this Timer or TimerGroup is enabled") boolean isEnabled()
      Description copied from interface: Controllable
      Return true if enable() was called, otherwise false if enable() was never called, or disable() was last called.
      Specified by:
      isEnabled in interface Controllable