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