com.mooltiverse.oss.nyx.entities.ChangelogConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java Show documentation
com.mooltiverse.oss.nyx:java:3.0.6 All the Nyx Java artifacts
The newest version!
/*
 * Copyright 2020 Mooltiverse
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mooltiverse.oss.nyx.entities;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

/**
 * This object models the fields used to configure the changelog generation.
 */
public class ChangelogConfiguration {
    /**
     * The flag instructing if and when to append contents to the existing changelog file.
     */
    private String append = null;

    /**
     * The path to the destination file.
     */
    private String path = null;

    /**
     * The map of sections and commit types.
     */
    private Map sections = null;

    /**
     * The map of substitution strings.
     */
    private Map substitutions = null;

    /**
     * The path to the optional template file.
     */
    private String template = null;

    /**
     * Default constructor.
     */
    public ChangelogConfiguration() {
        super();
        this.sections = new HashMap();
        this.substitutions = new HashMap();
    }

    /**
     * Standard constructor.
     * 
     * @param append the flag instructing if and when to append contents to the existing changelog file. It may be {@code null}.
     * @param path the path to the destination file. It may be {@code null}.
     * @param sections the map of sections and commit types.
     * @param template the path to the optional template file. It may be {@code null}.
     * @param substitutions the map of substitution strings.
     * 
     * @throws NullPointerException if some mandatory argument is {@code null}
     */
    public ChangelogConfiguration(String append, String path, Map sections, String template, Map substitutions) {
        super();
        Objects.requireNonNull(sections);
        this.append = append;
        this.path = path;
        this.sections = sections;
        this.template = template;
        this.substitutions = substitutions;
    }

    /**
     * Returns the flag instructing if and when to append contents to the existing changelog file. It may be {@code null}.
     * 
     * @return the flag instructing if and when to append contents to the existing changelog file. It may be {@code null}.
     */
    public String getAppend() {
        return append;
    }

    /**
     * Sets the flag instructing if and when to append contents to the existing changelog file. It may be {@code null}.
     * 
     * @param append the flag instructing if and when to append contents to the existing changelog file. It may be {@code null}.
     */
    public void setAppend(String append) {
        this.append = append;
    }

    /**
     * Returns the path to the destination file. It may be {@code null}.
     * 
     * @return the path to the destination file. It may be {@code null}.
     */
    public String getPath() {
        return path;
    }

    /**
     * Sets the path to the destination file. It may be {@code null}.
     * 
     * @param path the path to the destination file. It may be {@code null}.
     */
    public void setPath(String path) {
        this.path = path;
    }

    /**
     * Returns the map of sections and commit types.
     * 
     * @return the map of sections and commit types.
     */
    public Map getSections() {
        return sections;
    }

    /**
     * Sets the map of sections and commit types.
     * 
     * @param sections the map of sections and commit types.
     */
    public void setSections(Map sections) {
        this.sections = sections;
    }

    /**
     * Returns the map of substitution strings.
     * 
     * @return the map of substitution strings.
     */
    public Map getSubstitutions() {
        return substitutions;
    }

    /**
     * Sets the map of substitution strings.
     * 
     * @param substitutions the map of substitution strings.
     */
    public void setSubstitutions(Map substitutions) {
        this.substitutions = substitutions;
    }

    /**
     * Returns the path to the optional template file. It may be {@code null}.
     * 
     * @return the path to the optional template file. It may be {@code null}.
     */
    public String getTemplate() {
        return template;
    }

    /**
     * Sets the path to the optional template file. It may be {@code null}.
     * 
     * @param template the path to the optional template file. It may be {@code null}.
     */
    public void setTemplate(String template) {
        this.template = template;
    }
}