Package org.tailormap.api.scheduling

Class TMJobDataMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.tailormap.api.scheduling.TMJobDataMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class TMJobDataMap
extends HashMap<String,Object>

Define a map with minimally required job data for the TailorMap scheduler.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
TMJobDataMap(@NotNull String type, @NotNull String description)	Create a new instance of TMJobDataMap with a status of Trigger.TriggerState.NONE and a default priority.
TMJobDataMap(@NotNull String type, @NotNull String description, org.quartz.Trigger.TriggerState state)	Create a new instance of TMJobDataMap with default priority.
TMJobDataMap(@NotNull String type, @NotNull String description, org.quartz.Trigger.TriggerState state, int priority)	Create a new instance of TMJobDataMap.
TMJobDataMap(Map<String,Object> map)	Create a new instance of TMJobDataMap.

Method Summary

Modifier and Type	Method	Description
@NotNull String	getDescription()
int	getPriority()
org.quartz.Trigger.TriggerState	getState()
@NotNull String	getType()
void	setPriority(int priority)	Set the priority of the job.
void	setState(org.quartz.Trigger.TriggerState state)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

TMJobDataMap

public TMJobDataMap(Map<String,Object> map)

Create a new instance of TMJobDataMap.

Parameters:

map - the map with job data, must have values for the required parameters type and description

TMJobDataMap

public TMJobDataMap(@NotNull
 @NotNull String type,
 @NotNull
 @NotNull String description)

Create a new instance of TMJobDataMap with a status of Trigger.TriggerState.NONE and a default priority.

Parameters:

type - the type of the job

description - a description of the job

TMJobDataMap

public TMJobDataMap(@NotNull
 @NotNull String type,
 @NotNull
 @NotNull String description,
 @NotNull
 org.quartz.Trigger.TriggerState state)

Create a new instance of TMJobDataMap with default priority.

Parameters:

type - the type of the job

description - a description of the job

state - the state of the job

TMJobDataMap

public TMJobDataMap(@NotNull
 @NotNull String type,
 @NotNull
 @NotNull String description,
 @NotNull
 org.quartz.Trigger.TriggerState state,
 int priority)

Create a new instance of TMJobDataMap.

Parameters:

type - the type of the job

description - a description of the job

state - the state of the job

priority - the priority of the job, an integer value equal or greater than 0

Method Details

getType

@NotNull
public @NotNull String getType()

getDescription

@NotNull
public @NotNull String getDescription()

getState

@NotNull
public org.quartz.Trigger.TriggerState getState()

setState

public void setState(org.quartz.Trigger.TriggerState state)

setPriority

public void setPriority(int priority)

Set the priority of the job. Using this method will ensure that the priority is equal or greater than 0.

Parameters:

priority - the priority of the job, an integer value equal or greater than 0

getPriority

public int getPriority()