de.intarsys.tools.file

Class FileGroup

java.lang.Object

de.intarsys.tools.file.FileGroup

public class FileGroup
extends Object

A group of files belonging together in the sense that there's a master file combined with a bunch of attachments. The master file is handled as a descendant of root.

Constructor Summary

Constructors

Constructor and Description
FileGroup(File master)
FileGroup(File root, File master)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete()
List<Attachment>	getAttachments()
File	getMaster()
File	getRoot()
void	move(File targetDir, String template, IStringEvaluator resolver, boolean deleteSource, boolean deleteSubdirectories, boolean keepLastModified, boolean collisionDetect) Move the file group to the destination directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileGroup

public FileGroup(File master)

FileGroup

public FileGroup(File root,
         File master)

Method Detail

delete

public void delete()
            throws IOException

Throws:

IOException

getAttachments

public List<Attachment> getAttachments()

getMaster

public File getMaster()

getRoot

public File getRoot()

move

public void move(File targetDir,
        String template,
        IStringEvaluator resolver,
        boolean deleteSource,
        boolean deleteSubdirectories,
        boolean keepLastModified,
        boolean collisionDetect)
          throws IOException

Move the file group to the destination directory. The master file and any attachment is moved into the destination, offset by "relativePath", regardless of the current location. The move operation is performed "atomically" in the sense that a cooperative FileTools.Lock is acquired on the master before moving. A collision detection is performed before moving - in case of collision, the move fails with a CollisionException before any file operation takes place.

Parameters:

targetDir - The directory to transfer the group into

template - Use this template to create a new filename in targetDir, based on source file

resolver - The resolver used for expanding the template

deleteSource - if true, source is deleted after move

deleteSubdirectories - if true, empty source directories are deleted after move

keepLastModified - if true, destination files get the same timestamp as sources

collisionDetect - if true, destination is checked for collision before move

Throws:

IOException