org.tentackle.maven.plugin.jlink.TemplateModelFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tentackle-jlink-maven-plugin Show documentation

Maven Plugin to Create Self-Contained Applications

There is a newer version: 21.16.1.0

Show newest version

/*
 * Tentackle - https://tentackle.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.tentackle.maven.plugin.jlink;

import org.apache.maven.plugin.MojoExecutionException;

import org.tentackle.common.ServiceFactory;
import org.tentackle.maven.TemplateModel;

interface TemplateModelFactoryHolder {
  TemplateModelFactory INSTANCE = ServiceFactory.createService(TemplateModelFactory.class, DefaultTemplateModelFactory.class, false);
}

/**
 * Factory for the freemarker template model.
 * 
 * May be replaced via @{@link org.tentackle.common.Service} annotation from within an application-specific plugin dependency.
 * For example, to add template variables from other sources.
 * 

 * Example:
 * 
 *   @Service(TemplateModelFactory.class)
 *   public class SpecialTemplateModelFactory implements TemplateModelFactory {
 *
 *     @Override
 *     public TemplateModel create(AbstractJlinkMojo mojo, JlinkResolver.Result result) throws MojoExecutionException {
 *       ...
 *     }
 *   }
 * 
 *
 * Add as plugin dependency:
 *
 *  *   <plugin>
 *     <groupId>org.tentackle</groupId>
 *     <artifactId>tentackle-jlink-maven-plugin</artifactId>
 *     <dependencies>
 *       <dependency>
 *         <groupId>com.example</groupId>
 *         <artifactId>special-creator</artifactId>
 *         <version>1.0</version>
 *       </dependency>
 *     </dependencies>
 *     <configuration>
 *       ...
 *     </configuration>
 *   </plugin>
 * 
 */
public interface TemplateModelFactory {

  /**
   * The singleton.
   *
   * @return the singleton
   */
  static TemplateModelFactory getInstance() {
    return TemplateModelFactoryHolder.INSTANCE;
  }

  /**
   * Creates the template model.
   *
   * @param mojo the mojo
   * @param result the resolver result
   * @return the model
   * @throws MojoExecutionException if model creation failed
   */
  TemplateModel create(AbstractJLinkMojo mojo, JLinkResolver.Result result) throws MojoExecutionException;

}