Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.commons.io.file.iterate;
import java.io.File;
import java.io.FileFilter;
import java.io.FilenameFilter;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.annotations.OverrideOnDemand;
import com.phloc.commons.annotations.UnsupportedOperation;
import com.phloc.commons.collections.iterate.IIterableIterator;
import com.phloc.commons.filter.IFilter;
import com.phloc.commons.filter.collections.FilterIterator;
import com.phloc.commons.io.file.FileUtils;
import com.phloc.commons.io.file.filter.AbstractFileFilter;
import com.phloc.commons.io.file.filter.FileFilterToIFilterAdapter;
import com.phloc.commons.string.StringHelper;
import com.phloc.commons.string.ToStringGenerator;
/**
* Recursively iterate the content of a file system directory. This is a depth
* first iteration, because as soon as a directory is encountered, the children
* of this directory are iterated.
* Note: the order of iteration is undefined and depends on the order returned
* by {@link FileUtils#getDirectoryContent(File)}.
*
* @author Philip Helger
*/
@NotThreadSafe
public class FileSystemRecursiveIterator implements IIterableIterator
{
private final int m_nStartLevel;
private int m_nLevel = 0;
private final IFilter m_aRecursionFilter;
private final List m_aFilesLeft;
@Nonnegative
private static int _getLevel (@Nonnull final File aFile)
{
return StringHelper.getCharCount (aFile.getAbsolutePath (), File.separatorChar);
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param sBaseDir
* The base directory to start with. May not be null.
*/
public FileSystemRecursiveIterator (@Nonnull final String sBaseDir)
{
this (new File (sBaseDir), (IFilter ) null);
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param aBaseDir
* The base directory to start with. May not be null.
*/
public FileSystemRecursiveIterator (@Nonnull final File aBaseDir)
{
this (aBaseDir, (IFilter ) null);
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param sBaseDir
* The base directory to start with. May not be null.
* @param aRecursionFilter
* An optional filter that controls, into which sub-directories this
* iterator should descend to. May be null.
*/
public FileSystemRecursiveIterator (@Nonnull final String sBaseDir, @Nullable final FilenameFilter aRecursionFilter)
{
this (sBaseDir, FileFilterToIFilterAdapter.create (aRecursionFilter));
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param sBaseDir
* The base directory to start with. May not be null.
* @param aRecursionFilter
* An optional filter that controls, into which sub-directories this
* iterator should descend to. May be null.
*/
public FileSystemRecursiveIterator (@Nonnull final String sBaseDir, @Nullable final FileFilter aRecursionFilter)
{
this (sBaseDir, FileFilterToIFilterAdapter.create (aRecursionFilter));
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param sBaseDir
* The base directory to start with. May not be null.
* @param aRecursionFilter
* An optional filter that controls, into which sub-directories this
* iterator should descend to. May be null.
*/
public FileSystemRecursiveIterator (@Nonnull final String sBaseDir,
@Nullable final AbstractFileFilter aRecursionFilter)
{
this (sBaseDir, (IFilter ) aRecursionFilter);
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param sBaseDir
* The base directory to start with. May not be null.
* @param aRecursionFilter
* An optional filter that controls, into which sub-directories this
* iterator should descend to. May be null.
*/
public FileSystemRecursiveIterator (@Nonnull final String sBaseDir, @Nullable final IFilter aRecursionFilter)
{
this (new File (sBaseDir), aRecursionFilter);
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param aBaseDir
* The base directory to start with. May not be null.
* @param aRecursionFilter
* An optional filter that controls, into which sub-directories this
* iterator should descend to. May be null.
*/
public FileSystemRecursiveIterator (@Nonnull final File aBaseDir, @Nullable final FilenameFilter aRecursionFilter)
{
this (aBaseDir, FileFilterToIFilterAdapter.create (aRecursionFilter));
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param aBaseDir
* The base directory to start with. May not be null.
* @param aRecursionFilter
* An optional filter that controls, into which sub-directories this
* iterator should descend to. May be null.
*/
public FileSystemRecursiveIterator (@Nonnull final File aBaseDir, @Nullable final FileFilter aRecursionFilter)
{
this (aBaseDir, FileFilterToIFilterAdapter.create (aRecursionFilter));
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param aBaseDir
* The base directory to start with. May not be null.
* @param aRecursionFilter
* An optional filter that controls, into which sub-directories this
* iterator should descend to. May be null.
*/
public FileSystemRecursiveIterator (@Nonnull final File aBaseDir, @Nullable final AbstractFileFilter aRecursionFilter)
{
this (aBaseDir, (IFilter ) aRecursionFilter);
}
/**
* Constructor for recursively iterating a file system directory.
*
* @param aBaseDir
* The base directory to start with. May not be null.
* @param aRecursionFilter
* An optional filter that controls, into which sub-directories this
* iterator should descend to. May be null.
*/
public FileSystemRecursiveIterator (@Nonnull final File aBaseDir, @Nullable final IFilter aRecursionFilter)
{
ValueEnforcer.notNull (aBaseDir, "BaseDirectory");
m_nStartLevel = _getLevel (aBaseDir);
m_aRecursionFilter = aRecursionFilter;
m_aFilesLeft = FileUtils.getDirectoryContent (aBaseDir);
}
@Nonnull
public final Iterator iterator ()
{
return this;
}
public final boolean hasNext ()
{
return !m_aFilesLeft.isEmpty ();
}
/**
* Override this method to manually filter the directories, which are recursed
* into.
*
* @param aDirectory
* The non-null directory
* @return true if all children of this directory should be
* investigated
*/
@OverrideOnDemand
protected boolean recurseIntoDirectory (@Nonnull final File aDirectory)
{
return m_aRecursionFilter == null || m_aRecursionFilter.matchesFilter (aDirectory);
}
@Nonnull
public final File next ()
{
if (!hasNext ())
throw new NoSuchElementException ();
// Get and remove the first element
final File aFile = m_aFilesLeft.remove (0);
m_nLevel = _getLevel (aFile) - m_nStartLevel;
if (aFile.isDirectory ())
if (recurseIntoDirectory (aFile))
{
// insert all children of the current directory at the beginning of the
// list
m_aFilesLeft.addAll (0, FileUtils.getDirectoryContent (aFile));
}
return aFile;
}
/**
* @return The nesting level of the last file retrieved by {@link #next()}.
* Always ≥ 0. The starting directory has level 0.
*/
@Nonnegative
public final int getLevel ()
{
return m_nLevel;
}
@UnsupportedOperation
public final void remove ()
{
throw new UnsupportedOperationException ();
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("files", m_aFilesLeft).toString ();
}
/**
* Create a new iterator that recursively descends into sub-directories
* starting from the given base directory. Additionally a
* {@link FilenameFilter} can be added, that determines, which results to be
* returned and which not. The difference between the filter passed here and
* the filter that can be specified in the constructor is the following: the
* {@link IFilter} in the constructor defines into which sub-directories to
* descend. The {@link FilenameFilter} passed to this method only defines
* which elements should be returned and which not, independent of the
* iterated files (like a "view").
*
* @param sBaseDir
* The base directory to start iterating. May not be null.
* @param aFilenameFilter
* The file filter to be used. May not be null.
* @return Never null.
*/
@Nonnull
public static IIterableIterator create (@Nonnull final String sBaseDir,
@Nonnull final FilenameFilter aFilenameFilter)
{
return create (new File (sBaseDir), aFilenameFilter);
}
/**
* Create a new iterator that recursively descends into sub-directories
* starting from the given base directory. Additionally a
* {@link FilenameFilter} can be added, that determines, which results to be
* returned and which not. The difference between the filter passed here and
* the filter that can be specified in the constructor is the following: the
* {@link IFilter} in the constructor defines into which sub-directories to
* descend. The {@link FilenameFilter} passed to this method only defines
* which elements should be returned and which not, independent of the
* iterated files (like a "view").
*
* @param fBaseDir
* The base directory to start iterating. May not be null.
* @param aFilenameFilter
* The file filter to be used. May not be null.
* @return Never null.
*/
@Nonnull
public static IIterableIterator create (@Nonnull final File fBaseDir,
@Nonnull final FilenameFilter aFilenameFilter)
{
return new FilterIterator (new FileSystemRecursiveIterator (fBaseDir),
new FileFilterToIFilterAdapter (aFilenameFilter));
}
/**
* Create a new iterator that recursively descends into sub-directories
* starting from the given base directory. Additionally a list of
* {@link FilenameFilter}s can be added, that determine, which results to be
* returned and which not. The difference between the filter passed here and
* the filter that can be specified in the constructor is the following: the
* {@link IFilter} in the constructor defines into which sub-directories to
* descend. The {@link FilenameFilter}s passed to this method only define
* which elements should be returned and which not, independent of the
* iterated files (like a "view").
*
* @param sBaseDir
* The base directory to start iterating. May not be null.
* @param aFilenameFilters
* The file filter to be used. May neither be null nor
* empty.
* @return Never null.
*/
@Nonnull
public static IIterableIterator create (@Nonnull final String sBaseDir,
@Nonnull @Nonempty final FilenameFilter... aFilenameFilters)
{
return create (new File (sBaseDir), aFilenameFilters);
}
/**
* Create a new iterator that recursively descends into sub-directories
* starting from the given base directory. Additionally a list of
* {@link FilenameFilter}s can be added, that determine, which results to be
* returned and which not. The difference between the filter passed here and
* the filter that can be specified in the constructor is the following: the
* {@link IFilter} in the constructor defines into which sub-directories to
* descend. The {@link FilenameFilter}s passed to this method only define
* which elements should be returned and which not, independent of the
* iterated files (like a "view").
*
* @param fBaseDir
* The base directory to start iterating. May not be null.
* @param aFilenameFilters
* The file filter to be used. May neither be null nor
* empty.
* @return Never null.
*/
@Nonnull
public static IIterableIterator create (@Nonnull final File fBaseDir,
@Nonnull @Nonempty final FilenameFilter... aFilenameFilters)
{
return new FilterIterator (new FileSystemRecursiveIterator (fBaseDir),
FileFilterToIFilterAdapter.getANDChained (aFilenameFilters));
}
/**
* Create a new iterator that recursively descends into sub-directories
* starting from the given base directory. Additionally a {@link FileFilter}
* can be added, that determines, which results to be returned and which not.
* The difference between the filter passed here and the filter that can be
* specified in the constructor is the following: the {@link IFilter} in the
* constructor defines into which sub-directories to descend. The
* {@link FileFilter} passed to this method only defines which elements should
* be returned and which not, independent of the iterated files (like a
* "view").
*
* @param sBaseDir
* The base directory to start iterating. May not be null.
* @param aFileFilter
* The file filter to be used. May not be null.
* @return Never null.
*/
@Nonnull
public static IIterableIterator create (@Nonnull final String sBaseDir, @Nonnull final FileFilter aFileFilter)
{
return create (new File (sBaseDir), aFileFilter);
}
/**
* Create a new iterator that recursively descends into sub-directories
* starting from the given base directory. Additionally a {@link FileFilter}
* can be added, that determines, which results to be returned and which not.
* The difference between the filter passed here and the filter that can be
* specified in the constructor is the following: the {@link IFilter} in the
* constructor defines into which sub-directories to descend. The
* {@link FileFilter} passed to this method only defines which elements should
* be returned and which not, independent of the iterated files (like a
* "view").
*
* @param fBaseDir
* The base directory to start iterating. May not be null.
* @param aFileFilter
* The file filter to be used. May not be null.
* @return Never null.
*/
@Nonnull
public static IIterableIterator create (@Nonnull final File fBaseDir, @Nonnull final FileFilter aFileFilter)
{
return new FilterIterator (new FileSystemRecursiveIterator (fBaseDir),
new FileFilterToIFilterAdapter (aFileFilter));
}
/**
* Create a new iterator that recursively descends into sub-directories
* starting from the given base directory. Additionally a list of
* {@link FileFilter}s can be added, that determine, which results to be
* returned and which not. The difference between the filter passed here and
* the filter that can be specified in the constructor is the following: the
* {@link IFilter} in the constructor defines into which sub-directories to
* descend. The {@link FileFilter}s passed to this method only define which
* elements should be returned and which not, independent of the iterated
* files (like a "view").
*
* @param sBaseDir
* The base directory to start iterating. May not be null.
* @param aFileFilters
* The file filter to be used. May neither be null nor
* empty.
* @return Never null.
*/
@Nonnull
public static IIterableIterator create (@Nonnull final String sBaseDir,
@Nonnull @Nonempty final FileFilter... aFileFilters)
{
return create (new File (sBaseDir), aFileFilters);
}
/**
* Create a new iterator that recursively descends into sub-directories
* starting from the given base directory. Additionally a list of
* {@link FileFilter}s can be added, that determine, which results to be
* returned and which not. The difference between the filter passed here and
* the filter that can be specified in the constructor is the following: the
* {@link IFilter} in the constructor defines into which sub-directories to
* descend. The {@link FileFilter}s passed to this method only define which
* elements should be returned and which not, independent of the iterated
* files (like a "view").
*
* @param fBaseDir
* The base directory to start iterating. May not be null.
* @param aFileFilters
* The file filter to be used. May neither be null nor
* empty.
* @return Never null.
*/
@Nonnull
public static IIterableIterator create (@Nonnull final File fBaseDir,
@Nonnull @Nonempty final FileFilter... aFileFilters)
{
return new FilterIterator (new FileSystemRecursiveIterator (fBaseDir),
FileFilterToIFilterAdapter.getANDChained (aFileFilters));
}
}
