de.carne.gradle.plugin.java.ext.GenerateI18N Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2018-2021 Holger de Carne and contributors, All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package de.carne.gradle.plugin.java.ext;

import java.io.File;

import org.gradle.api.Project;
import org.gradle.api.file.ConfigurableFileTree;

/**
 * Configuration object for {@linkplain de.carne.gradle.plugin.java.task.GenerateI18NTask}.
 * 
 * build.gradle:
 *
 * 
 * javatools {
 *  generateI18N {
 *   ...
 *  }
 * }
 * 
 */
public class GenerateI18N {

	private final Project project;

	private boolean enabledParam = false;
	private String keyFilterParam = "^I18N_.*";
	private File genDirParam;
	private ConfigurableFileTree bundlesParam;
	@SuppressWarnings("null")
	private String lineSeparatorParam = System.getProperty("line.separator", "\n");
	@SuppressWarnings("null")
	private String encodingParam = System.getProperty("file.encoding", "UTF-8");

	/**
	 * Constructs a new {@linkplain GenerateI18N} instance.
	 *
	 * @param project the owning {@linkplain Project}.
	 */
	public GenerateI18N(Project project) {
		this.project = project;
		this.genDirParam = getGenDirDefault(project);
		this.bundlesParam = getBundlesDefault(this.project, "src/main/resources", "**/*I18N.properties");
	}

	private static File getGenDirDefault(Project project) {
		return new File(project.getBuildDir(), "/generated-src/i18n/main/java");
	}

	private static ConfigurableFileTree getBundlesDefault(Project project, String srcDir, String include) {
		ConfigurableFileTree bundles = project.fileTree(srcDir);

		bundles.include(include);
		return bundles;
	}

	/**
	 * Checks whether the generation of I18N helper classes is enabled.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  enabled = true|false // default: false
	 * }
	 * 
	 *
	 * @return {@code true} if the generation of I18N helper classes is enabled.
	 */
	public boolean isEnabled() {
		return this.enabledParam;
	}

	/**
	 * Enables/disables the generation of I18N helper classes.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  enabled = true|false // default: false
	 * }
	 * 
	 *
	 * @param enabled whether to enable or disable the generation of I18N helper classes.
	 */
	public void setEnabled(boolean enabled) {
		this.enabledParam = enabled;
	}

	/**
	 * Gets the pattern string identifying the resource bundle keys to be processed during generation.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  keyFilter = "..." // default: "^I18N_.*"
	 * }
	 * 
	 *
	 * @return the pattern string identifying the resource bundle keys to be processed during generation.
	 */
	public String getKeyFilter() {
		return this.keyFilterParam;
	}

	/**
	 * Sets the pattern string identifying the resource bundle keys to be processed during generation.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  keyFilter = "..." // default: "^I18N_.*"
	 * }
	 * 
	 *
	 * @param keyFilter the pattern string identifying the resource bundle keys to be processed during generation.
	 */
	public void setKeyFilter(String keyFilter) {
		this.keyFilterParam = keyFilter;
	}

	/**
	 * Gets the target folder for the generated I18N helper classes.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  genDir = file(...) // default: file("${buildDir}/generated-src/i18n/main/java")
	 * }
	 * 
	 *
	 * @return the target folder for the generated I18N helper classes.
	 */
	public File getGenDir() {
		return this.genDirParam;
	}

	/**
	 * Sets the target folder for the generated I18N helper classes.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  genDir = file(...) // default: file("${buildDir}/generated-src/i18n/main/java")
	 * }
	 * 
	 *
	 * @param genDir the target folder for the generated I18N helper classes.
	 */
	public void setGenDir(File genDir) {
		this.genDirParam = genDir;
	}

	/**
	 * Gets the resource bundles to process.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  bundles = fileTree(...) // default: fileTree("src/main/resources").include("**/*I18N.properties")
	 * }
	 * 
	 *
	 * @return the resource bundles to process.
	 */
	public ConfigurableFileTree getBundles() {
		return this.bundlesParam;
	}

	/**
	 * Sets the resource bundles to process.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  bundles = fileTree(...) // default: fileTree("src/main/resources").include("**/*I18N.properties")
	 * }
	 * 
	 *
	 * @param bundles the resource bundles to process.
	 */
	public void setBundles(ConfigurableFileTree bundles) {
		this.bundlesParam = bundles;
	}

	/**
	 * Gets the line separator to use during generation.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  lineSeparator = "\n" // default: System.getProperty("line.separator")
	 * }
	 * 
	 *
	 * @return the line separator to use during generation.
	 */
	public String getLineSeparator() {
		return this.lineSeparatorParam;
	}

	/**
	 * Sets the line separator to use during generation.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  lineSeparator = "\n" // default: System.getProperty("line.separator")
	 * }
	 * 
	 *
	 * @param lineSeparator the line separator to use during generation.
	 */
	public void setLineSeparator(String lineSeparator) {
		this.lineSeparatorParam = lineSeparator;
	}

	/**
	 * Gets the encoding to use during generation.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  encoding = "ISO-8859-1" // default: System.getProperty("file.encoding","UTF-8")
	 * }
	 * 
	 *
	 * @return the encoding to use during generation.
	 */
	public String getEncoding() {
		return this.encodingParam;
	}

	/**
	 * Sets the encoding to use during generation.
	 * 
	 * build.gradle:
	 *
	 * 
	 * generateI18N {
	 *  encoding = "ISO-8859-1" // default: System.getProperty("file.encoding","UTF-8")
	 * }
	 * 
	 *
	 * @param encoding the encoding to use during generation.
	 */
	public void setEncoding(String encoding) {
		this.encodingParam = encoding;
	}

}