1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. 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,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.shared.model.fileset.mappers;
20
21 /**
22 * Interface used by SourceFileScanner
23 * to find the name of the target file(s) corresponding to a
24 * source file.
25 *
26 * <p>The rule by which the file names are transformed is specified
27 * via the setFrom and setTo methods. The exact meaning of these is
28 * implementation dependent.</p>
29 */
30 public interface FileNameMapper {
31 /**
32 * Sets the from part of the transformation rule.
33 *
34 * @param from the source
35 */
36 void setFrom(String from);
37
38 /**
39 * Sets the to part of the transformation rule.
40 *
41 * @param to the destination
42 */
43 void setTo(String to);
44
45 /**
46 * Returns the target filename for the
47 * given source file.
48 *
49 * <p>If the given rule doesn't apply to the source file,
50 * the implementation must return null. SourceFileScanner will then
51 * omit the source file in question.</p>
52 *
53 * @param sourceFileName the name of the source file relative to some given base directory
54 * @return the target filename for the given source file
55 */
56 String mapFileName(String sourceFileName);
57 }