Interface Activity

All Superinterfaces:
ActivityDefObserver, AutoCloseable, Comparable<Activity>, NBComponent, NBComponentAdvisors, NBComponentEvents, NBComponentMetrics, NBComponentProps, NBComponentServices, NBLabeledElement, NBProviderSearch, ProgressCapable, StateCapable
All Known Implementing Classes:
SimpleActivity, StandardActivity
public interface Activity extends Comparable<Activity>, ActivityDefObserver, ProgressCapable, StateCapable, NBComponent
Provides the components needed to build and run an activity a runtime. The easiest way to build a useful Activity is to extend SimpleActivity.

  • Method Details

    • registerAutoCloseable

      void registerAutoCloseable(AutoCloseable closeable)
      Register an object which should be closed after this activity is shutdown.
      Parameters:
      closeable - An Autocloseable object

    • getActivityDef

      ActivityDef getActivityDef()

    • getAlias

      default String getAlias()

    • getParams

      default ParameterMap getParams()

    • initActivity

      default void initActivity()

    • closeAutoCloseables

      void closeAutoCloseables()
      Close all autocloseables that have been registered with this Activity.

    • getMotorDispenserDelegate

      MotorDispenser<?> getMotorDispenserDelegate()

    • setMotorDispenserDelegate

      void setMotorDispenserDelegate(MotorDispenser<?> motorDispenser)

    • getInputDispenserDelegate

      InputDispenser getInputDispenserDelegate()

    • setInputDispenserDelegate

      void setInputDispenserDelegate(InputDispenser inputDispenser)

    • getActionDispenserDelegate

      ActionDispenser getActionDispenserDelegate()

    • setActionDispenserDelegate

      void setActionDispenserDelegate(ActionDispenser actionDispenser)

    • getResultFilterDispenserDelegate

      IntPredicateDispenser getResultFilterDispenserDelegate()

    • setResultFilterDispenserDelegate

      void setResultFilterDispenserDelegate(IntPredicateDispenser resultFilterDispenser)

    • getMarkerDispenserDelegate

      OutputDispenser getMarkerDispenserDelegate()

    • setOutputDispenserDelegate

      void setOutputDispenserDelegate(OutputDispenser outputDispenser)

    • getRunState

      RunState getRunState()
      Specified by:
      getRunState in interface StateCapable

    • setRunState

      void setRunState(RunState runState)

    • getStartedAtMillis

      long getStartedAtMillis()

    • shutdownActivity

      default void shutdownActivity()

    • getCycleSummary

      default String getCycleSummary()

    • getCycleLimiter

      RateLimiter getCycleLimiter()
      Get the current cycle rate limiter for this activity. The cycle rate limiter is used to throttle the rate at which cycles are dispatched across all threads in the activity
      Returns:
      the cycle RateLimiter

    • getStrideLimiter

      RateLimiter getStrideLimiter()
      Get the current stride rate limiter for this activity. The stride rate limiter is used to throttle the rate at which new strides are dispatched across all threads in an activity.
      Returns:
      The stride RateLimiter

    • getInstrumentation

      ActivityInstrumentation getInstrumentation()
      Get or create the instrumentation needed for this activity. This provides a single place to find and manage, and document instrumentation that is uniform across all activities.
      Returns:
      A new or existing instrumentation object for this activity.

    • getConsoleOut

      PrintWriter getConsoleOut()

    • getConsoleIn

      InputStream getConsoleIn()

    • setConsoleOut

      void setConsoleOut(PrintWriter writer)

    • getExceptionMetrics

      ErrorMetrics getExceptionMetrics()

    • getMaxTries

      int getMaxTries()

    • getHdrDigits

      default int getHdrDigits()

    • getRunStateTally

      RunStateTally getRunStateTally()