org.neo4j.build.plugins.docs.AssembleMojo Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2011-2012 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see .
 */
package org.neo4j.build.plugins.docs;


import org.apache.maven.plugin.MojoExecutionException;

/**
 * Goal which assembles docs.
 * 
 * @goal assemble
 * @phase package
 * @threadsafe
 */
public class AssembleMojo extends AbstractDocsMojo
{
    /**
     * Set to "true" to skip execution.
     * 
     * @parameter expression="${skipdocs}" default-value="false"
     */
    protected boolean skipdocs;

    @Override
    public void execute() throws MojoExecutionException
    {
        if ( skipdocs )
        {
            skip();
        }
        else
        {
            new DocsAssembler( sourceDirectories, filter, getLog(),
                    session, project, projectHelper, resourceFiltering ).doAssembly();
        }
    }

    protected void skip()
    {
        getLog().info( "Docs-plugin execution skipped." );
    }
}