de.smartics.properties.config.transfer.filesystem
Class FileSystemPropertySink

java.lang.Object
  de.smartics.properties.config.transfer.filesystem.FileSystemPropertySink

All Implemented Interfaces:

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

public final class FileSystemPropertySink
     
     

      
      extends 
      
      Object
     
     
     
     

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

Writes properties to a folder.

Constructor Summary

FileSystemPropertySink(File targetFolder)
Convenience constructor to create native properties files.

FileSystemPropertySink(File targetFolder, PropertiesFormat outputFormat)
Default constructor.

Method Summary

void	clear()
void	close()
void	write(Iterable<de.smartics.properties.api.config.domain.PropertyProvider> providers)
void	write(de.smartics.properties.api.config.domain.PropertyProvider provider)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemPropertySink

public FileSystemPropertySink(File targetFolder)

Convenience constructor to create native properties files.

Parameters:

targetFolder - the name of the folder the properties definitions are written to.

FileSystemPropertySink

public FileSystemPropertySink(File targetFolder,
                              PropertiesFormat outputFormat)
                       throws NullPointerException

Default constructor.

Parameters:

targetFolder - the name of the folder the properties definitions are written to.

outputFormat - the format the property definition files will be written to.

Throws:

NullPointerException - if targetFolder or outputFormat is null.

Method Detail

clear

public void clear()
           throws de.smartics.properties.api.config.transfer.TransferException

Specified by:

clear in interface de.smartics.properties.api.config.transfer.PropertySink

Throws:

de.smartics.properties.api.config.transfer.TransferException

write

public void write(de.smartics.properties.api.config.domain.PropertyProvider provider)
           throws de.smartics.properties.api.config.transfer.TransferException

Specified by:

write in interface de.smartics.properties.api.config.transfer.PropertySink

Throws:

de.smartics.properties.api.config.transfer.TransferException

write

public void write(Iterable<de.smartics.properties.api.config.domain.PropertyProvider> providers)
           throws de.smartics.properties.api.config.transfer.TransferException

Specified by:

write in interface de.smartics.properties.api.config.transfer.PropertySink

Throws:

de.smartics.properties.api.config.transfer.TransferException

close

public void close()
           throws de.smartics.properties.api.config.transfer.TransferException

This is a no-op.

Specified by:

close in interface de.smartics.properties.api.config.transfer.PropertySink

Throws:

de.smartics.properties.api.config.transfer.TransferException