tikhomirov@141: /*
tikhomirov@141:  * Copyright (c) 2011 TMate Software Ltd
tikhomirov@141:  *  
tikhomirov@141:  * This program is free software; you can redistribute it and/or modify
tikhomirov@141:  * it under the terms of the GNU General Public License as published by
tikhomirov@141:  * the Free Software Foundation; version 2 of the License.
tikhomirov@141:  *
tikhomirov@141:  * This program is distributed in the hope that it will be useful,
tikhomirov@141:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
tikhomirov@141:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
tikhomirov@141:  * GNU General Public License for more details.
tikhomirov@141:  *
tikhomirov@141:  * For information on how to redistribute this software under
tikhomirov@141:  * the terms of a license other than GNU General Public License
tikhomirov@141:  * contact TMate Software at support@hg4j.com
tikhomirov@141:  */
tikhomirov@141: package org.tmatesoft.hg.util;
tikhomirov@141: 
tikhomirov@141: import java.io.File;
tikhomirov@141: 
tikhomirov@141: /**
tikhomirov@141:  * Abstracts iteration over file system.
tikhomirov@141:  * 
tikhomirov@141:  * @author Artem Tikhomirov
tikhomirov@141:  * @author TMate Software Ltd.
tikhomirov@141:  */
tikhomirov@141: public interface FileIterator {
tikhomirov@141: 
tikhomirov@141: 	/**
tikhomirov@141: 	 * Brings iterator into initial state to facilitate new use.
tikhomirov@141: 	 */
tikhomirov@141: 	void reset();
tikhomirov@141: 
tikhomirov@141: 	/**
tikhomirov@141: 	 * @return whether can shift to next element
tikhomirov@141: 	 */
tikhomirov@141: 	boolean hasNext();
tikhomirov@141: 
tikhomirov@141: 	/**
tikhomirov@141: 	 * Shift to next element
tikhomirov@141: 	 */
tikhomirov@141: 	void next();
tikhomirov@141: 
tikhomirov@141: 	/**
tikhomirov@141: 	 * @return repository-local path to the current element.
tikhomirov@141: 	 */
tikhomirov@141: 	Path name();
tikhomirov@141: 
tikhomirov@141: 	/**
tikhomirov@141: 	 * @return filesystem element.
tikhomirov@141: 	 */
tikhomirov@141: 	File file();
tikhomirov@141: }