/*
 *  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;

Implementation of FileNameMapper that always returns the source file name.
This is the default FileNameMapper for the copy and move
tasks.
/**
 * Implementation of FileNameMapper that always returns the source file name.
 *
 * <p>This is the default FileNameMapper for the copy and move
 * tasks.</p>
 *
 */
public class IdentityMapper implements FileNameMapper {

    
Ignored.
Params:
from – ignored./**
     * Ignored.
     * @param from ignored.
     */
    @Override
    public void setFrom(String from) {
    }

    
Ignored.
Params:
to – ignored./**
     * Ignored.
     * @param to ignored.
     */
    @Override
    public void setTo(String to) {
    }

    
Returns an one-element array containing the source file name.
Params:
sourceFileName – the name to map.
Returns:
the source filename in a one-element array./**
     * Returns an one-element array containing the source file name.
     * @param sourceFileName the name to map.
     * @return the source filename in a one-element array.
     */
    @Override
    public String[] mapFileName(String sourceFileName) {
        if (sourceFileName == null) {
            // The FileNameMapper#mapFileName contract states that:
            // "if the given rule doesn't apply to the source file,
            //  implementation must return null"
            // we consider a null source file name as non-matching and
            // hence return null
            return null;
        }
        return new String[] {sourceFileName};
    }
}