Mercurial > hg4j
view src/org/tmatesoft/hg/util/FileIterator.java @ 444:b3b1db9301a2
Few comments that emerged while working on examples
author | Artem Tikhomirov <tikhomirov.artem@gmail.com> |
---|---|
date | Tue, 15 May 2012 20:19:22 +0200 |
parents | 7f27122011c3 |
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.util; import java.io.IOException; import org.tmatesoft.hg.repo.HgStatusCollector; import org.tmatesoft.hg.repo.HgWorkingCopyStatusCollector; /** * Abstracts iteration over file system. * * @author Artem Tikhomirov * @author TMate Software Ltd. */ public interface FileIterator { /** * Brings iterator into initial state to facilitate new use. */ void reset() throws IOException; /** * @return whether can shift to next element */ boolean hasNext() throws IOException; /** * Shift to next element */ void next() throws IOException; /** * @return repository-local path to the current element. */ Path name(); /** * {@link FileInfo} object to retrieve actual file information. Caller shall not assume new instance for each {@link #next()} entry, * implementors of this interface may reuse {@link FileInfo} instance if deemed suitable. * @return file information holder. */ FileInfo file(); /** * When {@link FileIterator} represents only fraction of a repository, library might need to figure out if * specific file (path) belongs to that fraction or not. Paths and files returned by this {@link FileIterator} * are always considered as representing the fraction, nonetheless, {@link FileIterator} shall return true for such names if * asked. * <p> * Implementors are advised to use {@link Path.Matcher}, as this scope is very similar to what regular * {@link HgStatusCollector} (which doesn't use FI) supports, and use of matcher makes {@link HgWorkingCopyStatusCollector} * look similar. * * @return <code>true</code> if this {@link FileIterator} is responsible for (interested in) specified repository-local path */ boolean inScope(Path file); // PathMatcher scope() /** * Tells whether caller shall be aware of distinction between executable and non-executable files coming from this iterator. * Note, these days Mercurial (as of 2.1) doesn't recognize Windows .exe files as executable (nor it treats any Windows filesystem as exec-capable) * @return <code>true</code> if file descriptors are capable to provide executable flag */ boolean supportsExecFlag(); /** * POSIX file systems allow symbolic links to files, and these links are handled in a special way with Mercurial, i.e. it tracks value of * the link, not its actual target. * Note, these days Mercurial (as of 2.1) doesn't support Windows Vista/7 symlinks. * @return <code>true</code> if file descriptors are capable to tell symlink files from regular ones. */ boolean supportsLinkFlag(); }