View Javadoc

1   /*
2    *   Copyright (C) Christian Schulte, 2005-206
3    *   All rights reserved.
4    *
5    *   Redistribution and use in source and binary forms, with or without
6    *   modification, are permitted provided that the following conditions
7    *   are met:
8    *
9    *     o Redistributions of source code must retain the above copyright
10   *       notice, this list of conditions and the following disclaimer.
11   *
12   *     o Redistributions in binary form must reproduce the above copyright
13   *       notice, this list of conditions and the following disclaimer in
14   *       the documentation and/or other materials provided with the
15   *       distribution.
16   *
17   *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
18   *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19   *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20   *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
21   *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22   *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23   *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24   *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26   *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   *
28   *   $JOMC: MainInstanceShowMojo.java 4613 2012-09-22 10:07:08Z schulte $
29   *
30   */
31  package org.jomc.mojo;
32  
33  import org.apache.maven.plugin.MojoExecutionException;
34  import org.jomc.model.Instance;
35  import org.jomc.model.Modules;
36  import org.jomc.model.ObjectFactory;
37  import org.jomc.model.modlet.ModelHelper;
38  import org.jomc.modlet.Model;
39  import org.jomc.modlet.ModelContext;
40  
41  /**
42   * Displays a project's main instance.
43   *
44   * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
45   * @version $JOMC: MainInstanceShowMojo.java 4613 2012-09-22 10:07:08Z schulte $
46   *
47   * @goal show-main-instance
48   * @threadSafe
49   * @requiresDependencyResolution test
50   * @since 1.1
51   */
52  public final class MainInstanceShowMojo extends AbstractModelShowMojo
53  {
54  
55      /**
56       * Identifier of the instance to show.
57       *
58       * @parameter expression="${jomc.identifier}"
59       * @required
60       */
61      private String identifier;
62  
63      /**
64       * Execution strategy of the goal ({@code always} or {@code once-per-session}).
65       *
66       * @parameter default-value="once-per-session" expression="${jomc.showMainInstanceExecutionStrategy}"
67       */
68      private String showMainInstanceExecutionStrategy;
69  
70      /** Creates a new {@code MainInstanceShowMojo} instance. */
71      public MainInstanceShowMojo()
72      {
73          super();
74      }
75  
76      @Override
77      protected Model getDisplayModel( final ModelContext modelContext ) throws MojoExecutionException
78      {
79          final Model model = this.getModel( modelContext );
80          final Modules modules = ModelHelper.getModules( model );
81          final Instance instance = modules != null ? modules.getInstance( this.identifier ) : null;
82          Model displayModel = null;
83  
84          if ( instance != null )
85          {
86              displayModel = new Model();
87              displayModel.setIdentifier( model.getIdentifier() );
88              displayModel.getAny().add( new ObjectFactory().createInstance( instance ) );
89          }
90  
91          return displayModel;
92      }
93  
94      @Override
95      protected ClassLoader getDisplayClassLoader() throws MojoExecutionException
96      {
97          return this.getMainClassLoader();
98      }
99  
100     @Override
101     protected String getGoal() throws MojoExecutionException
102     {
103         return "show-main-instance";
104     }
105 
106     @Override
107     protected String getExecutionStrategy() throws MojoExecutionException
108     {
109         return this.showMainInstanceExecutionStrategy;
110     }
111 
112 }