com.mooltiverse.oss.nyx.configuration.ConfigurationRoot 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.configuration;

import java.util.Map;

import com.mooltiverse.oss.nyx.entities.Attachment;
import com.mooltiverse.oss.nyx.entities.ChangelogConfiguration;
import com.mooltiverse.oss.nyx.entities.CommitMessageConventions;
import com.mooltiverse.oss.nyx.entities.GitConfiguration;
import com.mooltiverse.oss.nyx.entities.IllegalPropertyException;
import com.mooltiverse.oss.nyx.entities.ReleaseTypes;
import com.mooltiverse.oss.nyx.entities.ServiceConfiguration;
import com.mooltiverse.oss.nyx.entities.Substitutions;
import com.mooltiverse.oss.nyx.entities.Verbosity;
import com.mooltiverse.oss.nyx.io.DataAccessException;
import com.mooltiverse.oss.nyx.state.State;
import com.mooltiverse.oss.nyx.version.Scheme;

/**
 * This interface models the root configuration, with global options and nested sections.
 */
public interface ConfigurationRoot {
    /**
     * Returns the version identifier to bump as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public String getBump()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the changelog configuration section.
     * 
     * @return the changelog configuration section. Never {@code null}.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public ChangelogConfiguration getChangelog()
        throws DataAccessException, IllegalPropertyException;
    
    /**
     * Returns the commit message convention configuration section.
     * 
     * @return the commit message convention configuration section. Never {@code null}.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public CommitMessageConventions getCommitMessageConventions()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the path to a custom configuration file as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public String getConfigurationFile()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the directory to use as the working directory as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     * 
     * @see State#getDirectory()
     */
    public String getDirectory()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the value of the dry run flag as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public Boolean getDryRun()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the Git configuration section.
     * 
     * @return the Git configuration section. Never {@code null}.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public GitConfiguration getGit()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the initial version defined by this configuration to use when no past version is available in the commit history.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public String getInitialVersion()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns selected preset configuration as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public String getPreset()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the release assets configuration section.
     * 
     * @return the release assets configuration section. Never {@code null}.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public Map getReleaseAssets()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the flag that enables tolerance in reading release names with arbitrary prefixes or extra non critical characters
     * as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public Boolean getReleaseLenient()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the prefix to use in release name generation as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public String getReleasePrefix()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the release types configuration section.
     * 
     * @return the release types configuration section. Never {@code null}.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public ReleaseTypes getReleaseTypes()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the value of the resume flag as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public Boolean getResume()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the versioning scheme to use as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public Scheme getScheme()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the services configuration section.
     * 
     * @return the services configuration section. Never {@code null}.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public Map getServices()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the path to a custom shared configuration file as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public String getSharedConfigurationFile()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the path to the file where the Nyx {@link State} must be saved as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public String getStateFile()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the substitutions configuration section.
     * 
     * @return the substitutions configuration section. Never {@code null}.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public Substitutions getSubstitutions()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the value of the summary flag as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public Boolean getSummary()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the path to the file where the Nyx summary must be saved as it's defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public String getSummaryFile()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the logging verbosity level as it's defined by this configuration.
     * 
     * Please note that the verbosity option is actually ignored in this library implementation as the event filtering based
     * on the verbosity needs to be configured outside this library, depending on the logging framework deployed along with SLF4J.
     * See here for more.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public Verbosity getVerbosity()
        throws DataAccessException, IllegalPropertyException;

    /**
     * Returns the version defined by this configuration.
     * 
     * @return the configured value for this option or {@code null} if the value hasn't been defined.
     * 
     * @throws DataAccessException in case the option cannot be read or accessed.
     * @throws IllegalPropertyException in case the option has been defined but has incorrect values or it can't be resolved.
     */
    public String getVersion()
        throws DataAccessException, IllegalPropertyException;
}