org.eclipse.egit.core.AdaptableFileTreeIterator.java Source code

Introduction

Here is the source code for org.eclipse.egit.core.AdaptableFileTreeIterator.java

Source

/*******************************************************************************
 * Copyright (C) 2009, Tor Arne Vestb <torarnv@gmail.com>
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/

package org.eclipse.egit.core;

import java.io.File;
import java.io.IOException;

import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IWorkspaceRoot;
import org.eclipse.jgit.errors.IncorrectObjectTypeException;
import org.eclipse.jgit.lib.ObjectReader;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.treewalk.AbstractTreeIterator;
import org.eclipse.jgit.treewalk.FileTreeIterator;
import org.eclipse.jgit.treewalk.WorkingTreeOptions;
import org.eclipse.jgit.util.FS;

/**
 * Java IO file tree iterator that can adapt to a {@link ContainerTreeIterator}
 * <p>
 * The iterator automatically adapts to a {@link ContainerTreeIterator} when
 * recursing into directories that are accessible from the given workspace root.
 *
 * @see org.eclipse.jgit.treewalk.FileTreeIterator
 * @see org.eclipse.egit.core.ContainerTreeIterator
 */
public class AdaptableFileTreeIterator extends FileTreeIterator {

    IWorkspaceRoot root;

    /**
     * Create a new iterator to traverse the work tree of the given repository
     * <p>
     * The iterator will automatically adapt to a {@link ContainerTreeIterator}
     * when encountering directories what can be mapped into the given workspace
     * root.
     *
     * @param repository
     *            the repository this iterator should traverse the working tree
     *            of
     * @param workspaceRoot
     *            the workspace root to check resource mapping against.
     */
    public AdaptableFileTreeIterator(final Repository repository, final IWorkspaceRoot workspaceRoot) {
        super(repository.getWorkTree(), FS.DETECTED, repository.getConfig().get(WorkingTreeOptions.KEY));
        root = workspaceRoot;
    }

    /**
     * Create a new iterator to traverse a subdirectory.
     * <p>
     * The iterator will automatically adapt to a {@link ContainerTreeIterator}
     * when encountering directories what can be mapped into the given workspace
     * root.
     *
     * @param path
     *            the subdirectory. This should be a directory contained within
     *            the parent directory.
     * @param parent
     *            the parent iterator we were created from.
     * @param workspaceRoot
     *            the workspace root to check resource mapping against.
     */
    protected AdaptableFileTreeIterator(final AdaptableFileTreeIterator parent, File path,
            final IWorkspaceRoot workspaceRoot) {
        super(parent, path, FS.DETECTED);
        root = workspaceRoot;
    }

    @Override
    public AbstractTreeIterator createSubtreeIterator(ObjectReader repo)
            throws IncorrectObjectTypeException, IOException {
        final File currentFile = ((FileEntry) current()).getFile();
        IContainer container = IteratorService.findContainer(root, currentFile);
        if (container != null)
            return new ContainerTreeIterator(this, container);
        return new AdaptableFileTreeIterator(this, currentFile, root);
    }

}