001/*
002 *   Copyright (C) 2005 Christian Schulte <cs@schulte.it>
003 *   All rights reserved.
004 *
005 *   Redistribution and use in source and binary forms, with or without
006 *   modification, are permitted provided that the following conditions
007 *   are met:
008 *
009 *     o Redistributions of source code must retain the above copyright
010 *       notice, this list of conditions and the following disclaimer.
011 *
012 *     o Redistributions in binary form must reproduce the above copyright
013 *       notice, this list of conditions and the following disclaimer in
014 *       the documentation and/or other materials provided with the
015 *       distribution.
016 *
017 *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
018 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
019 *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
020 *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
021 *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
022 *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
023 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
024 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
026 *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027 *
028 *   $JOMC: TestInstanceShowMojo.java 5228 2016-04-24 11:08:06Z schulte $
029 *
030 */
031package org.jomc.mojo;
032
033import javax.xml.bind.JAXBElement;
034import org.apache.maven.plugin.MojoExecutionException;
035import org.apache.maven.plugins.annotations.Mojo;
036import org.apache.maven.plugins.annotations.Parameter;
037import org.apache.maven.plugins.annotations.ResolutionScope;
038import org.jomc.model.Instance;
039import org.jomc.model.Modules;
040import org.jomc.model.modlet.ModelHelper;
041import org.jomc.modlet.Model;
042import org.jomc.modlet.ModelContext;
043
044/**
045 * Displays an instance from the project's test model.
046 *
047 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
048 * @version $JOMC: TestInstanceShowMojo.java 5228 2016-04-24 11:08:06Z schulte $
049 * @since 1.1
050 */
051@Mojo( name = "show-test-instance",
052       requiresDependencyResolution = ResolutionScope.TEST,
053       threadSafe = true )
054public final class TestInstanceShowMojo extends AbstractModelShowMojo
055{
056
057    /**
058     * Identifier of the instance to show.
059     */
060    @Parameter( name = "identifier",
061                property = "jomc.identifier",
062                required = true )
063    private String identifier;
064
065    /**
066     * Execution strategy of the goal ({@code always} or {@code once-per-session}).
067     */
068    @Parameter( name = "showTestInstanceExecutionStrategy",
069                property = "jomc.showTestInstanceExecutionStrategy",
070                defaultValue = "once-per-session" )
071    private String showTestInstanceExecutionStrategy;
072
073    /**
074     * Creates a new {@code TestInstanceShowMojo} instance.
075     */
076    public TestInstanceShowMojo()
077    {
078        super();
079    }
080
081    @Override
082    protected JAXBElement<?> getDisplayModel( final ModelContext modelContext ) throws MojoExecutionException
083    {
084        final Model model = this.getModel( modelContext );
085        final Modules modules = ModelHelper.getModules( model );
086        final Instance instance = modules != null ? modules.getInstance( this.identifier ) : null;
087        JAXBElement<?> displayModel = null;
088
089        if ( instance != null )
090        {
091            displayModel = new org.jomc.model.ObjectFactory().createInstance( instance );
092        }
093
094        return displayModel;
095    }
096
097    @Override
098    protected ClassLoader getDisplayClassLoader() throws MojoExecutionException
099    {
100        return this.getTestClassLoader();
101    }
102
103    @Override
104    protected String getGoal() throws MojoExecutionException
105    {
106        return "show-test-instance";
107    }
108
109    @Override
110    protected String getExecutionStrategy() throws MojoExecutionException
111    {
112        return this.showTestInstanceExecutionStrategy;
113    }
114
115}