de.intarsys.tools.file

Class FileAttachmentTools

java.lang.Object

de.intarsys.tools.file.FileAttachmentTools

public class FileAttachmentTools
extends Object

Utility methods to handle attachment relationships between files.

Constructor Summary

Constructors

Constructor and Description
FileAttachmentTools()

Method Summary

Methods

Modifier and Type	Method and Description
static List	createAttachments(File master, File[] files, String extensions) Create a list of File instances selected from the array of candidates that are recognized as attachments to master.
static List	createAttachments(File master, String extensions) Find all attachments to master.
static void	deleteAttachments(List attachments)
static boolean	existsAttachments(File master, File[] files, String extensions) true if all required attachments for master are available.
static boolean	isAttachment(File file, String extensions) true, if file is an attachment as defined in the extensions. extensions is a ";" separated list of extensions in the form ".ext".
static File	moveAttachment(File master, File attachment, File movedFile, boolean delete)
static File	moveAttachment(File master, File attachment, File movedFile, boolean delete, boolean keepLastModified) Given the original master file and an attachment to this file, move the attachments to the correct location for the new master file location given in movedFile.
static List	moveAttachments(File master, List attachments, File movedFile, boolean delete)
static List	moveAttachments(File master, List attachments, File movedFile, boolean delete, boolean keepLastModified) Given the original master file and the list of attachments to this file, move all attachments to the correct location for the new master file location given in movedFile.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileAttachmentTools

public FileAttachmentTools()

Method Detail

createAttachments

public static List createAttachments(File master,
                     File[] files,
                     String extensions)

Create a list of File instances selected from the array of candidates that are recognized as attachments to master.

The attachments are selected using a ";" separated list of suffixes (including the ".", like in ".ext").

A file is accepted as an attachment if it has an attachment suffix and the file base name is either the same as the master file name or master file base name. The master may be null to accept all attachments in a directory
foo.bar foo.bar.suffix (accepted) foo.suffix (accepted) foo.txt (rejected)

All checks are case insensitive.

Parameters:

master -

files -

extensions -

Returns:

a list of File instances selected from the array of candidates that are recognized as attachments to master.

createAttachments

public static List createAttachments(File master,
                     String extensions)

Find all attachments to master. Attachments are defined to be all files in the same directory as master that satisfy one of the extensions.

Parameters:

master -

extensions -

Returns:

all attachments to master

deleteAttachments

public static void deleteAttachments(List attachments)

existsAttachments

public static boolean existsAttachments(File master,
                        File[] files,
                        String extensions)

true if all required attachments for master are available. extensions is a ";" separated list of extensions in the form ".ext". If an extension is required, the extension is prefixed with a "+" (like in "+.ext"). All checks are case insensitive.

Parameters:

master -

files -

extensions -

Returns:

isAttachment

public static boolean isAttachment(File file,
                   String extensions)

true, if file is an attachment as defined in the extensions. extensions is a ";" separated list of extensions in the form ".ext". All checks are case insensitive.

Parameters:

file -

extensions -

Returns:

moveAttachment

public static File moveAttachment(File master,
                  File attachment,
                  File movedFile,
                  boolean delete)
                           throws IOException

Throws:

IOException

moveAttachment

public static File moveAttachment(File master,
                  File attachment,
                  File movedFile,
                  boolean delete,
                  boolean keepLastModified)
                           throws IOException

Given the original master file and an attachment to this file, move the attachments to the correct location for the new master file location given in movedFile.

If delete is true, old attachment files are deleted.

Parameters:

master -

attachment -

movedFile -

delete -

keepLastModified -

Returns:

The moved (or unchanged) attachment.

Throws:

IOException

moveAttachments

public static List moveAttachments(File master,
                   List attachments,
                   File movedFile,
                   boolean delete)
                            throws IOException

Throws:

IOException

moveAttachments

public static List moveAttachments(File master,
                   List attachments,
                   File movedFile,
                   boolean delete,
                   boolean keepLastModified)
                            throws IOException

Given the original master file and the list of attachments to this file, move all attachments to the correct location for the new master file location given in movedFile.

If delete is true, old attachment files are deleted.

Parameters:

master -

attachments -

movedFile -

delete -

Returns:

The list of moved (or unchanged ) attachments

Throws:

IOException