com.atlassian.jira.bean.export
Interface FilenameGenerator

public interface FilenameGenerator

Strategy pattern for abstracting filename generation such as in unique filenames or timestamp-based ones.

Method Summary

java.io.File

generate(java.lang.String basepath) Attempts to generate a File with a name using the implementor's chosen strategy.

Method Detail

generate

java.io.File generate(java.lang.String basepath)
                      throws java.io.IOException

Attempts to generate a File with a name using the implementor's chosen strategy. This contract only pertains to the generation of the File object, not to the creation of the actual physical file on disk.

Parameters:

basepath - absolute or relative prefix path for the filename.

Returns:

The full path to a prospective file.

Throws:

java.io.IOException - if a filename cannot be generated for the given basepath.