com.ibm.rational.test.lt.recorder.core.session

Enum RecorderState

  • All Implemented Interfaces:
    com.ibm.rational.test.lt.recorder.core.internal.session.IRecorderComponentState, Serializable, Comparable<RecorderState>


    public enum RecorderState
    extends Enum<RecorderState>
    implements com.ibm.rational.test.lt.recorder.core.internal.session.IRecorderComponentState
    The states of a IRecorder.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      INITIAL
      The recorder has not been started yet.
      PAUSED
      The recorder is running, but not capturing traffic (or capturing a reduced traffic if the protocol nature is stateful).
      RECORDING
      The recorder is running and capturing traffic.
      STARTING
      The recorder has been asked to start, but is not ready yet to capture traffic.
      STOPPING
      The recorder has been asked to stop, but has not stopped yet.
      TERMINATED
      The recorder has terminated.
    • Enum Constant Detail

      • INITIAL

        public static final RecorderState INITIAL
        The recorder has not been started yet. This is the initial state of a recorder. A recorder cannot go back to this state once it has been started.
      • STARTING

        public static final RecorderState STARTING
        The recorder has been asked to start, but is not ready yet to capture traffic.
      • RECORDING

        public static final RecorderState RECORDING
        The recorder is running and capturing traffic.
      • PAUSED

        public static final RecorderState PAUSED
        The recorder is running, but not capturing traffic (or capturing a reduced traffic if the protocol nature is stateful).
      • STOPPING

        public static final RecorderState STOPPING
        The recorder has been asked to stop, but has not stopped yet.
      • TERMINATED

        public static final RecorderState TERMINATED
        The recorder has terminated. This is the final state.
    • Method Detail

      • values

        public static RecorderState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (RecorderState c : RecorderState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static RecorderState valueOf(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getLabel

        public String getLabel()
        Returns a localized label for the state (can be displayed to the user).
        Returns:
        a localized label for the state.
      • isActive

        public boolean isActive()
        Returns whether the recorder is an active state (i.e. recording or paused).
        Returns:
        whether the recorder is an active state
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.