us.fatehi.utility.scheduler.TaskRunner Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of schemacrawler Show documentation
Show all versions of schemacrawler Show documentation
SchemaCrawler is an open-source Java API that makes working with database metadata as easy as working with plain old Java objects. SchemaCrawler is also a database schema discovery and comprehension, and schema documentation tool. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format. The output is designed to be diff-ed against other database schemas.
/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2024, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------
SchemaCrawler is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.
You may elect to redistribute this code under any of these licenses.
The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html
The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/
========================================================================
*/
package us.fatehi.utility.scheduler;
import java.util.concurrent.ExecutionException;
import java.util.function.Supplier;
public interface TaskRunner extends AutoCloseable {
int MIN_THREADS = 1;
int MAX_THREADS = 10;
/** Add a task definition to the list of tasks to run. */
void add(TaskDefinition taskDefinition) throws Exception;
/** Alias for stop for use in a try-catch block. */
@Override
default void close() throws Exception {
stop();
}
/**
* Id of this task runner.
*
* @return Id of task runner.
*/
String getId();
/**
* Returns true if the task runner is stopped and is not accepting any more tasks.
*
* @return True if stopped.
*/
boolean isStopped();
/**
* Allows for a deferred conversion to a string. Useful in logging.
*
* @return String supplier.
* @throws Exception
*/
Supplier report();
/**
* Stop the task runner after waiting for all the threads to finish executing. No more tasks will
* be accepted.
*
* @throws ExecutionException On an exception.
*/
void stop();
/**
* Submit the current list of tasks for execution, and block until execution is complete. Then
* clears the task list.
*
* @throws Exception On an exception in any one of the tasks.
*/
void submit() throws Exception;
}