package org.codehaus.plexus.util;

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowledgement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.codehaus.org/)."
 *    Alternately, this acknowledgement may appear in the software itself,
 *    if and wherever such third-party acknowledgements normally appear.
 *
 * 4. The names "Ant" and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact codehaus@codehaus.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.codehaus.org/>.
 */

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Vector;

Class for scanning a directory for files/directories which match certain criteria.
These criteria consist of selectors and patterns which have been specified. With the selectors you can select which
files you want to have included. Files which are not selected are excluded. With patterns you can include or exclude
files based on their filename.
The idea is simple. A given directory is recursively scanned for all files and directories. Each file/directory is
matched against a set of selectors, including special support for matching against filenames with include and and
exclude patterns. Only files/directories which match at least one pattern of the include pattern list or other file
selector, and don't match any pattern of the exclude pattern list or fail to match against a required selector will
be placed in the list of files/directories found.
When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no
list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors
are supplied, none are applied.
The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment
is the name of a directory or file, which is bounded by File.separator ('/' under UNIX, '\' under
Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same
is done for the pattern against which should be matched.
The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in
the pattern, it matches zero or more path segments of the name.
There is a special case regarding the use of File.separators at the beginning of the pattern and the
string to match:

When a pattern starts with a File.separator, the string to match must also start with a
File.separator. When a pattern does not start with a File.separator, the string to match
may not start with a File.separator. When one of these rules is not obeyed, the string will not match.
When a name path segment is matched against a pattern path segment, the following special characters can be used:

'*' matches zero or more characters

'?' matches one character.
Examples:

  
"**\*.class" matches all .class files/dirs in a directory tree.
  
"test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a
directory called test.
  
"**" matches everything in a directory tree.
  
"**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test
(e.g. "abc\test\def\ghi\XYZ123").

Case sensitivity may be turned off if necessary. By default, it is turned on.
Example of usage:
String[] includes = { "**\\*.class" };
String[] excludes = { "modules\\*\\**" };
ds.setIncludes( includes );
ds.setExcludes( excludes );
ds.setBasedir( new File( "test" ) );
ds.setCaseSensitive( true );
ds.scan();
System.out.println( "FILES:" );
String[] files = ds.getIncludedFiles();
for ( int i = 0; i < files.length; i++ )
{
    System.out.println( files[i] );
}

This will scan a directory called test for .class files, but excludes all files in all proper subdirectories of a
directory called "modules"
Author:
Arnout J. Kuiper ajkuiper@wxs.nl, Magesh Umasankar, Bruce Atherton, Antoine Levy-Lambert/**
 * <p>Class for scanning a directory for files/directories which match certain criteria.</p>
 * 
 * <p>These criteria consist of selectors and patterns which have been specified. With the selectors you can select which
 * files you want to have included. Files which are not selected are excluded. With patterns you can include or exclude
 * files based on their filename.</p>
 * 
 * <p>The idea is simple. A given directory is recursively scanned for all files and directories. Each file/directory is
 * matched against a set of selectors, including special support for matching against filenames with include and and
 * exclude patterns. Only files/directories which match at least one pattern of the include pattern list or other file
 * selector, and don't match any pattern of the exclude pattern list or fail to match against a required selector will
 * be placed in the list of files/directories found.</p>
 * 
 * <p>When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no
 * list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors
 * are supplied, none are applied.</p>
 * 
 * <p>The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment
 * is the name of a directory or file, which is bounded by <code>File.separator</code> ('/' under UNIX, '\' under
 * Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same
 * is done for the pattern against which should be matched.</p>
 * 
 * <p>The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in
 * the pattern, it matches zero or more path segments of the name.</p>
 * 
 * <p>There is a special case regarding the use of <code>File.separator</code>s at the beginning of the pattern and the
 * string to match:<br>
 * When a pattern starts with a <code>File.separator</code>, the string to match must also start with a
 * <code>File.separator</code>. When a pattern does not start with a <code>File.separator</code>, the string to match
 * may not start with a <code>File.separator</code>. When one of these rules is not obeyed, the string will not match.</p>
 * 
 * <p>When a name path segment is matched against a pattern path segment, the following special characters can be used:<br>
 * '*' matches zero or more characters<br>
 * '?' matches one character.</p>
 * 
 * Examples:
 * <ul>
 *   <li>"**\*.class" matches all .class files/dirs in a directory tree.</li>
 *   <li>"test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a
 * directory called test.</li>
 *   <li>"**" matches everything in a directory tree.</li>
 *   <li>"**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test
 * (e.g. "abc\test\def\ghi\XYZ123").</li>
 * </ul>
 * 
 * <p>Case sensitivity may be turned off if necessary. By default, it is turned on.</p>
 * Example of usage:
 * <pre>
 * String[] includes = { "**\\*.class" };
 * String[] excludes = { "modules\\*\\**" };
 * ds.setIncludes( includes );
 * ds.setExcludes( excludes );
 * ds.setBasedir( new File( "test" ) );
 * ds.setCaseSensitive( true );
 * ds.scan();
 *
 * System.out.println( "FILES:" );
 * String[] files = ds.getIncludedFiles();
 * for ( int i = 0; i &lt; files.length; i++ )
 * {
 *     System.out.println( files[i] );
 * }
 * </pre>
 * 
 * <p>This will scan a directory called test for .class files, but excludes all files in all proper subdirectories of a
 * directory called "modules"</p>
 *
 * @author Arnout J. Kuiper <a href="mailto:ajkuiper@wxs.nl">ajkuiper@wxs.nl</a>
 * @author Magesh Umasankar
 * @author <a href="mailto:bruce@callenish.com">Bruce Atherton</a>
 * @author <a href="mailto:levylambert@tiscali-dsl.de">Antoine Levy-Lambert</a>
 */
public class DirectoryScanner
    extends AbstractScanner
{

    
The base directory to be scanned.
/**
     * The base directory to be scanned.
     */
    protected File basedir;

    
The files which matched at least one include and no excludes and were selected.
/**
     * The files which matched at least one include and no excludes and were selected.
     */
    protected Vector<String> filesIncluded;

    
The files which did not match any includes or selectors.
/**
     * The files which did not match any includes or selectors.
     */
    protected Vector<String> filesNotIncluded;

    
The files which matched at least one include and at least one exclude.
/**
     * The files which matched at least one include and at least one exclude.
     */
    protected Vector<String> filesExcluded;

    
The directories which matched at least one include and no excludes and were selected.
/**
     * The directories which matched at least one include and no excludes and were selected.
     */
    protected Vector<String> dirsIncluded;

    
The directories which were found and did not match any includes.
/**
     * The directories which were found and did not match any includes.
     */
    protected Vector<String> dirsNotIncluded;

    
The directories which matched at least one include and at least one exclude.
/**
     * The directories which matched at least one include and at least one exclude.
     */
    protected Vector<String> dirsExcluded;

    
The files which matched at least one include and no excludes and which a selector discarded.
/**
     * The files which matched at least one include and no excludes and which a selector discarded.
     */
    protected Vector<String> filesDeselected;

    
The directories which matched at least one include and no excludes but which a selector discarded.
/**
     * The directories which matched at least one include and no excludes but which a selector discarded.
     */
    protected Vector<String> dirsDeselected;

    
Whether or not our results were built by a slow scan.
/**
     * Whether or not our results were built by a slow scan.
     */
    protected boolean haveSlowResults = false;

    
Whether or not symbolic links should be followed.
Since:
Ant 1.5/**
     * Whether or not symbolic links should be followed.
     *
     * @since Ant 1.5
     */
    private boolean followSymlinks = true;

    
Whether or not everything tested so far has been included.
/**
     * Whether or not everything tested so far has been included.
     */
    protected boolean everythingIncluded = true;

    private final String[] tokenizedEmpty = MatchPattern.tokenizePathToString( "", File.separator );

    
Sole constructor.
/**
     * Sole constructor.
     */
    public DirectoryScanner()
    {
    }

    
Sets the base directory to be scanned. This is the directory which is scanned recursively. All '/' and '\'
characters are replaced by File.separatorChar, so the separator used need not match
File.separatorChar.
Params:
basedir – The base directory to scan. Must not be null./**
     * Sets the base directory to be scanned. This is the directory which is scanned recursively. All '/' and '\'
     * characters are replaced by <code>File.separatorChar</code>, so the separator used need not match
     * <code>File.separatorChar</code>.
     *
     * @param basedir The base directory to scan. Must not be <code>null</code>.
     */
    public void setBasedir( String basedir )
    {
        setBasedir( new File( basedir.replace( '/', File.separatorChar ).replace( '\\', File.separatorChar ) ) );
    }

    
Sets the base directory to be scanned. This is the directory which is scanned recursively.
Params:
basedir – The base directory for scanning. Should not be null./**
     * Sets the base directory to be scanned. This is the directory which is scanned recursively.
     *
     * @param basedir The base directory for scanning. Should not be <code>null</code>.
     */
    public void setBasedir( File basedir )
    {
        this.basedir = basedir;
    }

    
Returns the base directory to be scanned. This is the directory which is scanned recursively.
Returns:
the base directory to be scanned/**
     * Returns the base directory to be scanned. This is the directory which is scanned recursively.
     *
     * @return the base directory to be scanned
     */
    public File getBasedir()
    {
        return basedir;
    }

    
Sets whether or not symbolic links should be followed.
Params:
followSymlinks – whether or not symbolic links should be followed/**
     * Sets whether or not symbolic links should be followed.
     *
     * @param followSymlinks whether or not symbolic links should be followed
     */
    public void setFollowSymlinks( boolean followSymlinks )
    {
        this.followSymlinks = followSymlinks;
    }

    
Returns whether or not the scanner has included all the files or directories it has come across so far.
Returns:
true if all files and directories which have been found so far have been included./**
     * Returns whether or not the scanner has included all the files or directories it has come across so far.
     *
     * @return <code>true</code> if all files and directories which have been found so far have been included.
     */
    public boolean isEverythingIncluded()
    {
        return everythingIncluded;
    }

    
Scans the base directory for files which match at least one include pattern and don't match any exclude patterns.
If there are selectors then the files must pass muster there, as well.
Throws:
IllegalStateException – if the base directory was set incorrectly (i.e. if it is null, doesn't
            exist, or isn't a directory)./**
     * Scans the base directory for files which match at least one include pattern and don't match any exclude patterns.
     * If there are selectors then the files must pass muster there, as well.
     *
     * @throws IllegalStateException if the base directory was set incorrectly (i.e. if it is <code>null</code>, doesn't
     *             exist, or isn't a directory).
     */
    public void scan()
        throws IllegalStateException
    {
        if ( basedir == null )
        {
            throw new IllegalStateException( "No basedir set" );
        }
        if ( !basedir.exists() )
        {
            throw new IllegalStateException( "basedir " + basedir + " does not exist" );
        }
        if ( !basedir.isDirectory() )
        {
            throw new IllegalStateException( "basedir " + basedir + " is not a directory" );
        }

        setupDefaultFilters();
        setupMatchPatterns();

        filesIncluded = new Vector<String>();
        filesNotIncluded = new Vector<String>();
        filesExcluded = new Vector<String>();
        filesDeselected = new Vector<String>();
        dirsIncluded = new Vector<String>();
        dirsNotIncluded = new Vector<String>();
        dirsExcluded = new Vector<String>();
        dirsDeselected = new Vector<String>();

        if ( isIncluded( "", tokenizedEmpty ) )
        {

            if ( !isExcluded( "", tokenizedEmpty ) )
            {
                if ( isSelected( "", basedir ) )
                {
                    dirsIncluded.addElement( "" );
                }
                else
                {
                    dirsDeselected.addElement( "" );
                }
            }
            else
            {
                dirsExcluded.addElement( "" );
            }
        }
        else
        {
            dirsNotIncluded.addElement( "" );
        }
        scandir( basedir, "", true );
    }

    
Top level invocation for a slow scan. A slow scan builds up a full list of excluded/included files/directories,
whereas a fast scan will only have full results for included files, as it ignores directories which can't
possibly hold any included files/directories.
Returns immediately if a slow scan has already been completed.
/**
     * <p>Top level invocation for a slow scan. A slow scan builds up a full list of excluded/included files/directories,
     * whereas a fast scan will only have full results for included files, as it ignores directories which can't
     * possibly hold any included files/directories.</p>
     * 
     * <p>Returns immediately if a slow scan has already been completed.</p>
     */
    protected void slowScan()
    {
        if ( haveSlowResults )
        {
            return;
        }

        String[] excl = new String[dirsExcluded.size()];
        dirsExcluded.copyInto( excl );

        String[] notIncl = new String[dirsNotIncluded.size()];
        dirsNotIncluded.copyInto( notIncl );

        for ( String anExcl : excl )
        {
            if ( !couldHoldIncluded( anExcl ) )
            {
                scandir( new File( basedir, anExcl ), anExcl + File.separator, false );
            }
        }

        for ( String aNotIncl : notIncl )
        {
            if ( !couldHoldIncluded( aNotIncl ) )
            {
                scandir( new File( basedir, aNotIncl ), aNotIncl + File.separator, false );
            }
        }

        haveSlowResults = true;
    }

    
Scans the given directory for files and directories. Found files and directories are placed in their respective
collections, based on the matching of includes, excludes, and the selectors. When a directory is found, it is
scanned recursively.
Params:
dir – The directory to scan. Must not be null.
vpath – The path relative to the base directory (needed to prevent problems with an absolute path when using
           dir). Must not be null.
fast – Whether or not this call is part of a fast scan.
See Also:
filesIncluded
filesNotIncluded
filesExcluded
dirsIncluded
dirsNotIncluded
dirsExcluded
slowScan/**
     * Scans the given directory for files and directories. Found files and directories are placed in their respective
     * collections, based on the matching of includes, excludes, and the selectors. When a directory is found, it is
     * scanned recursively.
     *
     * @param dir The directory to scan. Must not be <code>null</code>.
     * @param vpath The path relative to the base directory (needed to prevent problems with an absolute path when using
     *            dir). Must not be <code>null</code>.
     * @param fast Whether or not this call is part of a fast scan.
     * @see #filesIncluded
     * @see #filesNotIncluded
     * @see #filesExcluded
     * @see #dirsIncluded
     * @see #dirsNotIncluded
     * @see #dirsExcluded
     * @see #slowScan
     */
    protected void scandir( File dir, String vpath, boolean fast )
    {
        String[] newfiles = dir.list();

        if ( newfiles == null )
        {
            /*
             * two reasons are mentioned in the API docs for File.list (1) dir is not a directory. This is impossible as
             * we wouldn't get here in this case. (2) an IO error occurred (why doesn't it throw an exception then???)
             */

            /*
             * [jdcasey] (2) is apparently happening to me, as this is killing one of my tests... this is affecting the
             * assembly plugin, fwiw. I will initialize the newfiles array as zero-length for now. NOTE: I can't find
             * the problematic code, as it appears to come from a native method in UnixFileSystem...
             */
            /*
             * [bentmann] A null array will also be returned from list() on NTFS when dir refers to a soft link or
             * junction point whose target is not existent.
             */
            newfiles = new String[0];

            // throw new IOException( "IO error scanning directory " + dir.getAbsolutePath() );
        }

        if ( !followSymlinks )
        {
            ArrayList<String> noLinks = new ArrayList<String>();
            for ( String newfile : newfiles )
            {
                try
                {
                    if ( isParentSymbolicLink( dir, newfile ) )
                    {
                        String name = vpath + newfile;
                        File file = new File( dir, newfile );
                        if ( file.isDirectory() )
                        {
                            dirsExcluded.addElement( name );
                        }
                        else
                        {
                            filesExcluded.addElement( name );
                        }
                    }
                    else
                    {
                        noLinks.add( newfile );
                    }
                }
                catch ( IOException ioe )
                {
                    String msg = "IOException caught while checking " + "for links, couldn't get canonical path!";
                    // will be caught and redirected to Ant's logging system
                    System.err.println( msg );
                    noLinks.add( newfile );
                }
            }
            newfiles = noLinks.toArray( new String[noLinks.size()] );
        }

        if ( filenameComparator != null )
        {
            Arrays.sort( newfiles, filenameComparator );
        }

        for ( String newfile : newfiles )
        {
            String name = vpath + newfile;
            String[] tokenizedName = MatchPattern.tokenizePathToString( name, File.separator );
            File file = new File( dir, newfile );
            if ( file.isDirectory() )
            {

                if ( isIncluded( name, tokenizedName ) )
                {
                    if ( !isExcluded( name, tokenizedName ) )
                    {
                        if ( isSelected( name, file ) )
                        {
                            dirsIncluded.addElement( name );
                            if ( fast )
                            {
                                scandir( file, name + File.separator, fast );
                            }
                        }
                        else
                        {
                            everythingIncluded = false;
                            dirsDeselected.addElement( name );
                            if ( fast && couldHoldIncluded( name ) )
                            {
                                scandir( file, name + File.separator, fast );
                            }
                        }

                    }
                    else
                    {
                        everythingIncluded = false;
                        dirsExcluded.addElement( name );
                        if ( fast && couldHoldIncluded( name ) )
                        {
                            scandir( file, name + File.separator, fast );
                        }
                    }
                }
                else
                {
                    everythingIncluded = false;
                    dirsNotIncluded.addElement( name );
                    if ( fast && couldHoldIncluded( name ) )
                    {
                        scandir( file, name + File.separator, fast );
                    }
                }
                if ( !fast )
                {
                    scandir( file, name + File.separator, fast );
                }
            }
            else if ( file.isFile() )
            {
                if ( isIncluded( name, tokenizedName ) )
                {
                    if ( !isExcluded( name, tokenizedName ) )
                    {
                        if ( isSelected( name, file ) )
                        {
                            filesIncluded.addElement( name );
                        }
                        else
                        {
                            everythingIncluded = false;
                            filesDeselected.addElement( name );
                        }
                    }
                    else
                    {
                        everythingIncluded = false;
                        filesExcluded.addElement( name );
                    }
                }
                else
                {
                    everythingIncluded = false;
                    filesNotIncluded.addElement( name );
                }
            }
        }
    }

    
Tests whether a name should be selected.
Params:
name – the filename to check for selecting
file – the java.io.File object for this filename
Returns:
false when the selectors says that the file should not be selected, true
        otherwise./**
     * Tests whether a name should be selected.
     *
     * @param name the filename to check for selecting
     * @param file the java.io.File object for this filename
     * @return <code>false</code> when the selectors says that the file should not be selected, <code>true</code>
     *         otherwise.
     */
    protected boolean isSelected( String name, File file )
    {
        return true;
    }

    
Returns the names of the files which matched at least one of the include patterns and none of the exclude
patterns. The names are relative to the base directory.
Returns:
the names of the files which matched at least one of the include patterns and none of the exclude
        patterns./**
     * Returns the names of the files which matched at least one of the include patterns and none of the exclude
     * patterns. The names are relative to the base directory.
     *
     * @return the names of the files which matched at least one of the include patterns and none of the exclude
     *         patterns.
     */
    public String[] getIncludedFiles()
    {
        String[] files = new String[filesIncluded.size()];
        filesIncluded.copyInto( files );
        return files;
    }

    
Returns the names of the files which matched none of the include patterns. The names are relative to the base
directory. This involves performing a slow scan if one has not already been completed.
See Also:
slowScan
Returns:
the names of the files which matched none of the include patterns./**
     * Returns the names of the files which matched none of the include patterns. The names are relative to the base
     * directory. This involves performing a slow scan if one has not already been completed.
     *
     * @return the names of the files which matched none of the include patterns.
     * @see #slowScan
     */
    public String[] getNotIncludedFiles()
    {
        slowScan();
        String[] files = new String[filesNotIncluded.size()];
        filesNotIncluded.copyInto( files );
        return files;
    }

    
Returns the names of the files which matched at least one of the include patterns and at least one of the exclude
patterns. The names are relative to the base directory. This involves performing a slow scan if one has not
already been completed.
See Also:
slowScan
Returns:
the names of the files which matched at least one of the include patterns and at at least one of the
        exclude patterns./**
     * Returns the names of the files which matched at least one of the include patterns and at least one of the exclude
     * patterns. The names are relative to the base directory. This involves performing a slow scan if one has not
     * already been completed.
     *
     * @return the names of the files which matched at least one of the include patterns and at at least one of the
     *         exclude patterns.
     * @see #slowScan
     */
    public String[] getExcludedFiles()
    {
        slowScan();
        String[] files = new String[filesExcluded.size()];
        filesExcluded.copyInto( files );
        return files;
    }

    
Returns the names of the files which were selected out and therefore not ultimately included.
The names are relative to the base directory. This involves performing a slow scan if one has not already been
completed.
See Also:
slowScan
Returns:
the names of the files which were deselected./**
     * <p>Returns the names of the files which were selected out and therefore not ultimately included.</p>
     * 
     * <p>The names are relative to the base directory. This involves performing a slow scan if one has not already been
     * completed.</p>
     *
     * @return the names of the files which were deselected.
     * @see #slowScan
     */
    public String[] getDeselectedFiles()
    {
        slowScan();
        String[] files = new String[filesDeselected.size()];
        filesDeselected.copyInto( files );
        return files;
    }

    
Returns the names of the directories which matched at least one of the include patterns and none of the exclude
patterns. The names are relative to the base directory.
Returns:
the names of the directories which matched at least one of the include patterns and none of the exclude
        patterns./**
     * Returns the names of the directories which matched at least one of the include patterns and none of the exclude
     * patterns. The names are relative to the base directory.
     *
     * @return the names of the directories which matched at least one of the include patterns and none of the exclude
     *         patterns.
     */
    public String[] getIncludedDirectories()
    {
        String[] directories = new String[dirsIncluded.size()];
        dirsIncluded.copyInto( directories );
        return directories;
    }

    
Returns the names of the directories which matched none of the include patterns. The names are relative to the
base directory. This involves performing a slow scan if one has not already been completed.
See Also:
slowScan
Returns:
the names of the directories which matched none of the include patterns./**
     * Returns the names of the directories which matched none of the include patterns. The names are relative to the
     * base directory. This involves performing a slow scan if one has not already been completed.
     *
     * @return the names of the directories which matched none of the include patterns.
     * @see #slowScan
     */
    public String[] getNotIncludedDirectories()
    {
        slowScan();
        String[] directories = new String[dirsNotIncluded.size()];
        dirsNotIncluded.copyInto( directories );
        return directories;
    }

    
Returns the names of the directories which matched at least one of the include patterns and at least one of the
exclude patterns. The names are relative to the base directory. This involves performing a slow scan if one has
not already been completed.
See Also:
slowScan
Returns:
the names of the directories which matched at least one of the include patterns and at least one of the
        exclude patterns./**
     * Returns the names of the directories which matched at least one of the include patterns and at least one of the
     * exclude patterns. The names are relative to the base directory. This involves performing a slow scan if one has
     * not already been completed.
     *
     * @return the names of the directories which matched at least one of the include patterns and at least one of the
     *         exclude patterns.
     * @see #slowScan
     */
    public String[] getExcludedDirectories()
    {
        slowScan();
        String[] directories = new String[dirsExcluded.size()];
        dirsExcluded.copyInto( directories );
        return directories;
    }

    
Returns the names of the directories which were selected out and therefore not ultimately included.
The names are relative to the base directory. This involves performing a slow scan if one has not already been
completed.
See Also:
slowScan
Returns:
the names of the directories which were deselected./**
     * <p>Returns the names of the directories which were selected out and therefore not ultimately included.</p>
     * 
     * <p>The names are relative to the base directory. This involves performing a slow scan if one has not already been
     * completed.</p>
     *
     * @return the names of the directories which were deselected.
     * @see #slowScan
     */
    public String[] getDeselectedDirectories()
    {
        slowScan();
        String[] directories = new String[dirsDeselected.size()];
        dirsDeselected.copyInto( directories );
        return directories;
    }

    
Checks whether a given file is a symbolic link.
It doesn't really test for symbolic links but whether the canonical and absolute paths of the file are identical
- this may lead to false positives on some platforms.

Params:
parent – the parent directory of the file to test
name – the name of the file to test.
Throws:
 java.io.IOException .
 – 
Returns:
true if it's a symbolic link
Since:
Ant 1.5/**
     * <p>Checks whether a given file is a symbolic link.</p>
     * 
     * <p>It doesn't really test for symbolic links but whether the canonical and absolute paths of the file are identical
     * - this may lead to false positives on some platforms.
     * </p>
     *
     * @param parent the parent directory of the file to test
     * @param name the name of the file to test.
     * @return true if it's a symbolic link
     * @throws java.io.IOException .
     * @since Ant 1.5
     */
    public boolean isSymbolicLink( File parent, String name )
        throws IOException
    {
        if ( Java7Detector.isJava7() )
        {
            return NioFiles.isSymbolicLink( new File( parent, name ) );
        }
        File resolvedParent = new File( parent.getCanonicalPath() );
        File toTest = new File( resolvedParent, name );
        return !toTest.getAbsolutePath().equals( toTest.getCanonicalPath() );
    }

    
Checks whether the parent of this file is a symbolic link.
For java versions prior to 7 It doesn't really test for symbolic links but whether the canonical and absolute
paths of the file are identical - this may lead to false positives on some platforms.
Params:
parent – the parent directory of the file to test
name – the name of the file to test.
Throws:
 java.io.IOException .
 – 
Returns:
true if it's a symbolic link
Since:
Ant 1.5/**
     * <p>Checks whether the parent of this file is a symbolic link.</p>
     * 
     * <p>For java versions prior to 7 It doesn't really test for symbolic links but whether the canonical and absolute
     * paths of the file are identical - this may lead to false positives on some platforms.</p>
     *
     * @param parent the parent directory of the file to test
     * @param name the name of the file to test.
     * @return true if it's a symbolic link
     * @throws java.io.IOException .
     * @since Ant 1.5
     */
    public boolean isParentSymbolicLink( File parent, String name )
        throws IOException
    {
        if ( Java7Detector.isJava7() )
        {
            return NioFiles.isSymbolicLink( parent );
        }
        File resolvedParent = new File( parent.getCanonicalPath() );
        File toTest = new File( resolvedParent, name );
        return !toTest.getAbsolutePath().equals( toTest.getCanonicalPath() );
    }
}