xy.reflect.ui.util.DelayedUpdateProcess Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (C) 2018 OTK Software
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program 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.  See the
 * GNU General Public License for more details.
 * 
 * The GNU General Public License allows you also to freely redistribute 
 * the libraries under the same license, if you provide the terms of the 
 * GNU General Public License with them and add the following 
 * copyright notice at the appropriate place (with a link to 
 * http://javacollection.net/reflectionui/ web site when possible).
 ******************************************************************************/
package xy.reflect.ui.util;

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ThreadFactory;

public abstract class DelayedUpdateProcess {

	protected abstract void commit();

	protected abstract long getCommitDelayMilliseconds();

	protected Object commitMutex = new Object();
	protected Future dataUpdateTask;
	protected ExecutorService dataUpdateJobExecutor = Executors.newSingleThreadExecutor(new ThreadFactory() {
		@Override
		public Thread newThread(Runnable r) {
			Thread result = new Thread(r);
			result.setName("DataUpdateJobExecutor [of=" + DelayedUpdateProcess.this + "]");
			result.setDaemon(true);
			return result;
		}
	});
	protected boolean commitScheduled = false;

	public void scheduleCommit() {
		synchronized (commitMutex) {
			dataUpdateTask = dataUpdateJobExecutor.submit(new Runnable() {
				@Override
				public void run() {
					commitScheduled = true;
					try {
						try {
							Thread.sleep(getCommitDelayMilliseconds());
						} catch (InterruptedException e) {
							return;
						}
						commit();
					} finally {
						commitScheduled = false;
					}
				}
			});
		}
	}

	public void cancelCommitSchedule() {
		synchronized (commitMutex) {
			if (dataUpdateTask != null) {
				dataUpdateTask.cancel(true);
			}
		}
	}

	public boolean isCommitScheduled() {
		return commitScheduled;
	}

}