org.quartz.jobs.JobDataMap Maven / Gradle / Ivy
Show all versions of sundial Show documentation
/**
* Copyright 2015 Knowm Inc. (http://knowm.org) and contributors.
* Copyright 2013-2015 Xeiam LLC (http://xeiam.com) and contributors.
* Copyright 2001-2011 Terracotta Inc. (http://terracotta.org).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.quartz.jobs;
import java.io.Serializable;
import java.util.HashMap;
/**
* 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).
*
*
* @author James House
* @author timmolter
*/
public class JobDataMap extends HashMapimplements Serializable {
private static final long serialVersionUID = -6939901990106713909L;
/**
*
* Create an empty JobDataMap.
*
*/
public JobDataMap() {
super(15);
}
/**
* Constructor - creates a shallow copy of the passed in JobDataMap
*
* @param jobDataMap
*/
public JobDataMap(JobDataMap jobDataMap) {
super(jobDataMap);
}
/**
*
* Retrieve the identified String value from the JobDataMap.
*
*
* @throws ClassCastException if the identified object is not a String.
*/
public String getString(String key) {
Object obj = get(key);
try {
return (String) obj;
} catch (Exception e) {
throw new ClassCastException("Identified object is not a String.");
}
}
public JobDataMap shallowCopy() {
return new JobDataMap(this);
}
}