javax.ejb.TimerConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.ejb-api Show documentation
Project GlassFish Enterprise JavaBean API
There is a newer version: 3.2.2
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2006-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.ejb;

import java.io.Serializable;

/**
 * TimerConfig is used to specify additional timer configuration settings during
 * timer creation.   
 *
 * The info object represents a serializable object
 * made available to corresponding timer callbacks.  It is optional
 * and defaults to null.
 *
 * The persistent property determines whether the
 * corresponding timer has a lifetime that spans the JVM in which it
 * was created.  It is optional and defaults to true.
 *
 * @since EJB 3.1
 */

public class TimerConfig {

    public TimerConfig() {}

    public TimerConfig(Serializable info, boolean persistent) {
	info_ = info;
  	persistent_ = persistent;
    }

    /**
     * Set the info object made available to timer callbacks.
     * @param i the info object
     */
    public void setInfo(Serializable i) {
	info_ = i;
    }

    /**
     * Return the info object made available to timer callbacks.
     * @return info object
     */
    public Serializable getInfo() {
	return info_;
    }

    /**
     * Specify whether the timer is persistent.
     * @param p  boolean indicating whether the timer is to be persistent.
     */
    public void setPersistent(boolean p) {
	persistent_ = p;
    }

    /**
     * Return whether the timer is persistent.
     * @return boolean indicating whether the timer is persistent
     */
    public boolean isPersistent() {
	return persistent_;
    }

    public String toString() {
        return "TimerConfig [persistent=" + persistent_ + ";info=" + info_ + "]";
    }

    private Serializable info_ = null;

    private boolean persistent_ = true;

}