org.hawkular.metrics.scheduler.api

Interface JobParameters

All Known Implementing Classes:

JobParametersImpl

public interface JobParameters

Provides a map-like key/value API for job parameters. The parameters are mutable. Changes will be persisted after job execution completes (for repeating jobs). Changes can also be persisted during execution using the save method.

Author:

jsanda

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key) Return true if the parameters contain a value for the key
String	get(String key) Return the value associated with the key or null if there is no such parameter
Map<String,String>	getMap() Return an immutable map of the parameters.
String	put(String key, String value) Associates the value with the key and returns the old value if there previously was a mapping for the key
String	remove(String key) Removes the value associated with the key or null if there is no such parameter
rx.Completable	save() Asynchronously save the parameters back to Cassandra.

Method Detail

get

String get(String key)

Return the value associated with the key or null if there is no such parameter

put

String put(String key,
           String value)

Associates the value with the key and returns the old value if there previously was a mapping for the key

remove

String remove(String key)

Removes the value associated with the key or null if there is no such parameter

containsKey

boolean containsKey(String key)

Return true if the parameters contain a value for the key

getMap

Map<String,String> getMap()

Return an immutable map of the parameters. Note that this map is a copy. Any changes made to the parameters through methods like get or put will not be reflected in this map.

save

rx.Completable save()

Asynchronously save the parameters back to Cassandra. For reoccurring jobs any changes to parameters will automatically be persisted when the job finishes and is rescheduled for its next run. This method can be useful for long running jobs that perform a lot of work. It can be used to create checkpoints so that if a job is abruptly stopped and restarted it can resume its work from that checkpoint rather than starting all over.