tikhomirov@205: /*
tikhomirov@423:  * Copyright (c) 2011-2012 TMate Software Ltd
tikhomirov@205:  *  
tikhomirov@205:  * This program is free software; you can redistribute it and/or modify
tikhomirov@205:  * it under the terms of the GNU General Public License as published by
tikhomirov@205:  * the Free Software Foundation; version 2 of the License.
tikhomirov@205:  *
tikhomirov@205:  * This program is distributed in the hope that it will be useful,
tikhomirov@205:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
tikhomirov@205:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
tikhomirov@205:  * GNU General Public License for more details.
tikhomirov@205:  *
tikhomirov@205:  * For information on how to redistribute this software under
tikhomirov@205:  * the terms of a license other than GNU General Public License
tikhomirov@205:  * contact TMate Software at support@hg4j.com
tikhomirov@205:  */
tikhomirov@205: package org.tmatesoft.hg.core;
tikhomirov@205: 
tikhomirov@423: import org.tmatesoft.hg.internal.Callback;
tikhomirov@427: import org.tmatesoft.hg.util.Path;
tikhomirov@312: 
tikhomirov@205: /**
tikhomirov@205:  * Callback to process {@link HgChangeset changesets}.
tikhomirov@205:  * 
tikhomirov@205:  * @author Artem Tikhomirov
tikhomirov@205:  * @author TMate Software Ltd.
tikhomirov@205:  */
tikhomirov@423: @Callback
tikhomirov@427: public interface HgChangesetHandler {
tikhomirov@427: 
tikhomirov@205: 	/**
tikhomirov@427: 	 * @param changeset descriptor of a change, not necessarily a distinct instance each time, {@link HgChangeset#clone() clone()} if need a copy.
tikhomirov@423: 	 * @throws HgCallbackTargetException wrapper for any exception user code may produce 
tikhomirov@205: 	 */
tikhomirov@427: 	void cset(HgChangeset changeset) throws HgCallbackTargetException;
tikhomirov@427: 
tikhomirov@427: 
tikhomirov@427: 	/**
tikhomirov@427: 	 * When {@link HgLogCommand} is executed against file, handler passed to {@link HgLogCommand#execute(HgChangesetHandler)} may optionally
tikhomirov@427: 	 * implement this interface to get information about file renames. Method {@link #copy(HgFileRevision, HgFileRevision)} would
tikhomirov@427: 	 * get invoked prior any changeset of the original file (if file history being followed) is reported via {@link #cset(HgChangeset)}.
tikhomirov@427: 	 * 
tikhomirov@427: 	 * For {@link HgLogCommand#file(Path, boolean)} with renamed file path and follow argument set to false, 
tikhomirov@427: 	 * {@link #copy(HgFileRevision, HgFileRevision)} would be invoked for the first copy/rename in the history of the file, but not 
tikhomirov@427: 	 * followed by any changesets. 
tikhomirov@427: 	 */
tikhomirov@427: 	@Callback
tikhomirov@427: 	public interface WithCopyHistory extends HgChangesetHandler {
tikhomirov@427: 		// XXX perhaps, should distinguish copy from rename? And what about merged revisions and following them?
tikhomirov@427: 
tikhomirov@427: 		/**
tikhomirov@427: 		 * @throws HgCallbackTargetException wrapper object for any exception user code may produce 
tikhomirov@427: 		 */
tikhomirov@427: 		void copy(HgFileRevision from, HgFileRevision to) throws HgCallbackTargetException;
tikhomirov@427: 	}
tikhomirov@205: }