de.smartics.properties.api.config.transfer
Interface PropertySink

All Known Implementing Classes:

FileSystemPropertySink, JdbcPropertySink, StreamPropertySink

public interface PropertySink

A sink to write properties to.

Method Summary

void	clear() Removes all information from the sink.
void	close() Closes the sink.
void	write(Iterable<PropertyProvider> providers) Writes the property definitions provided by the given providers.
void	write(PropertyProvider provider) Writes the property definitions provided by the given provider.

Method Detail

clear

void clear()
           throws TransferException

Removes all information from the sink.

Throws:

TransferException - on any problem clearing the sink.

write

void write(PropertyProvider provider)
           throws TransferException

Writes the property definitions provided by the given provider.

It is assumed that the writing is transactional. If it is not, the implementation should document that it isn't.

Parameters:

provider - the provider of property definitions.

Throws:

TransferException - on any problem writing the definitions to this sink.

write

void write(Iterable<PropertyProvider> providers)
           throws TransferException

Writes the property definitions provided by the given providers.

It is assumed that the writing is transactional. If it is not, the implementation should document that it isn't.

Parameters:

providers - the list of providers to add their property definitions.

Throws:

TransferException - on any problem writing property definitions to this sink.

close

void close()
           throws TransferException

Closes the sink. No more writing to the sink will be allowed after the sink is closed.

Throws:

TransferException - on any problem closing the sink.