Package com.mooltiverse.oss.nyx.configuration

Interface ConfigurationRoot

All Known Subinterfaces:

ConfigurationLayer

All Known Implementing Classes:

Configuration, Extended, Simple, SimpleConfigurationLayer

public interface ConfigurationRoot

This interface models the root configuration, with global options and nested sections.

Method Summary

Modifier and Type	Method	Description
String	getBump()	Returns the version identifier to bump as it's defined by this configuration.
ChangelogConfiguration	getChangelog()	Returns the changelog configuration section.
CommitMessageConventions	getCommitMessageConventions()	Returns the commit message convention configuration section.
String	getConfigurationFile()	Returns the path to a custom configuration file as it's defined by this configuration.
String	getDirectory()	Returns the directory to use as the working directory as it's defined by this configuration.
Boolean	getDryRun()	Returns the value of the dry run flag as it's defined by this configuration.
GitConfiguration	getGit()	Returns the Git configuration section.
String	getInitialVersion()	Returns the initial version defined by this configuration to use when no past version is available in the commit history.
String	getPreset()	Returns selected preset configuration as it's defined by this configuration.
Map<String,Attachment>	getReleaseAssets()	Returns the release assets configuration section.
Boolean	getReleaseLenient()	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.
String	getReleasePrefix()	Returns the prefix to use in release name generation as it's defined by this configuration.
ReleaseTypes	getReleaseTypes()	Returns the release types configuration section.
Boolean	getResume()	Returns the value of the resume flag as it's defined by this configuration.
Scheme	getScheme()	Returns the versioning scheme to use as it's defined by this configuration.
Map<String,ServiceConfiguration>	getServices()	Returns the services configuration section.
String	getSharedConfigurationFile()	Returns the path to a custom shared configuration file as it's defined by this configuration.
String	getStateFile()	Returns the path to the file where the Nyx State must be saved as it's defined by this configuration.
Substitutions	getSubstitutions()	Returns the substitutions configuration section.
Boolean	getSummary()	Returns the value of the summary flag as it's defined by this configuration.
String	getSummaryFile()	Returns the path to the file where the Nyx summary must be saved as it's defined by this configuration.
Verbosity	getVerbosity()	Returns the logging verbosity level as it's defined by this configuration.
String	getVersion()	Returns the version defined by this configuration.

Method Details

getBump

String getBump()
        throws DataAccessException,
IllegalPropertyException

Returns the version identifier to bump as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getChangelog

ChangelogConfiguration getChangelog()
                             throws DataAccessException,
IllegalPropertyException

Returns the changelog configuration section.

Returns:

the changelog configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getCommitMessageConventions

CommitMessageConventions getCommitMessageConventions()
                                              throws DataAccessException,
IllegalPropertyException

Returns the commit message convention configuration section.

Returns:

the commit message convention configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getConfigurationFile

String getConfigurationFile()
                     throws DataAccessException,
IllegalPropertyException

Returns the path to a custom configuration file as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getDirectory

String getDirectory()
             throws DataAccessException,
IllegalPropertyException

Returns the directory to use as the working directory as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

See Also:

• State.getDirectory()

getDryRun

Boolean getDryRun()
           throws DataAccessException,
IllegalPropertyException

Returns the value of the dry run flag as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getGit

GitConfiguration getGit()
                 throws DataAccessException,
IllegalPropertyException

Returns the Git configuration section.

Returns:

the Git configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getInitialVersion

String getInitialVersion()
                  throws DataAccessException,
IllegalPropertyException

Returns the initial version defined by this configuration to use when no past version is available in the commit history.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getPreset

String getPreset()
          throws DataAccessException,
IllegalPropertyException

Returns selected preset configuration as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getReleaseAssets

Map<String,Attachment> getReleaseAssets()
                                 throws DataAccessException,
IllegalPropertyException

Returns the release assets configuration section.

Returns:

the release assets configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getReleaseLenient

Boolean getReleaseLenient()
                   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.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getReleasePrefix

String getReleasePrefix()
                 throws DataAccessException,
IllegalPropertyException

Returns the prefix to use in release name generation as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getReleaseTypes

ReleaseTypes getReleaseTypes()
                      throws DataAccessException,
IllegalPropertyException

Returns the release types configuration section.

Returns:

the release types configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getResume

Boolean getResume()
           throws DataAccessException,
IllegalPropertyException

Returns the value of the resume flag as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getScheme

Scheme getScheme()
          throws DataAccessException,
IllegalPropertyException

Returns the versioning scheme to use as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getServices

Map<String,ServiceConfiguration> getServices()
                                      throws DataAccessException,
IllegalPropertyException

Returns the services configuration section.

Returns:

the services configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getSharedConfigurationFile

String getSharedConfigurationFile()
                           throws DataAccessException,
IllegalPropertyException

Returns the path to a custom shared configuration file as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getStateFile

String getStateFile()
             throws DataAccessException,
IllegalPropertyException

Returns the path to the file where the Nyx State must be saved as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getSubstitutions

Substitutions getSubstitutions()
                        throws DataAccessException,
IllegalPropertyException

Returns the substitutions configuration section.

Returns:

the substitutions configuration section. Never null.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getSummary

Boolean getSummary()
            throws DataAccessException,
IllegalPropertyException

Returns the value of the summary flag as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getSummaryFile

String getSummaryFile()
               throws DataAccessException,
IllegalPropertyException

Returns the path to the file where the Nyx summary must be saved as it's defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getVerbosity

Verbosity getVerbosity()
                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.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.

getVersion

String getVersion()
           throws DataAccessException,
IllegalPropertyException

Returns the version defined by this configuration.

Returns:

the configured value for this option or null if the value hasn't been defined.

Throws:

DataAccessException - in case the option cannot be read or accessed.

IllegalPropertyException - in case the option has been defined but has incorrect values or it can't be resolved.