1 package org.apache.maven.shared.io.scan;
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 org.apache.maven.shared.io.scan.mapping.SourceMapping;
23
24 import java.io.File;
25 import java.util.Set;
26
27 /**
28 * @author jdcasey
29 * @version $Id: ResourceInclusionScanner.java 1719477 2015-12-11 17:33:58Z khmarbaise $
30 */
31 public interface ResourceInclusionScanner
32 {
33 /**
34 * @param sourceMapping {@link SourceMapping}
35 */
36 void addSourceMapping( SourceMapping sourceMapping );
37
38 /**
39 * @param sourceDir {@link File}
40 * @param targetDir {@link File}
41 * @return The included sources.
42 * @throws InclusionScanException in case of an error.
43 */
44 Set<File> getIncludedSources( File sourceDir, File targetDir )
45 throws InclusionScanException;
46 }