org.apache.reef.runtime.common.driver.idle

Class IdleMessage

java.lang.Object

org.apache.reef.runtime.common.driver.idle.IdleMessage

public final class IdleMessage
extends Object

A message to be used to indicate that the driver is potentially idle.

Constructor Summary

Constructors

Constructor and Description
IdleMessage(String componentName, String reason, boolean isIdle)

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentName()
String	getReason()
boolean	isIdle()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdleMessage

public IdleMessage(String componentName,
           String reason,
           boolean isIdle)

Parameters:

componentName - the name of the component that is indicating (not) idle, e.g. "Clock"

reason - the human-readable reason the component indicates (not) idle, "No more alarms scheduled."

isIdle - whether or not the component is idle.

Method Detail

getComponentName

public String getComponentName()

Returns:

the name of the component that indicated (not) idle.

getReason

public String getReason()

Returns:

the reason for (no) idleness

isIdle

public boolean isIdle()

Returns:

true if this message indicates idle.