org.apache.maven.plugins.release.config
Interface ReleaseConfigurationStore

All Known Implementing Classes:

PropertiesReleaseConfigurationStore

public interface ReleaseConfigurationStore

Storage for reading and writing release configuration.

Author:

Brett Porter

Field Summary

static java.lang.String

ROLE The Plexus role.

Method Summary

void	delete(ReleaseConfiguration config) Remove a configuration.
ReleaseConfiguration	read(ReleaseConfiguration mergeConfiguration) Read a configuration.
void	write(ReleaseConfiguration config) Save a configuration.

Field Detail

ROLE

static final java.lang.String ROLE

The Plexus role.

Method Detail

read

ReleaseConfiguration read(ReleaseConfiguration mergeConfiguration)
                          throws ReleaseConfigurationStoreException

Read a configuration.

Parameters:

mergeConfiguration - configuration to merge with the loaded configuration. Some values are used as defaults, while others are used to override

Returns:

the configuration

Throws:

ReleaseConfigurationStoreException

write

void write(ReleaseConfiguration config)
           throws ReleaseConfigurationStoreException

Save a configuration.

Parameters:

config - the configuration

Throws:

ReleaseConfigurationStoreException

delete

void delete(ReleaseConfiguration config)

Remove a configuration.

Parameters:

config - the location of the configuration