1 package org.apache.maven.shared.utils.io;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23
24 /**
25 * DirectoryWalkListener
26 *
27 * @version $Id$
28 */
29 public interface DirectoryWalkListener
30 {
31 /**
32 * The directory walking has begun.
33 *
34 * @param basedir the basedir that walk started in.
35 */
36 void directoryWalkStarting( File basedir );
37
38 /**
39 * The included entry that was encountered.
40 *
41 * @param percentage rough percentage of the walk completed. (inaccurate)
42 * @param file the file that was included.
43 */
44 void directoryWalkStep( int percentage, File file );
45
46 /**
47 * The directory walking has finished.
48 */
49 void directoryWalkFinished();
50
51 void debug( String message );
52 }