001    package org.apache.maven.tools.plugin.generator;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.maven.tools.plugin.PluginToolsRequest;
023    
024    import java.io.File;
025    
026    /**
027     * Generate something, for instance a plugin report, from a plugin descriptor.
028     *
029     * @author <a href="mailto:jason@maven.org">Jason van Zyl </a>
030     * @version $Id: Generator.java 1343107 2012-05-27 21:35:40Z hboutemy $
031     */
032    public interface Generator
033    {
034    
035        /**
036         * Execute the generation for a given plugin descriptor.
037         *
038         * @param destinationDirectory required
039         * @param request required
040         * @throws IOException if any
041         * 
042         * @since 2.5
043         */
044        void execute( File destinationDirectory, PluginToolsRequest request )
045            throws GeneratorException;
046    }