001/*
002 * Copyright 2007 The Kuali Foundation
003 * 
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * 
008 * http://www.opensource.org/licenses/ecl2.php
009 * 
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kualigan.maven.plugins.api;
017
018import java.io.File;
019import java.util.Properties;
020
021import org.apache.maven.plugin.MojoExecutionException;
022import org.apache.maven.plugin.AbstractMojo;
023
024
025/**
026 * @author Leo Przybylski (leo [at] rsmart.com)
027 */
028public interface OverlayHelper {
029    String ROLE = OverlayHelper.class.getName();
030
031    /**
032     * Invokes the maven goal {@code archetype:generate} with the appropriate properties.
033     * 
034     */
035    void generateArchetype(final File mavenHome, final Properties archetypeProperties) throws MojoExecutionException;
036
037    void setCaller(final AbstractMojo caller);
038    
039    AbstractMojo getCaller();
040}