1 package org.apache.maven.model.path;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23
24 /**
25 * Resolves relative paths against a specific base directory.
26 *
27 * @author Jason van Zyl
28 */
29 public interface PathTranslator
30 {
31
32 /**
33 * Resolves the specified path against the given base directory. The resolved path will be absolute and uses the
34 * platform-specific file separator if a base directory is given. Otherwise, the input path will be returned
35 * unaltered.
36 *
37 * @param path The path to resolve, may be {@code null}.
38 * @param basedir The base directory to resolve relative paths against, may be {@code null}.
39 * @return The resolved path or {@code null} if the input path was {@code null}.
40 */
41 String alignToBaseDirectory( String path, File basedir );
42
43 }