HelpMojo.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2013-2015 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.glassfish.jersey.tools.plugins;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;

/**
 * Displays the plugin help message.
 *
 * @goal help
 * @phase process-sources
 * @aggregator
 */
public class HelpMojo extends AbstractMojo {

    private Log log;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        log.info("jersey-doc-modulelist-maven-plugin help");
        log.info("=======================================");
        log.info("Walks through the dependency tree and creates a list of maven modules in the docbook format.");
        log.info("The plugin contains a predefined list of known categories (based on groupId), "
                + "each one is represented by the separate table in the docbook output.");
        log.info("");
        log.info("Plugin needs some external files to be able to correctly format the output.");
        log.info("");
        log.info("Configuration: ");
        log.info("  <outputFileName>        specifies where the final output (docbook section) should be written");
        log.info("  <templateFileName>      the main template - contains the entire section and a placeholder "
                + GenerateJerseyModuleListMojo.CONTENT_PLACEHOLDER + " to be replaced by the generated table");
        log.info("  <tableHeaderFileName>   the header of a category table - used once per category; contains two placeholders:");
        log.info("              " + GenerateJerseyModuleListMojo.CATEGORY_CAPTION_PLACEHOLDER + " - used for the caption of "
                                                                                                    + "each category table");
        log.info("              " + GenerateJerseyModuleListMojo.CATEGORY_GROUP_ID_PLACEHOLDER + " - used to create a unique "
                                                                                                    + "id of a table");
        log.info("  <tableFooterFileName>   the footer of a category table, used once per category");
        log.info("  <tableRowFileName>      a template for a table row, used once per module. The template should contain two "
                                            + "placeholders:");
        log.info("              " + GenerateJerseyModuleListMojo.MODULE_NAME_PLACEHOLDER + " - replaced by the name of the "
                                                                                            + "module");
        log.info("              " + GenerateJerseyModuleListMojo.MODULE_DESCRIPTION_PLACEHOLDER + " - replaced by the "
                                                            + "description of the module from the module's pom.xml file");
        log.info("              " + GenerateJerseyModuleListMojo.MODULE_LINK_PATH_PLACEHOLDER + " - replaced by the relative "
                + "path of the project-description page on java.net");
        log.info("  <outputUnmatched>       specifies, if the modules not matching any predefined category should be also a "
                + "part of the output. If set to true, plugin generates a table for category called 'Other' at the end.");
        log.info("");
        log.info("");
        log.info("TARGETS:");
        log.info("  generate - main target, generates the docbook output file");
        log.info("  help     - displays this help message");
    }

    @Override
    public void setLog(org.apache.maven.plugin.logging.Log log) {
        this.log = log;
    }

}