001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: *
017: */
018: package org.apache.tools.ant;
019:
020: import java.io.File;
021:
022: /**
023: * An interface used to describe the actions required of any type of
024: * directory scanner.
025: *
026: */
027: public interface FileScanner {
028: /**
029: * Adds default exclusions to the current exclusions set.
030: */
031: void addDefaultExcludes();
032:
033: /**
034: * Returns the base directory to be scanned.
035: * This is the directory which is scanned recursively.
036: *
037: * @return the base directory to be scanned
038: */
039: File getBasedir();
040:
041: /**
042: * Returns the names of the directories which matched at least one of the
043: * include patterns and at least one of the exclude patterns.
044: * The names are relative to the base directory.
045: *
046: * @return the names of the directories which matched at least one of the
047: * include patterns and at least one of the exclude patterns.
048: */
049: String[] getExcludedDirectories();
050:
051: /**
052: * Returns the names of the files which matched at least one of the
053: * include patterns and at least one of the exclude patterns.
054: * The names are relative to the base directory.
055: *
056: * @return the names of the files which matched at least one of the
057: * include patterns and at least one of the exclude patterns.
058: *
059: */
060: String[] getExcludedFiles();
061:
062: /**
063: * Returns the names of the directories which matched at least one of the
064: * include patterns and none of the exclude patterns.
065: * The names are relative to the base directory.
066: *
067: * @return the names of the directories which matched at least one of the
068: * include patterns and none of the exclude patterns.
069: */
070: String[] getIncludedDirectories();
071:
072: /**
073: * Returns the names of the files which matched at least one of the
074: * include patterns and none of the exclude patterns.
075: * The names are relative to the base directory.
076: *
077: * @return the names of the files which matched at least one of the
078: * include patterns and none of the exclude patterns.
079: */
080: String[] getIncludedFiles();
081:
082: /**
083: * Returns the names of the directories which matched none of the include
084: * patterns. The names are relative to the base directory.
085: *
086: * @return the names of the directories which matched none of the include
087: * patterns.
088: */
089: String[] getNotIncludedDirectories();
090:
091: /**
092: * Returns the names of the files which matched none of the include
093: * patterns. The names are relative to the base directory.
094: *
095: * @return the names of the files which matched none of the include
096: * patterns.
097: */
098: String[] getNotIncludedFiles();
099:
100: /**
101: * Scans the base directory for files which match at least one include
102: * pattern and don't match any exclude patterns.
103: *
104: * @exception IllegalStateException if the base directory was set
105: * incorrectly (i.e. if it is <code>null</code>, doesn't exist,
106: * or isn't a directory).
107: */
108: void scan() throws IllegalStateException;
109:
110: /**
111: * Sets the base directory to be scanned. This is the directory which is
112: * scanned recursively. All '/' and '\' characters should be replaced by
113: * <code>File.separatorChar</code>, so the separator used need not match
114: * <code>File.separatorChar</code>.
115: *
116: * @param basedir The base directory to scan.
117: * Must not be <code>null</code>.
118: */
119: void setBasedir(String basedir);
120:
121: /**
122: * Sets the base directory to be scanned. This is the directory which is
123: * scanned recursively.
124: *
125: * @param basedir The base directory for scanning.
126: * Should not be <code>null</code>.
127: */
128: void setBasedir(File basedir);
129:
130: /**
131: * Sets the list of exclude patterns to use.
132: *
133: * @param excludes A list of exclude patterns.
134: * May be <code>null</code>, indicating that no files
135: * should be excluded. If a non-<code>null</code> list is
136: * given, all elements must be non-<code>null</code>.
137: */
138: void setExcludes(String[] excludes);
139:
140: /**
141: * Sets the list of include patterns to use.
142: *
143: * @param includes A list of include patterns.
144: * May be <code>null</code>, indicating that all files
145: * should be included. If a non-<code>null</code>
146: * list is given, all elements must be
147: * non-<code>null</code>.
148: */
149: void setIncludes(String[] includes);
150:
151: /**
152: * Sets whether or not the file system should be regarded as case sensitive.
153: *
154: * @param isCaseSensitive whether or not the file system should be
155: * regarded as a case sensitive one
156: */
157: void setCaseSensitive(boolean isCaseSensitive);
158: }
|