de.thomaskrille.dropwizard_template_config.TemplateConfigBundleConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dropwizard-template-config Show documentation
Dropwizard bundle that enables you to write your config.yaml as a template.
The newest version!
package de.thomaskrille.dropwizard_template_config;

import com.google.common.base.Charsets;

import java.nio.charset.Charset;
import java.util.LinkedHashSet;
import java.util.Optional;
import java.util.Set;

/**
 * The configuration for a {@link TemplateConfigBundle}
 */
public class TemplateConfigBundleConfiguration {

    private Charset charset = Charsets.UTF_8;
    private String resourceIncludePath;
    private String fileIncludePath;
    private String outputPath;
    private Set customProviders = new LinkedHashSet<>();

    /**
     * Get the configured charset (Default: UTF-8)
     *
     * @return Charset
     */
    public Charset charset() {
        return charset;
    }

    /**
     * Set the {@link Charset} used to load, process, and output the config template.
     * The default is UTF-8.
     *
     * @param charset Template's charset
     * @return TemplateConfigBundleConfiguration
     */
    public TemplateConfigBundleConfiguration charset(Charset charset) {
        this.charset = charset;
        return this;
    }

    /**
     * Get the configured resource include path (Default: None)
     *
     * @return Optional<String>
     */
    public Optional resourceIncludePath() {
        return Optional.ofNullable(resourceIncludePath);
    }

    /**
     * Get the configured file include path (Default: None)
     *
     * @return Optional<String>
     */
    public Optional fileIncludePath() {
        return Optional.ofNullable(fileIncludePath);
    }

    /**
     * Get the configured output path for the processed config (Default: None)
     *
     * @return Optional<String>
     */
    public Optional outputPath() {
        return Optional.ofNullable(outputPath);
    }

    /**
     * Get the set of custom providers used to add variables to the configuration template (Default: Empty Set)
     *
     * @return Set<TemplateConfigVariablesProvider>
     */
    public Set customProviders() {
        return customProviders;
    }


    /**
     * Set the resource path to include config snippets from.
     * Must not be {@code null}. By default there's no value set.
     * Only one of {@code resourceIncludePath} or {@code fileIncludePath}
     * may be specified.
     *
     * @param path path to include config snippets from
     * @return TemplateConfigBundleConfiguration
     * @throws IllegalStateException if fileIncludePath is set
     */
    public TemplateConfigBundleConfiguration resourceIncludePath(String path) {
        if (fileIncludePath != null) {
            throw new IllegalStateException(
                    "A value for fileIncludePath is already present; " +
                            "only one of resourceIncludePath or fileIncludePath may be specified."
            );
        }
        this.resourceIncludePath = path;
        return this;
    }

    /**
     * Set the file path to include config snippets from.
     * Must not be {@code null}. By default there's no value set.
     * Only one of {@code resourceIncludePath} or {@code fileIncludePath}
     * may be specified.
     *
     * @param path path to include config snippets from
     * @return TemplateConfigBundleConfiguration
     * @throws IllegalStateException if resourceIncludePath is already set
     */
    public TemplateConfigBundleConfiguration fileIncludePath(String path) {
        if (resourceIncludePath != null) {
            throw new IllegalStateException(
                    "A value for resourceIncludePath is already present; " +
                            "only one of resourceIncludePath or fileIncludePath may be specified."
            );
        }
        this.fileIncludePath = path;
        return this;
    }

    /**
     * Set the path to output the filled-out config.
     * Must not be {@code null}. By default there's no value set.
     *
     * @param outputPath path to output the filled-out config
     * @return TemplateConfigBundleConfiguration
     */
    public TemplateConfigBundleConfiguration outputPath(String outputPath) {
        this.outputPath = outputPath;
        return this;
    }

    /**
     * Add a custom provider used to add your own variables to the configuration template.
     *
     * @param customProvider custom provider to add
     * @return TemplateConfigBundleConfiguration
     */
    public TemplateConfigBundleConfiguration addCustomProvider(TemplateConfigVariablesProvider customProvider) {
        this.customProviders.add(customProvider);
        return this;
    }
}