| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You 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 |
| * |
| * https://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 org.apache.tools.ant; |
| |
| import java.io.File; |
| |
| /** |
| * An interface used to describe the actions required of any type of |
| * directory scanner. |
| * |
| */ |
| public interface FileScanner { |
| /** |
| * Adds default exclusions to the current exclusions set. |
| */ |
| void addDefaultExcludes(); |
| |
| /** |
| * Returns the base directory to be scanned. |
| * This is the directory which is scanned recursively. |
| * |
| * @return the base directory to be scanned |
| */ |
| File getBasedir(); |
| |
| /** |
| * 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. |
| * |
| * @return the names of the directories which matched at least one of the |
| * include patterns and at least one of the exclude patterns. |
| */ |
| String[] getExcludedDirectories(); |
| |
| /** |
| * 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. |
| * |
| * @return the names of the files which matched at least one of the |
| * include patterns and at least one of the exclude patterns. |
| * |
| */ |
| String[] getExcludedFiles(); |
| |
| /** |
| * 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. |
| */ |
| String[] getIncludedDirectories(); |
| |
| /** |
| * 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. |
| */ |
| String[] getIncludedFiles(); |
| |
| /** |
| * Returns the names of the directories which matched none of the include |
| * patterns. The names are relative to the base directory. |
| * |
| * @return the names of the directories which matched none of the include |
| * patterns. |
| */ |
| String[] getNotIncludedDirectories(); |
| |
| /** |
| * Returns the names of the files which matched none of the include |
| * patterns. The names are relative to the base directory. |
| * |
| * @return the names of the files which matched none of the include |
| * patterns. |
| */ |
| String[] getNotIncludedFiles(); |
| |
| /** |
| * Scans the base directory for files which match at least one include |
| * pattern and don't match any exclude patterns. |
| * |
| * @exception IllegalStateException if the base directory was set |
| * incorrectly (i.e. if it is <code>null</code>, doesn't exist, |
| * or isn't a directory). |
| */ |
| void scan() throws IllegalStateException; |
| |
| /** |
| * Sets the base directory to be scanned. This is the directory which is |
| * scanned recursively. All '/' and '\' characters should be 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>. |
| */ |
| void setBasedir(String basedir); |
| |
| /** |
| * 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>. |
| */ |
| void setBasedir(File basedir); |
| |
| /** |
| * Sets the list of exclude patterns to use. |
| * |
| * @param excludes A list of exclude patterns. |
| * May be <code>null</code>, indicating that no files |
| * should be excluded. If a non-<code>null</code> list is |
| * given, all elements must be non-<code>null</code>. |
| */ |
| void setExcludes(String[] excludes); |
| |
| /** |
| * Sets the list of include patterns to use. |
| * |
| * @param includes A list of include patterns. |
| * May be <code>null</code>, indicating that all files |
| * should be included. If a non-<code>null</code> |
| * list is given, all elements must be |
| * non-<code>null</code>. |
| */ |
| void setIncludes(String[] includes); |
| |
| /** |
| * Sets whether or not the file system should be regarded as case sensitive. |
| * |
| * @param isCaseSensitive whether or not the file system should be |
| * regarded as a case sensitive one |
| */ |
| void setCaseSensitive(boolean isCaseSensitive); |
| } |