*/
package org.codelibs.core.io;

/**
 * Object representing a collection of classes or resources.
 *
 * @author koichik
 * @see TraversalUtil
 */
public interface Traverser {

    /**
     * Returns <code>true</code> if the class file corresponding to the specified class name exists in the resources handled by this instance.
     * <p>

        final Traverser[] traversers = TraversalUtil.getTraversers("org.codelibs.core.io.xxx");
        assertThat(traversers, is(notNullValue()));
        assertThat(traversers.length, is(1));

        final Traverser traverser = traversers[0];
        assertThat(traverser instanceof FileSystemTraverser, is(true));

        assertThat(traverser.isExistClass("DummyTest"), is(true));

            traverseFileSystem(packageDir, rootPackage, handler);
        }
    }

    /**
     * Traverses classes contained in a Jar file.
     * <p>
     * If the specified Jar file has the extension <code>.war</code>, only entries whose path starts with the prefix <code>WEB-INF/classes</code> are traversed.

        assertArgumentNotNull("handler", handler);

        forEach(rootDir, null, handler);
    }

    /**
     * Traverses resources contained in the file system.
     * <p>

     */
    int FILE_READ_EA = 0x00000008; // 4
    /**
     * Permission to write extended attributes
     */
    int FILE_WRITE_EA = 0x00000010; // 5
    /**
     * Permission to execute a file or traverse a directory
     */
    int FILE_EXECUTE = 0x00000020; // 6
    /**
     * Permission to delete a file or directory
     */
    int FILE_DELETE = 0x00000040; // 7
    /**
     * Permission to read file attributes

    public static final int FILE_READ_EA = 0x00000008; // 4
    /** Permission to write extended attributes */
    public static final int FILE_WRITE_EA = 0x00000010; // 5
    /** Permission to execute a file or traverse a directory */
    public static final int FILE_EXECUTE = 0x00000020; // 6
    /** Permission to delete a file or directory */
    public static final int FILE_DELETE = 0x00000040; // 7