Mercurial > hg4j

view src/org/tmatesoft/hg/core/HgManifestHandler.java @ 694:7efabe0cddcf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Speed up (a) file rename history to minimize file reads; (b) file.isCopy(int) to read metadata for few revisions at once (use pattern assumes earlier revisions are likely to be queried, too); (c) HgIgnore.isIgnored by caching matched initial fragments (to substitute more expensive Matcher.matches with cheaper HashMap.contains)
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Mon, 05 Aug 2013 17:42:10 +0200
parents 6526d8adbc0f
children
line wrap: on
line source
/*
 * Copyright (c) 2011-2012 TMate Software Ltd
 *  
 * 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; version 2 of the License.
 *
 * 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.
 *
 * For information on how to redistribute this software under
 * the terms of a license other than GNU General Public License
 * contact TMate Software at support@hg4j.com
 */
package org.tmatesoft.hg.core;

import org.tmatesoft.hg.internal.Callback;
import org.tmatesoft.hg.repo.HgRuntimeException;
import org.tmatesoft.hg.util.Path;

/**
 * Callback to walk file/directory tree of a revision
 * 
 * @author Artem Tikhomirov
 * @author TMate Software Ltd.
 */
@Callback
public interface HgManifestHandler {
	/**
	 * Indicates start of manifest revision. Subsequent {@link #file(HgFileRevision)} and {@link #dir(Path)} come 
	 * from the specified manifest revision until {@link #end(Nodeid)} with the matching revision is invoked.
	 * 
	 * @param manifestRevision unique identifier of the manifest revision
	 * @throws HgCallbackTargetException wrapper for any exception user code may produce
	 * @throws HgRuntimeException propagates library issues. <em>Runtime exception</em>
	 */
	void begin(Nodeid manifestRevision) throws HgCallbackTargetException, HgRuntimeException;

	/**
	 * If walker is configured to spit out directories, indicates files from specified directories are about to be reported.
	 * Comes prior to any files from this directory and subdirectories
	 * 
	 * @param path directory known in the manifest
	 * @throws HgCallbackTargetException wrapper for any exception user code may produce
	 * @throws HgRuntimeException propagates library issues. <em>Runtime exception</em>
	 */
	void dir(Path path) throws HgCallbackTargetException, HgRuntimeException; 

	/**
	 * Reports a file revision entry in the manifest
	 * 
	 * @param fileRevision description of the file revision
	 * @throws HgCallbackTargetException wrapper for any exception user code may produce
	 * @throws HgRuntimeException propagates library issues. <em>Runtime exception</em>
	 */
	void file(HgFileRevision fileRevision) throws HgCallbackTargetException, HgRuntimeException;

	/**
	 * Indicates all files from the manifest revision have been reported.
	 * Closes {@link #begin(Nodeid)} with the same revision that came before.
	 * 
	 * @param manifestRevision unique identifier of the manifest revision 
	 * @throws HgCallbackTargetException wrapper for any exception user code may produce
	 * @throws HgRuntimeException propagates library issues. <em>Runtime exception</em>
	 */
	void end(Nodeid manifestRevision) throws HgCallbackTargetException, HgRuntimeException;
}