org.apache.maven.shared.release.config
Interface ReleaseDescriptorStore

All Known Implementing Classes:

PropertiesReleaseDescriptorStore

public interface ReleaseDescriptorStore

Storage for reading and writing release configuration.

Author:

Brett Porter

Field Summary

static String

ROLE The Plexus role.

Method Summary

void	delete(ReleaseDescriptor config) Remove a configuration.
ReleaseDescriptor	read(ReleaseDescriptor mergeDescriptor) Read a configuration.
void	write(ReleaseDescriptor config) Save a configuration.

Field Detail

ROLE

static final String ROLE

The Plexus role.

Method Detail

read

ReleaseDescriptor read(ReleaseDescriptor mergeDescriptor)
                       throws ReleaseDescriptorStoreException

Read a configuration.

Parameters:

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

Returns:

the configuration

Throws:

ReleaseDescriptorStoreException

write

void write(ReleaseDescriptor config)
           throws ReleaseDescriptorStoreException

Save a configuration.

Parameters:

config - the configuration

Throws:

ReleaseDescriptorStoreException

delete

void delete(ReleaseDescriptor config)

Remove a configuration.

Parameters:

config - the location of the configuration