io.janusproject.services.executor.JanusScheduledFutureTask Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io.janusproject.kernel Show documentation

There is a newer version: 3.0.12.0

Show newest version

/*
 * $Id: io/janusproject/services/executor/JanusScheduledFutureTask.java v2.0.3.1 2016-01-24 00:05:13$
 *
 * Janus platform is an open-source multiagent platform.
 * More details on http://www.janusproject.io
 *
 * Copyright (C) 2014-2015 the original authors or authors.
 *
 * 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 io.janusproject.services.executor;

import java.util.concurrent.FutureTask;
import java.util.concurrent.RunnableScheduledFuture;
import java.util.concurrent.ScheduledFuture;

/**
 * A {@link ScheduledFuture} that is {@link Runnable}. Successful
 * execution of the run method causes completion of the
 * Future and allows access to its results.
 *
 * @param  - type of the values supported by the task.
 * @author Stéphane Galland
 * @version 2.0.3.1 2016-01-24 00:05:13
 * @mavengroupid io.janusproject
 * @mavenartifactid io.janusproject.kernel
 * @see FutureTask
 */
public interface JanusScheduledFutureTask extends RunnableScheduledFuture {

	/** Replies the thread that is running the task associated to this future.
	 *
	 * @return the thread, never null.
	 */
	Thread getThread();

	/** Replies the task associated to this future is running on the calling thread.
	 *
	 * @return true if the current thread is running the associated
	 *     task, false otherwie.
	 */
	boolean isCurrentThread();

}