BooleanControlVariableMXBean (IBM InfoSphere Streams Java Operator API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

PersistentControlMBean

All Known Implementing Classes:

BooleanControlVariable
```
public interface BooleanControlVariableMXBean
extends PersistentControlMBean
```
MXBean representing a boolean 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 createBooleanControlVariable instead of manually creating and registering BooleanControlVariable MBeans. ControlVariableAccessor provides simple support of a double 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.
`boolean`	`getValue()` Get the value of this control variable.
`void`	`off()` Set this control variable to `false`.
`void`	`on()` Set this control variable to `true`.
`void`	`setValue(boolean value)` Set the value of this control variable.

Methods inherited from interface com.ibm.streams.operator.control.PersistentControlMBean
setupComplete, updateControlState

- Method Detail
  - getValue
```
boolean getValue()
```
    Get the value of this control variable.
    
    Returns:
    the value of this control variable.
  - on
```
void on()
        throws java.io.IOException
```
    Set this control variable to true.
    
    Throws:
    
    java.io.IOException - Exception persisting the control variable in the Job Control Plane.
  - off
```
void off()
         throws java.io.IOException
```
    Set this control variable to false.
    
    Throws:
    
    java.io.IOException - Exception persisting the control variable in the Job Control Plane.
  - setValue
```
void setValue(boolean 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.
  - getName
```
java.lang.String getName()
```
    Get the name of this control variable.
    
    Returns:
    the name of this control variable