com.univocity.api.statistics.DataTransfer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of univocity-common-api Show documentation
univocity public API - Common classes and utilites
The newest version!
/*
 * Copyright (c) 2013 Univocity Software Pty Ltd. All rights reserved.
 * This file is subject to the terms and conditions defined in file
 * 'LICENSE.txt', which is part of this source code package.
 */

package com.univocity.api.statistics;

/**
 * A callback interface used to receive notifications of data transfers from a source to a target.
 * Information about sizes transferred are implementation dependent and can signify bytes transferred, number of
 * records, etc.
 *
 * @param  the source of data, where data is coming from
 * @param  the target of data, where data is being transferred into.
 *
 * @author Univocity Software Pty Ltd - [email protected]
 */
public interface DataTransfer {

	/**
	 * Notifies a data transfer has been started.
	 *
	 * @param source    the source of data
	 * @param totalSize the total size of the data. The meaning of the
	 *                  amount provided depends on the underlying implementation: this can be bytes, number of
	 *                  records, etc. If -1, the total size is unknown ahead of time.
	 * @param target    the data target
	 */
	void started(S source, long totalSize, T target);

	/**
	 * Notifies how much data has been transferred from source to target. Can be invoked multiple times until the
	 * data transfer is completed or aborted.
	 *
	 * @param source      the source of data
	 * @param transferred the amount of data transferred since the last time this method was called. The meaning of the
	 *                    amount provided depends on the underlying implementation: this can be bytes, number of
	 *                    records, etc.
	 * @param target      the data target
	 */
	void transferred(S source, long transferred, T target);

	/**
	 * Notifies that a data transfer has been finalized.
	 *
	 * @param source the source of data
	 * @param target the data target
	 */
	void completed(S source, T target);

	/**
	 * Notifies that the data transfer has been aborted.
	 *
	 * @param source the source of data
	 * @param target the data target
	 * @param error  exception that caused the process abortion.
	 */
	void aborted(S source, T target, Exception error);

	/**
	 * Returns a flag indicating whether the data transfer has been started.
	 *
	 * @return a flag indicating whether the data transfer has been started.
	 */
	boolean isStarted();

	/**
	 * Returns a flag indicating whether the data transfer is running.
	 *
	 * @return a flag indicating whether the data transfer is running.
	 */
	boolean isRunning();

	/**
	 * Returns a flag indicating whether the data transfer was aborted.
	 *
	 * @return a flag indicating whether the data transfer was aborted.
	 */
	boolean isAborted();
}