org.nuiton.eugene.TemplateConfiguration Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * EUGene :: EUGene Core
 * %%
 * Copyright (C) 2004 - 2017 Code Lutin, Ultreia.io
 * %%
 * This program 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 program 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 General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */
package org.nuiton.eugene;

import io.ultreia.java4all.i18n.spi.builder.I18nKeySet;
import org.nuiton.eugene.writer.WriterReport;

import java.util.Objects;
import java.util.Properties;

/**
 * Contract of a {@link Template} configuration
 *
 * @author Tony Chemit - [email protected]
 * @since 2.0.2
 */
public interface TemplateConfiguration {

    String PROP_OVERWRITE = "overwrite";

    String PROP_VERBOSE = "verbose";

    String PROP_ENCODING = "encoding";

    String PROP_CLASS_LOADER = "classLoader";

    String PROP_DEFAULT_PACKAGE = "defaultPackage";

    String PROP_LAST_MODIFIED_SOURCE = "lastModifiedSource";

    String PROP_GENERATED_PACKAGES = "generatedPackages";

    String PROP_EXCLUDE_TEMPLATES = "excludeTemplates";

    String PROP_WRITER_REPORT = "writerReport";

    String PROP_OUTPUT_DIRECTORY = "outputDirectory";

    String PROP_RESOURCE_DIRECTORY = "resourceDirectory";

    String PROP_I18N_GETTER_FILE = "i18nGetterFile";

    /**
     * @return {@code true} if must regenerate files even if they are up to date
     */
    boolean isOverwrite();

    /** @return {@code true} if build is verbose. */
    boolean isVerbose();

    /** @return encoding to use to read and write files */
    String getEncoding();

    /** @return the classloader to use to seek for resources */
    ClassLoader getClassLoader();

    WriterReport getWriterReport();

    long getLastModifiedSource();

    Properties getProperties();

    String getProperty(String key);

     V getProperty(String key, Class type);

    void setProperty(String key, Object value);

    default I18nKeySet getI18nGetterFile() {
        return getProperty(PROP_I18N_GETTER_FILE, I18nKeySet.class);
    }

    default void setI18nGetterFile(I18nKeySet i18nKeysFile) {
        setProperty(PROP_I18N_GETTER_FILE, Objects.requireNonNull(i18nKeysFile));
    }

}