org.quartz.SchedulerContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quartz Show documentation

There is a newer version: 2.5.0


/* 
 * Copyright 2001-2009 Terracotta, Inc. 
 * 
 * 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;

import java.io.Serializable;
import java.util.Map;

import org.quartz.utils.StringKeyDirtyFlagMap;

/**
 * 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.
 * 
 * 
 * Future versions of Quartz may make distinctions on how it propagates
 * data in SchedulerContext between instances of proxies to a 
 * single scheduler instance - i.e. if Quartz is being used via RMI.
 * 
 *  
 * @see Scheduler#getContext
 * 
 * @author James House
 */
public class SchedulerContext extends StringKeyDirtyFlagMap implements Serializable {
    /**
     * Create an empty SchedulerContext.
     */
    public SchedulerContext() {
        super(15);
    }

    /**
     * Create a SchedulerContext with the given data.
     */
    public SchedulerContext(Map map) {
        this();
        @SuppressWarnings("unchecked") // param must be a String key map.
		Map mapTyped = (Map)map;
        putAll(mapTyped);
    }
}