1 package org.apache.maven.plugin.clean;
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 /**
23 * Determines whether a path is selected for deletion. The pathnames used for method parameters will be relative to some
24 * base directory and use {@link java.io.File#separatorChar} as separator.
25 *
26 * @author Benjamin Bentmann
27 */
28 interface Selector
29 {
30
31 /**
32 * Determines whether a path is selected for deletion.
33 *
34 * @param pathname The pathname to test, must not be <code>null</code>.
35 * @return <code>true</code> if the given path is selected for deletion, <code>false</code> otherwise.
36 */
37 boolean isSelected( String pathname );
38
39 /**
40 * Determines whether a directory could contain selected paths.
41 *
42 * @param pathname The directory pathname to test, must not be <code>null</code>.
43 * @return <code>true</code> if the given directory might contain selected paths, <code>false</code> if the
44 * directory will definitively not contain selected paths..
45 */
46 boolean couldHoldSelected( String pathname );
47
48 }