diff options
Diffstat (limited to 'framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/util/FileNameMapper.java')
-rw-r--r-- | framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/util/FileNameMapper.java | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/util/FileNameMapper.java b/framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/util/FileNameMapper.java new file mode 100644 index 00000000..bbd82614 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/src/main/org/apache/tools/ant/util/FileNameMapper.java @@ -0,0 +1,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); +} |