1 | /*
|
---|
2 | * Copyright 2000,2004 The Apache Software Foundation
|
---|
3 | *
|
---|
4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
---|
5 | * you may not use this file except in compliance with the License.
|
---|
6 | * You may obtain a copy of the License at
|
---|
7 | *
|
---|
8 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
9 | *
|
---|
10 | * Unless required by applicable law or agreed to in writing, software
|
---|
11 | * distributed under the License is distributed on an "AS IS" BASIS,
|
---|
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
13 | * See the License for the specific language governing permissions and
|
---|
14 | * limitations under the License.
|
---|
15 | *
|
---|
16 | */
|
---|
17 |
|
---|
18 | package org.apache.tools.ant.util;
|
---|
19 |
|
---|
20 | /**
|
---|
21 | * Interface to be used by SourceFileScanner.
|
---|
22 | *
|
---|
23 | * <p>Used to find the name of the target file(s) corresponding to a
|
---|
24 | * source file.</p>
|
---|
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 | */
|
---|
31 | public interface FileNameMapper {
|
---|
32 |
|
---|
33 | /**
|
---|
34 | * Sets the from part of the transformation rule.
|
---|
35 | */
|
---|
36 | void setFrom(String from);
|
---|
37 |
|
---|
38 | /**
|
---|
39 | * Sets the to part of the transformation rule.
|
---|
40 | */
|
---|
41 | void setTo(String to);
|
---|
42 |
|
---|
43 | /**
|
---|
44 | * Returns an array containing the target filename(s) for the
|
---|
45 | * given source file.
|
---|
46 | *
|
---|
47 | * <p>if the given rule doesn't apply to the source file,
|
---|
48 | * implementation must return null. SourceFileScanner will then
|
---|
49 | * omit the source file in question.</p>
|
---|
50 | *
|
---|
51 | * @param sourceFileName the name of the source file relative to
|
---|
52 | * some given basedirectory.
|
---|
53 | */
|
---|
54 | String[] mapFileName(String sourceFileName);
|
---|
55 | }
|
---|