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   * A base class used to generate the standard name of an artifact instead of relying on the (potentially) wrong file
26   * name provided by {@link org.apache.maven.artifact.Artifact#getFile()}.
27   * 
28   * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
29   */
30  public abstract class AbstractFileNameMapping
31      implements FileNameMapping
32  {
33  
34      private boolean useBaseVersion = false;
35  
36      public final void setUseBaseVersion( boolean useBaseVersion )
37      {
38          this.useBaseVersion = useBaseVersion;
39      }
40  
41      /**
42       * Generates a standard file name for the specified {@link Artifact}.
43       * <p/>
44       * Returns something like <tt>artifactId-version[-classifier].extension</tt> if <tt>addVersion</tt> is true.
45       * Otherwise it generates something like <tt>artifactId[-classifier].extension</tt>
46       * 
47       * @param a the artifact to generate a filename from
48       * @param addVersion whether the version should be added
49       * @return the filename, with a standard format
50       */
51      protected String generateFileName( final Artifact a, boolean addVersion )
52      {
53          final String extension = a.getArtifactHandler().getExtension();
54  
55          final StringBuilder buffer = new StringBuilder( 128 );
56          buffer.append( a.getArtifactId() );
57          if ( addVersion )
58          {
59              if ( useBaseVersion )
60              {
61                  buffer.append( '-' ).append( a.getBaseVersion() );
62              }
63              else
64              {
65                  buffer.append( '-' ).append( a.getVersion() );
66              }
67          }
68          if ( a.hasClassifier() )
69          {
70              buffer.append( '-' ).append( a.getClassifier() );
71          }
72          if ( extension != null && extension.length() > 0 )
73          {
74              buffer.append( '.' ).append( extension );
75          }
76  
77          return buffer.toString();
78      }
79  }