com.ibm.streams.operator.control.variable

Interface StringControlVariableMXBean

  • All Superinterfaces:
    PersistentControlMBean
    All Known Implementing Classes:
    StringControlVariable

    public interface StringControlVariableMXBean
extends PersistentControlMBean
    MXBean representing a String control variable.
    This MXBean implements PersistentControlMBean to persist its value across Job Control Plane restarts.

    An attribute change notification (javax.management.AttributeChangeNotification) is sent when the value of this control variable changes. The attribute name is Value.

    It is recommended operators use createStringControlVariable instead of manually creating and registering StringControlVariable MBeans. ControlVariableAccessor provides simple support of a String control variable, hiding all the JMX interactions with the Job Control Plane.

    Since:
    InfoSphere® Streams Version 4.0

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getName()
      Get the name of this control variable.
      java.lang.String getValue()
      Get the value of this control variable.
      void setValue(java.lang.String value)
      Set the value of this control variable.

    • Method Detail

      • getName

        java.lang.String getName()
        Get the name of this control variable.
        Returns:
        the name of this control variable

      • getValue

        java.lang.String getValue()
        Get the value of this control variable.
        Returns:
        the value of this control variable.

      • setValue

        void setValue(java.lang.String value)
              throws java.io.IOException
        Set the value of this control variable. If the value changes an AttributeChangeNotification is sent using attribute name Value.
        Parameters:
        value - New value for this control variable.
        Throws:
        java.io.IOException - Exception persisting the control variable in the Job Control Plane.
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method