View Javadoc
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.api.services.model;
20  
21  import java.nio.file.Path;
22  
23  /**
24   * Resolves relative paths against a specific base directory.
25   *
26   */
27  public interface PathTranslator {
28  
29      /**
30       * Resolves the specified path against the given base directory. The resolved path will be absolute and uses the
31       * platform-specific file separator if a base directory is given. Otherwise, the input path will be returned
32       * unaltered.
33       *
34       * @param path The path to resolve, may be {@code null}.
35       * @param basedir The base directory to resolve relative paths against, may be {@code null}.
36       * @return The resolved path or {@code null} if the input path was {@code null}.
37       * @since 4.0.0
38       */
39      String alignToBaseDirectory(String path, Path basedir);
40  }