1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.finder;
18
19 import java.util.EventListener;
20
21 /**
22 * A listener interface that is called during the finder process.
23 *
24 * @author Henri Yandell
25 * @version $Id: FindListener.java 437543 2006-08-28 05:47:51Z bayard $
26 * @since 1.1
27 */
28 public interface FindListener extends EventListener {
29
30 /**
31 * Listener event called when a directory is about to be examined.
32 *
33 * @param findEvent the event object
34 */
35 public void directoryStarted(FindEvent findEvent);
36
37 /**
38 * Listener event called when a directory has been fully processed.
39 *
40 * @param findEvent the event object
41 */
42 public void directoryFinished(FindEvent findEvent);
43
44 /**
45 * Listener event called when a file is found.
46 *
47 * @param findEvent the event object
48 */
49 public void fileFound(FindEvent findEvent);
50
51 }