View Javadoc

1   package org.apache.maven.configuration;
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   * Postprocesses filesystem paths. For instance, a path translator might want to resolve relative paths given in the
26   * bean configuration against some base directory.
27   * 
28   * @author Benjamin Bentmann
29   */
30  public interface BeanConfigurationPathTranslator
31  {
32  
33      /**
34       * Translates the specified path.
35       * 
36       * @param path The path to translate, may be {@code null}.
37       * @return The translated path or {@code null} if none.
38       */
39      File translatePath( File path );
40  
41  }