JobDataMap (Quartz Enterprise Job Scheduler 2.3.1 API)

java.lang.Object
- org.quartz.utils.DirtyFlagMap<String,Object>
- - org.quartz.utils.StringKeyDirtyFlagMap
  - - org.quartz.JobDataMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>
```
public class JobDataMap
extends StringKeyDirtyFlagMap
implements Serializable
```
Holds state information for Job instances.
JobDataMap instances are stored once when the Job is added to a scheduler. They are also re-persisted after every execution of jobs annotated with @PersistJobDataAfterExecution.

JobDataMap instances can also be stored with a Trigger. This can be useful in the case where you have a Job that is stored in the scheduler for regular/repeated use by multiple Triggers, yet with each independent triggering, you want to supply the Job with different data inputs.

The JobExecutionContext passed to a Job at execution time also contains a convenience JobDataMap that is the result of merging the contents of the trigger's JobDataMap (if any) over the Job's JobDataMap (if any).

Update since 2.2.4 - We keep an dirty flag for this map so that whenever you modify(add/delete) any of the entries, it will set to "true". However if you create new instance using an exising map with JobDataMap(Map), then the dirty flag will NOT be set to "true" until you modify the instance.

Author:

James House

See Also:
Job, PersistJobDataAfterExecution, Trigger, JobExecutionContext, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

JobDataMap()
Create an empty JobDataMap.

JobDataMap(Map<?,?> map)
Create a JobDataMap with the given data.

Constructors
Constructor and Description
`JobDataMap()` Create an empty `JobDataMap`.
`JobDataMap(Map<?,?> map)` Create a `JobDataMap` with the given data.

Method Summary

Methods
Modifier and Type	Method and Description
`Boolean`	`getBooleanFromString(String key)` Retrieve the identified `Boolean` value from the `JobDataMap`.
`boolean`	`getBooleanValue(String key)` Retrieve the identified `boolean` value from the `JobDataMap`.
`boolean`	`getBooleanValueFromString(String key)` Retrieve the identified `boolean` value from the `JobDataMap`.
`Character`	`getCharacterFromString(String key)` Retrieve the identified `Character` value from the `JobDataMap`.
`char`	`getCharFromString(String key)` Retrieve the identified `char` value from the `JobDataMap`.
`Double`	`getDoubleFromString(String key)` Retrieve the identified `Double` value from the `JobDataMap`.
`double`	`getDoubleValue(String key)` Retrieve the identified `double` value from the `JobDataMap`.
`double`	`getDoubleValueFromString(String key)` Retrieve the identified `double` value from the `JobDataMap`.
`Float`	`getFloatFromString(String key)` Retrieve the identified `Float` value from the `JobDataMap`.
`float`	`getFloatValue(String key)` Retrieve the identified `float` value from the `JobDataMap`.
`float`	`getFloatValueFromString(String key)` Retrieve the identified `float` value from the `JobDataMap`.
`Integer`	`getIntegerFromString(String key)` Retrieve the identified `int` value from the `JobDataMap`.
`int`	`getIntFromString(String key)` Retrieve the identified `int` value from the `JobDataMap`.
`int`	`getIntValue(String key)` Retrieve the identified `int` value from the `JobDataMap`.
`Long`	`getLongFromString(String key)` Retrieve the identified `Long` value from the `JobDataMap`.
`long`	`getLongValue(String key)` Retrieve the identified `long` value from the `JobDataMap`.
`long`	`getLongValueFromString(String key)` Retrieve the identified `long` value from the `JobDataMap`.
`void`	`putAsString(String key, boolean value)` Adds the given `boolean` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, Boolean value)` Adds the given `Boolean` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, char value)` Adds the given `char` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, Character value)` Adds the given `Character` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, double value)` Adds the given `double` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, Double value)` Adds the given `Double` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, float value)` Adds the given `float` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, Float value)` Adds the given `Float` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, int value)` Adds the given `int` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, Integer value)` Adds the given `Integer` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, long value)` Adds the given `long` value as a string version to the `Job`'s data map.
`void`	`putAsString(String key, Long value)` Adds the given `Long` value as a string version to the `Job`'s data map.

Methods inherited from class org.quartz.utils.StringKeyDirtyFlagMap
containsTransientData, equals, getAllowsTransientData, getBoolean, getChar, getDouble, getFloat, getInt, getKeys, getLong, getString, hashCode, put, put, put, put, put, put, put, put, removeTransientData, setAllowsTransientData

Methods inherited from class org.quartz.utils.DirtyFlagMap
clear, clearDirtyFlag, clone, containsKey, containsValue, entrySet, get, getWrappedMap, isDirty, isEmpty, keySet, putAll, remove, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JobDataMap
```
public JobDataMap()
```
    Create an empty JobDataMap.
  - JobDataMap
```
public JobDataMap(Map<?,?> map)
```
    Create a JobDataMap with the given data.
- Method Detail
  - putAsString
```
public void putAsString(String key,
               boolean value)
```
    Adds the given boolean value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               Boolean value)
```
    Adds the given Boolean value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               char value)
```
    Adds the given char value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               Character value)
```
    Adds the given Character value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               double value)
```
    Adds the given double value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               Double value)
```
    Adds the given Double value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               float value)
```
    Adds the given float value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               Float value)
```
    Adds the given Float value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               int value)
```
    Adds the given int value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               Integer value)
```
    Adds the given Integer value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               long value)
```
    Adds the given long value as a string version to the Job's data map.
  - putAsString
```
public void putAsString(String key,
               Long value)
```
    Adds the given Long value as a string version to the Job's data map.
  - getIntFromString
```
public int getIntFromString(String key)
```
    Retrieve the identified int value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getIntValue
```
public int getIntValue(String key)
```
    Retrieve the identified int value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String or Integer.
  - getIntegerFromString
```
public Integer getIntegerFromString(String key)
```
    Retrieve the identified int value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getBooleanValueFromString
```
public boolean getBooleanValueFromString(String key)
```
    Retrieve the identified boolean value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getBooleanValue
```
public boolean getBooleanValue(String key)
```
    Retrieve the identified boolean value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String or Boolean.
  - getBooleanFromString
```
public Boolean getBooleanFromString(String key)
```
    Retrieve the identified Boolean value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getCharFromString
```
public char getCharFromString(String key)
```
    Retrieve the identified char value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getCharacterFromString
```
public Character getCharacterFromString(String key)
```
    Retrieve the identified Character value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getDoubleValueFromString
```
public double getDoubleValueFromString(String key)
```
    Retrieve the identified double value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getDoubleValue
```
public double getDoubleValue(String key)
```
    Retrieve the identified double value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String or Double.
  - getDoubleFromString
```
public Double getDoubleFromString(String key)
```
    Retrieve the identified Double value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getFloatValueFromString
```
public float getFloatValueFromString(String key)
```
    Retrieve the identified float value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getFloatValue
```
public float getFloatValue(String key)
```
    Retrieve the identified float value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String or Float.
  - getFloatFromString
```
public Float getFloatFromString(String key)
```
    Retrieve the identified Float value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getLongValueFromString
```
public long getLongValueFromString(String key)
```
    Retrieve the identified long value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.
  - getLongValue
```
public long getLongValue(String key)
```
    Retrieve the identified long value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String or Long.
  - getLongFromString
```
public Long getLongFromString(String key)
```
    Retrieve the identified Long value from the JobDataMap.
    
    Throws:
    
    ClassCastException - if the identified object is not a String.

Class JobDataMap

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.quartz.utils.StringKeyDirtyFlagMap

Methods inherited from class org.quartz.utils.DirtyFlagMap

Methods inherited from class java.lang.Object

Constructor Detail

JobDataMap

JobDataMap

Method Detail

putAsString

putAsString

putAsString

putAsString

putAsString

putAsString

putAsString

putAsString

putAsString

putAsString

putAsString

putAsString

getIntFromString

getIntValue

getIntegerFromString

getBooleanValueFromString

getBooleanValue

getBooleanFromString

getCharFromString

getCharacterFromString

getDoubleValueFromString

getDoubleValue

getDoubleFromString

getFloatValueFromString

getFloatValue

getFloatFromString

getLongValueFromString

getLongValue

getLongFromString