|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.quartz.utils.DirtyFlagMap
org.quartz.JobDataMap
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
StatefulJob
instances.
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).
Job
,
StatefulJob
,
Trigger
,
JobExecutionContext
,
Serialized FormNested Class Summary |
Nested classes inherited from class java.util.Map |
Map.Entry |
Constructor Summary | |
JobDataMap()
Create an empty JobDataMap . |
|
JobDataMap(Map map)
Create a JobDataMap with the given data. |
Method Summary | |
boolean |
containsTransientData()
|
boolean |
getAllowsTransientData()
|
boolean |
getBoolean(String key)
Retrieve the identified boolean value from the JobDataMap . |
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 . |
char |
getChar(String key)
Retrieve the identified char 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 |
getDouble(String key)
Retrieve the identified double 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 |
getFloat(String key)
Retrieve the identified float 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 . |
int |
getInt(String key)
Retrieve the identified int 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 . |
long |
getIntValue(String key)
Retrieve the identified int value from the JobDataMap . |
String[] |
getKeys()
|
long |
getLong(String key)
Retrieve the identified long 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 . |
String |
getString(String key)
Retrieve the identified String value from the JobDataMap . |
Object |
put(Object key,
Object value)
Adds the given Serializable object value to the JobDataMap . |
void |
put(String key,
boolean value)
Adds the given boolean value to the Job 's
data map. |
void |
put(String key,
char value)
Adds the given char value to the Job 's
data map. |
void |
put(String key,
double value)
Adds the given double value to the Job 's
data map. |
void |
put(String key,
float value)
Adds the given float value to the Job 's
data map. |
void |
put(String key,
int value)
Adds the given int value to the Job 's
data map. |
void |
put(String key,
long value)
Adds the given long value to the Job 's
data map. |
void |
put(String key,
String value)
Adds the given String value to the Job 's
data map. |
void |
putAll(Map map)
Adds the name-value pairs in the given Map to 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. |
void |
removeTransientData()
Nulls-out any data values that are non-Serializable. |
void |
setAllowsTransientData(boolean allowsTransientData)
Tell the JobDataMap that it should allow non- Serializable
data. |
Methods inherited from class org.quartz.utils.DirtyFlagMap |
clear, clearDirtyFlag, clone, containsKey, containsValue, entrySet, equals, get, getWrappedMap, isDirty, isEmpty, isMutable, keySet, remove, setMutable, size, values |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.util.Map |
hashCode |
Constructor Detail |
public JobDataMap()
Create an empty JobDataMap
.
public JobDataMap(Map map)
Create a JobDataMap
with the given data.
Method Detail |
public void setAllowsTransientData(boolean allowsTransientData)
Tell the JobDataMap
that it should allow non- Serializable
data.
If the JobDataMap
does contain non- Serializable
objects, and it belongs to a non-volatile Job
that is
stored in a JobStore
that supports persistence, then
those elements will be nulled-out during persistence.
public boolean getAllowsTransientData()
public boolean containsTransientData()
public void removeTransientData()
Nulls-out any data values that are non-Serializable.
public void putAll(Map map)
Adds the name-value pairs in the given Map
to the JobDataMap
.
All keys must be String
s, and all values must be Serializable
.
putAll
in interface Map
putAll
in class DirtyFlagMap
public void put(String key, int value)
Adds the given int
value to the Job
's
data map.
public void put(String key, long value)
Adds the given long
value to the Job
's
data map.
public void put(String key, float value)
Adds the given float
value to the Job
's
data map.
public void put(String key, double value)
Adds the given double
value to the Job
's
data map.
public void put(String key, boolean value)
Adds the given boolean
value to the Job
's
data map.
public void put(String key, char value)
Adds the given char
value to the Job
's
data map.
public void put(String key, String value)
Adds the given String
value to the Job
's
data map.
public void putAsString(String key, boolean value)
Adds the given boolean
value as a string version to the
Job
's data map.
public void putAsString(String key, Boolean value)
Adds the given Boolean
value as a string version to the
Job
's data map.
public void putAsString(String key, char value)
Adds the given char
value as a string version to the
Job
's data map.
public void putAsString(String key, Character value)
Adds the given Character
value as a string version to the
Job
's data map.
public void putAsString(String key, double value)
Adds the given double
value as a string version to the
Job
's data map.
public void putAsString(String key, Double value)
Adds the given Double
value as a string version to the
Job
's data map.
public void putAsString(String key, float value)
Adds the given float
value as a string version to the
Job
's data map.
public void putAsString(String key, Float value)
Adds the given Float
value as a string version to the
Job
's data map.
public void putAsString(String key, int value)
Adds the given int
value as a string version to the
Job
's data map.
public void putAsString(String key, Integer value)
Adds the given Integer
value as a string version to the
Job
's data map.
public void putAsString(String key, long value)
Adds the given long
value as a string version to the
Job
's data map.
public void putAsString(String key, Long value)
Adds the given Long
value as a string version to the
Job
's data map.
public Object put(Object key, Object value)
Adds the given Serializable
object value to the JobDataMap
.
put
in interface Map
put
in class DirtyFlagMap
public int getInt(String key)
Retrieve the identified int
value from the JobDataMap
.
ClassCastException
- if the identified object is not an Integer.public long getLong(String key)
Retrieve the identified long
value from the JobDataMap
.
ClassCastException
- if the identified object is not a Long.public float getFloat(String key)
Retrieve the identified float
value from the JobDataMap
.
ClassCastException
- if the identified object is not a Float.public double getDouble(String key)
Retrieve the identified double
value from the JobDataMap
.
ClassCastException
- if the identified object is not a Double.public boolean getBoolean(String key)
Retrieve the identified boolean
value from the JobDataMap
.
ClassCastException
- if the identified object is not a Boolean.public char getChar(String key)
Retrieve the identified char
value from the JobDataMap
.
ClassCastException
- if the identified object is not a Character.public String getString(String key)
Retrieve the identified String
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public int getIntFromString(String key)
Retrieve the identified int
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public long getIntValue(String key)
Retrieve the identified int
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String or Integeger.public Integer getIntegerFromString(String key)
Retrieve the identified int
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public boolean getBooleanValueFromString(String key)
Retrieve the identified boolean
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public boolean getBooleanValue(String key)
Retrieve the identified boolean
value from the
JobDataMap
.
ClassCastException
- if the identified object is not a String or Boolean.public Boolean getBooleanFromString(String key)
Retrieve the identified Boolean
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public char getCharFromString(String key)
Retrieve the identified char
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public Character getCharacterFromString(String key)
Retrieve the identified Character
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public double getDoubleValueFromString(String key)
Retrieve the identified double
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public double getDoubleValue(String key)
Retrieve the identified double
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String or Double.public Double getDoubleFromString(String key)
Retrieve the identified Double
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public float getFloatValueFromString(String key)
Retrieve the identified float
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public float getFloatValue(String key)
Retrieve the identified float
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String or Float.public Float getFloatFromString(String key)
Retrieve the identified Float
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public long getLongValueFromString(String key)
Retrieve the identified long
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public long getLongValue(String key)
Retrieve the identified long
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String or Long.public Long getLongFromString(String key)
Retrieve the identified Long
value from the JobDataMap
.
ClassCastException
- if the identified object is not a String.public String[] getKeys()
|
Quartz Enterprise Job Scheduler Project Page | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |