001/*
002 *   Copyright (C) Christian Schulte, 2005-206
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: MainModuleAttachMojo.java 4613 2012-09-22 10:07:08Z schulte $
029 *
030 */
031package org.jomc.mojo;
032
033import java.io.File;
034
035/**
036 * Attaches a project's main module artifact.
037 *
038 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
039 * @version $JOMC: MainModuleAttachMojo.java 4613 2012-09-22 10:07:08Z schulte $
040 *
041 * @phase process-resources
042 * @goal attach-main-module
043 */
044public final class MainModuleAttachMojo extends AbstractAttachMojo
045{
046
047    /**
048     * File of the attached module artifact.
049     *
050     * @parameter expression="${jomc.mainModuleArtifactFile}"
051     *            default-value="${project.build.outputDirectory}/META-INF/jomc.xml"
052     */
053    private File mainModuleArtifactFile;
054
055    /**
056     * Classifier of the attached module artifact.
057     *
058     * @parameter expression="${jomc.mainModuleArtifactClassifier}" default-value="jomc-module"
059     */
060    private String mainModuleArtifactClassifier;
061
062    /**
063     * Type of the attached module artifact.
064     *
065     * @parameter expression="${jomc.mainModuleArtifactType}" default-value="xml"
066     */
067    private String mainModuleArtifactType;
068
069    /**
070     * Execution strategy of the goal ({@code always} or {@code once-per-session}).
071     *
072     * @parameter default-value="once-per-session" expression="${jomc.attachMainModuleExecutionStrategy}"
073     * @since 1.1
074     */
075    private String attachMainModuleExecutionStrategy;
076
077    /** Creates a new {@code MainModuleAttachMojo} instance. */
078    public MainModuleAttachMojo()
079    {
080        super();
081    }
082
083    @Override
084    protected File getArtifactFile()
085    {
086        return this.mainModuleArtifactFile;
087    }
088
089    @Override
090    protected String getArtifactClassifier()
091    {
092        return this.mainModuleArtifactClassifier;
093    }
094
095    @Override
096    protected String getArtifactType()
097    {
098        return this.mainModuleArtifactType;
099    }
100
101    @Override
102    protected String getExecutionStrategy()
103    {
104        return this.attachMainModuleExecutionStrategy;
105    }
106
107}