|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.quartz.utils.DirtyFlagMap
org.quartz.SchedulerContext
Holds context/environment data that can be made available to Jobs as they are executed. This feature is much like the ServletContext feature when working with J2EE servlets.
Scheduler.getContext()
,
Serialized FormNested Class Summary |
Nested classes inherited from class java.util.Map |
java.util.Map.Entry |
Constructor Summary | |
SchedulerContext()
Create an empty JobDataMap . |
|
SchedulerContext(java.util.Map map)
Create a JobDataMap with the given data. |
Method Summary | |
boolean |
containsTransientData()
|
boolean |
getAllowsTransientData()
|
boolean |
getBoolean(java.lang.String key)
Retrieve the identified code>boolean value from the SchedulerContext . |
char |
getChar(java.lang.String key)
Retrieve the identified code>char value from the SchedulerContext . |
double |
getDouble(java.lang.String key)
Retrieve the identified code>double value from the SchedulerContext . |
float |
getFloat(java.lang.String key)
Retrieve the identified code>float value from the SchedulerContext . |
int |
getInt(java.lang.String key)
Retrieve the identified code>int value from the SchedulerContext . |
java.lang.String[] |
getKeys()
|
long |
getLong(java.lang.String key)
Retrieve the identified code>long value from the SchedulerContext . |
java.lang.String |
getString(java.lang.String key)
Retrieve the identified code>String value from the SchedulerContext . |
java.lang.Object |
put(java.lang.Object key,
java.lang.Object value)
Adds the given Object value to the SchedulerContext . |
void |
put(java.lang.String key,
boolean value)
Adds the given boolean value to the SchedulerContext . |
void |
put(java.lang.String key,
char value)
Adds the given char value to the SchedulerContext . |
void |
put(java.lang.String key,
double value)
Adds the given double value to the SchedulerContext . |
void |
put(java.lang.String key,
float value)
Adds the given float value to the SchedulerContext . |
void |
put(java.lang.String key,
int value)
Adds the given int value to the SchedulerContext . |
void |
put(java.lang.String key,
long value)
Adds the given long value to the SchedulerContext . |
void |
put(java.lang.String key,
java.lang.String value)
Adds the given String value to the SchedulerContext . |
void |
putAll(java.util.Map map)
Adds the name-value pairs in the given Map to the
SchedulerContext . |
void |
removeTransientData()
Nulls-out any data values that are non-Serializable. |
void |
setAllowsTransientData(boolean allowsTransientData)
Tell the SchedulerContext 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, keySet, remove, 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 SchedulerContext()
Create an empty JobDataMap
.
public SchedulerContext(java.util.Map map)
Create a JobDataMap
with the given data.
Method Detail |
public void setAllowsTransientData(boolean allowsTransientData)
Tell the SchedulerContext
that it should allow
non-Serializable
data.
Future versions of Quartz may make distinctions on how it propogates data in the SchedulerContext between instances of proxies to a single scheduler instance - i.e. if Quartz is being used via RMI.
public boolean getAllowsTransientData()
public boolean containsTransientData()
public void removeTransientData()
Nulls-out any data values that are non-Serializable.
public void putAll(java.util.Map map)
Adds the name-value pairs in the given Map
to the
SchedulerContext
.
All keys must be String
s.
putAll
in interface java.util.Map
putAll
in class DirtyFlagMap
public void put(java.lang.String key, int value)
Adds the given int
value to the SchedulerContext
.
public void put(java.lang.String key, long value)
Adds the given long
value to the SchedulerContext
.
public void put(java.lang.String key, float value)
Adds the given float
value to the SchedulerContext
.
public void put(java.lang.String key, double value)
Adds the given double
value to the SchedulerContext
.
public void put(java.lang.String key, boolean value)
Adds the given boolean
value to the SchedulerContext
.
public void put(java.lang.String key, char value)
Adds the given char
value to the SchedulerContext
.
public void put(java.lang.String key, java.lang.String value)
Adds the given String
value to the SchedulerContext
.
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
Adds the given Object
value to the SchedulerContext
.
put
in interface java.util.Map
put
in class DirtyFlagMap
public int getInt(java.lang.String key)
Retrieve the identified code>int value from the
SchedulerContext
.
java.lang.ClassCastException
- if the identified object is not an Integer.public long getLong(java.lang.String key)
Retrieve the identified code>long value from the
SchedulerContext
.
java.lang.ClassCastException
- if the identified object is not a Long.public float getFloat(java.lang.String key)
Retrieve the identified code>float value from the
SchedulerContext
.
java.lang.ClassCastException
- if the identified object is not a Float.public double getDouble(java.lang.String key)
Retrieve the identified code>double value from the
SchedulerContext
.
java.lang.ClassCastException
- if the identified object is not a Double.public boolean getBoolean(java.lang.String key)
Retrieve the identified code>boolean value from the
SchedulerContext
.
java.lang.ClassCastException
- if the identified object is not a Boolean.public char getChar(java.lang.String key)
Retrieve the identified code>char value from the
SchedulerContext
.
java.lang.ClassCastException
- if the identified object is not a Character.public java.lang.String getString(java.lang.String key)
Retrieve the identified code>String value from the
SchedulerContext
.
java.lang.ClassCastException
- if the identified object is not a String.public java.lang.String[] getKeys()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |