View Javadoc

1   package org.apache.maven.plugin.ear.output;
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 org.apache.maven.artifact.Artifact;
23  
24  /**
25   * Maps file name {@link Artifact}.
26   * <p/>
27   * TODO: it might be easier to use a token-based approach instead.
28   * 
29   * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
30   * @version $Id: FileNameMapping.java 1542508 2013-11-16 13:21:35Z rfscholte $
31   */
32  public interface FileNameMapping
33  {
34  
35      /**
36       * @param useBaseVersion
37       */
38      void setUseBaseVersion( boolean useBaseVersion );
39  
40      /**
41       * Returns the file name of the specified artifact.
42       * 
43       * @param a the artifact
44       * @return the name of the file for the specified artifact
45       */
46      String mapFileName( final Artifact a );
47  }