/*
 *  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
 *
 *      https://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.
Used to find the name of the target file(s) corresponding to a
source file.
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.
/**
 * 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.
Params:
from – a string./**
     * Sets the from part of the transformation rule.
     * @param from a string.
     */
    void setFrom(String from);

    
Sets the to part of the transformation rule.
Params:
to – a string./**
     * 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.
if the given rule doesn't apply to the source file,
implementation must return null. SourceFileScanner will then
omit the source file in question.
Params:
sourceFileName – the name of the source file relative to some given basedirectory. Might be 
                      null for resources that don't provide a name.
Returns:
an array of strings if the rule applies to the source file, or
        null if it does not./**
     * 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. Might be {@code
     *                       null} for resources that don't provide a
     *                       name.
     * @return an array of strings if the rule applies to the source file, or
     *         null if it does not.
     */
    String[] mapFileName(String sourceFileName);
}