Package org.openhab.core.service

Class ReadyMarker

java.lang.Object

org.openhab.core.service.ReadyMarker

@NonNullByDefault
public final class ReadyMarker
extends Object

This is a token, identifying something to be completed. A caller may use it to identify which action or process is completed or to which completion it wants to listen to. Thereby the type denotes the category of readyness, the identifier, e.g. new ReadyMarker("xmlProcessing", "org.openhab.binding.sample") would denote that the "sample binding" has finished processing some XML files.

When the action or process is being marked as "ready" or removed from the "ready" state, a registered tracker will be notified by the ReadyService.

This class overrides hashCode() and equals(Object) so that any using class does not have to keep original references, but new instances can be used for calls to the ReadyService every time.

Author:

Simon Kaufmann - Initial contribution

Constructor Summary

Constructors

Constructor	Description
ReadyMarker(String type, String identifier)

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
String	getIdentifier()
String	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ReadyMarker

public ReadyMarker(String type,
 String identifier)

Method Details

getType

public String getType()

getIdentifier

public String getIdentifier()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object