org.fuin.srcgen4j.commons.Generator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of srcgen4j-commons Show documentation

Source code generation for Java (Commons)

The newest version!

/**
 * Copyright (C) 2015 Michael Schnell. All rights reserved. 
 * http://www.fuin.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 3 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, see http://www.gnu.org/licenses/.
 */
package org.fuin.srcgen4j.commons;

import javax.validation.constraints.NotNull;

/**
 * Generates something using a given model.
 * 
 * @param 
 *            Type of the model.
 */
public interface Generator {

    /**
     * Initializes the generator with a given configuration. This is only called once per instance. The type of the generator implementation
     * is the same as defined in {@link GeneratorConfig#getClassName()}.
     * 
     * @param config
     *            Configuration to use.
     */
    public void initialize(@NotNull GeneratorConfig config);

    /**
     * Generates something using the initially given configuration and model.
     * 
     * @param model
     *            Model to use.
     * @param incremental
     *            If this is an incremental build TRUE, else FALSE (full build).
     * 
     * @throws GenerateException
     *             Error when generating.
     */
    public void generate(@NotNull MODEL model, boolean incremental) throws GenerateException;

}