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  /**
23   * Provides access to {@link FileNameMapping} implementations.
24   * <p/>
25   * Two basic implementations are provided by default:
26   * <ul>
27   * <li>standard: the default implementation</li>
28   * <li>full: an implementation that maps to a 'full' file name, i.e. containing the groupId</li>
29   * </ul>
30   *
31   * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
32   * @version $Id: FileNameMappingFactory.java 992847 2010-09-05 18:16:55Z snicoll $
33   */
34  public class FileNameMappingFactory
35  {
36      static final String STANDARD_FILE_NAME_MAPPING = "standard";
37  
38      static final String FULL_FILE_NAME_MAPPING = "full";
39  
40      static final String NO_VERSION_FILE_NAME_MAPPING = "no-version";
41  
42  
43      private FileNameMappingFactory()
44      {
45      }
46  
47      public static FileNameMapping getDefaultFileNameMapping()
48      {
49          return new StandardFileNameMapping();
50      }
51  
52      /**
53       * Returns the file name mapping implementation based on a logical name
54       * of a fully qualified name of the class.
55       *
56       * @param nameOrClass a name of the fqn of the implementation
57       * @return the file name mapping implementation
58       * @throws IllegalStateException if the implementation is not found
59       */
60      public static FileNameMapping getFileNameMapping( final String nameOrClass )
61          throws IllegalStateException
62      {
63          if ( STANDARD_FILE_NAME_MAPPING.equals( nameOrClass ) )
64          {
65              return getDefaultFileNameMapping();
66          }
67          if ( FULL_FILE_NAME_MAPPING.equals( nameOrClass ) )
68          {
69              return new FullFileNameMapping();
70          }
71          if ( NO_VERSION_FILE_NAME_MAPPING.equals( nameOrClass ) )
72          {
73              return new NoVersionFileNameMapping();
74          }
75          try
76          {
77              final Class c = Class.forName( nameOrClass );
78              return (FileNameMapping) c.newInstance();
79          }
80          catch ( ClassNotFoundException e )
81          {
82              throw new IllegalStateException(
83                  "File name mapping implementation[" + nameOrClass + "] was not found " + e.getMessage() );
84          }
85          catch ( InstantiationException e )
86          {
87              throw new IllegalStateException( "Could not instantiate file name mapping implementation[" + nameOrClass +
88                                                   "] make sure it has a default public constructor" );
89          }
90          catch ( IllegalAccessException e )
91          {
92              throw new IllegalStateException( "Could not access file name mapping implementation[" + nameOrClass +
93                                                   "] make sure it has a default public constructor" );
94          }
95          catch ( ClassCastException e )
96          {
97              throw new IllegalStateException(
98                  "Specified class[" + nameOrClass + "] does not implement[" + FileNameMapping.class.getName() + "]" );
99          }
100     }
101 }