Package com.mooltiverse.oss.nyx.data

Interface CommitMessageConventions

All Superinterfaces:

Block

public interface CommitMessageConventions
extends Block

Models the commit message conventions configuration block.

Method Summary

Modifier and Type	Method	Description
List<String>	getEnabled()	Returns the list of enabled commit message convention names.
CommitMessageConvention	getItem(String name)	Returns the commit message convention with the given name configured in this block, if any.
Map<String,CommitMessageConvention>	getItems()	Returns the map of the commit message conventions configured in this block, where keys are convention names and values are actual convention objects.

Method Detail

getEnabled

List<String> getEnabled()
                 throws DataAccessException,
                        IllegalPropertyException

Returns the list of enabled commit message convention names.

Returns:

the list of enabled commit message convention names. It may be null if not configured.

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.

getItems

Map<String,CommitMessageConvention> getItems()
                                            throws DataAccessException,
                                                   IllegalPropertyException

Returns the map of the commit message conventions configured in this block, where keys are convention names and values are actual convention objects.

Returns:

the map of the commit message conventions configured in this block, where keys are convention names and values are actual convention objects. It may be null if not configured.

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.

getItem

CommitMessageConvention getItem(String name)
                         throws DataAccessException,
                                IllegalPropertyException

Returns the commit message convention with the given name configured in this block, if any.

Parameters:

name - the name of the item to retrieve. Cannot be null.

Returns:

the commit message convention with the given name configured in this block, if any. It may be null if this block has no such item.

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.