blob: bbd826141f1d15eade96405cbc4e6b3331b2c38e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.util;
/**
* Interface to be used by SourceFileScanner.
*
* <p>Used to find the name of the target file(s) corresponding to a
* source file.</p>
*
* <p>The rule by which the file names are transformed is specified
* via the setFrom and setTo methods. The exact meaning of these is
* implementation dependent.</p>
*
*/
public interface FileNameMapper {
/**
* Sets the from part of the transformation rule.
* @param from a string.
*/
void setFrom(String from);
/**
* Sets the to part of the transformation rule.
* @param to a string.
*/
void setTo(String to);
/**
* Returns an array containing the target filename(s) for the
* given source file.
*
* <p>if the given rule doesn't apply to the source file,
* implementation must return null. SourceFileScanner will then
* omit the source file in question.</p>
*
* @param sourceFileName the name of the source file relative to
* some given basedirectory.
* @return an array of strings if the rule applies to the source file, or
* null if it does not.
*/
String[] mapFileName(String sourceFileName);
}
|
