001    package org.apache.maven.model.path;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *  http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import java.io.File;
023    
024    /**
025     * Resolves relative paths against a specific base directory.
026     * 
027     * @author Jason van Zyl
028     */
029    public interface PathTranslator
030    {
031    
032        /**
033         * Resolves the specified path against the given base directory. The resolved path will be absolute and uses the
034         * platform-specific file separator if a base directory is given. Otherwise, the input path will be returned
035         * unaltered.
036         * 
037         * @param path The path to resolve, may be {@code null}.
038         * @param basedir The base directory to resolve relative paths against, may be {@code null}.
039         * @return The resolved path or {@code null} if the input path was {@code null}.
040         */
041        String alignToBaseDirectory( String path, File basedir );
042    
043    }