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