FileNameMapper


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