1 /*
2 * Copyright 2007-2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.exceptions.report.scan;
17
18 import java.io.File;
19
20 import org.apache.tools.ant.DirectoryScanner;
21
22 /**
23 * Interface to generate scanners.
24 */
25 public interface ScannerFactory
26 {
27 // ********************************* Fields *********************************
28
29 // --- constants ------------------------------------------------------------
30
31 // ****************************** Initializer *******************************
32
33 // ****************************** Inner Classes *****************************
34
35 // ********************************* Methods ********************************
36
37 // --- get&set --------------------------------------------------------------
38
39 // --- business -------------------------------------------------------------
40
41 /**
42 * Creates the scanner with the given root directory set.
43 *
44 * @param root the root directory to scan.
45 * @return the scanner for the given root directory.
46 */
47 DirectoryScanner createScanner(String root);
48
49 /**
50 * Creates the scanner with the given root directory set.
51 *
52 * @param root the root directory to scan.
53 * @return the scanner for the given root directory.
54 */
55 DirectoryScanner createScanner(File root);
56
57 // --- object basics --------------------------------------------------------
58 }