Package com.mooltiverse.oss.nyx.configuration

Interface Root

All Superinterfaces:

Block

All Known Subinterfaces:

ConfigurationLayer

All Known Implementing Classes:

Configuration

public interface Root
extends Block

This interface models the configuration root block, with global options.

Method Summary

Modifier and Type	Method	Description
String	getBump()	Returns the version identifier to bump as it's defined by this configuration.
CommitMessageConventions	getCommitMessageConventions()	Returns the commit message convention configuration block.
File	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.
String	getInitialVersion()	Returns the initial version defined by this configuration to use when no past version is available in the commit history.
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.
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.
String	getStateFile()	Returns the path to the file where the Nyx State 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 Detail

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.

getCommitMessageConventions

CommitMessageConventions getCommitMessageConventions()
                                              throws DataAccessException,
                                                     IllegalPropertyException

Returns the commit message convention configuration block.

Returns:

the commit message convention configuration block. 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.

getDirectory

File 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()

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.

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.

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.

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.

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.

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.

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.