1 /*
2 * Copyright (c) 2003, Henri Yandell
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or
6 * without modification, are permitted provided that the
7 * following conditions are met:
8 *
9 * + Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * + Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * + Neither the name of Genjava-Core nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32 // @file Finder.java
33 // @author bayard@generationjava.com
34 // @create 2001-03-25
35
36 package com.generationjava.io.find;
37
38 import java.io.File;
39 import java.util.Map;
40
41 /***
42 * A Finder of Files. Though the structure the files are in is
43 * unspecified.
44 */
45 public interface Finder {
46
47 // MODIFIER
48 public static final String NOT = "NOT_";
49
50 // OPTIONS
51 public static final String DAYSTART = "DAYSTART";
52 public static final String DEPTH = "DEPTH";
53 public static final String MAXDEPTH = "MAXDEPTH";
54 public static final String MINDEPTH = "MINDEPTH";
55 public static final String IGNORE_HIDDEN_DIRS = "IGNORE_HIDDEN_DIRS";
56
57 // Time based tests
58 public static final String MIN = "MIN";
59 public static final String NEWER = "NEWER";
60 public static final String TIME = "TIME";
61
62 // size based tests
63 public static final String EMPTY = "EMPTY";
64 public static final String SIZE = "SIZE";
65
66 // name based tests
67 public static final String NAME = "NAME";
68 public static final String INAME = "INAME";
69 public static final String PATH = "PATH";
70 public static final String IPATH = "IPATH";
71 public static final String REGEX = "REGEX";
72 public static final String IREGEX = "IREGEX";
73
74 // type of file
75 public static final String TYPE = "TYPE"; // supports 'd' and 'f'
76 public static final String HIDDEN = "HIDDEN";
77
78 // permission replacements
79 public static final String CAN_READ = "CAN_READ";
80 public static final String CAN_WRITE = "CAN_WRITE";
81
82 public void addFindListener(FindListener fl);
83 public void removeFindListener(FindListener fl);
84
85 public File[] find(File root);
86 public File[] find(File root, Map options);
87
88 }