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