View Javadoc
1   package org.codehaus.plexus.components.io.filemappers;
2   
3   /*
4    * Copyright 2007 The Codehaus Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * 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, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  /**
20   * Interface of a component, which may be used to map file names.
21   */
22  public interface FileMapper
23  {
24      /**
25       * Role used to register component implementations with the container.
26       */
27      public static final String ROLE = FileMapper.class.getName();
28  
29      /**
30       * The default role-hint: "default".
31       */
32      public static final String DEFAULT_ROLE_HINT = "default";
33  
34      /**
35       * Maps the given source name to a target name.
36       * 
37       * @param pName
38       *            The source name.
39       * @return The target name.
40       * @throws IllegalArgumentException
41       *             The source name is null or empty.
42       */
43      public String getMappedFileName( String pName );
44  }