to.etc.file

Class DirectoryInventory

java.lang.Object

to.etc.file.DirectoryInventory

All Implemented Interfaces:

Serializable

public final class DirectoryInventory
extends Object
implements Serializable

Contains a "directory contents" snapshot consisting of all files and directories in the target directory and the hash values for all files. Inventories can be saved to a file and reloaded, and two inventories can be compared to get a delta. All paths inside the inventory are relative so inventories at different locations can be compared.

Author:

Frits Jalvingh Created on Nov 16, 2013

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirectoryInventory.DeltaRecord Records a single change between two inventories.
static class	DirectoryInventory.DeltaType
static interface	DirectoryInventory.IDeltaListener This listener receives all changes found by comparing two DirectoryInventory objects.
static class	DirectoryInventory.InvEntry

Method Summary

Modifier and Type	Method and Description
static int	compareArrays(byte[] aa, byte[] ba)
List<DirectoryInventory.DeltaRecord>	compareTo(DirectoryInventory other) Compare to inventories and return a list of changes.
void	compareTo(DirectoryInventory other, DirectoryInventory.IDeltaListener listener) Compare this and another inventory, and generate events that tell how THIS would need to change to become OTHER.
static DirectoryInventory	create(File src) Create an inventory for the specified directory by scanning and reading all files.
static DirectoryInventory	createEmpty()
long	getCreationTime()
int	getNumDirectories()
int	getNumFiles()
static DirectoryInventory	load(File src) Load the inventory from a file.
static void	main(String[] args)
void	save(File src) Saves the entire inventory.
<R> R	visit(FunctionEx<DirectoryInventory.InvEntry,R> consumer) Visits all entries.

Methods inherited from class java.lang.Object

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

Method Detail

createEmpty

@Nonnull
public static DirectoryInventory createEmpty()

create

@Nonnull
public static DirectoryInventory create(@Nonnull
                                                 File src)
                                          throws Exception

Create an inventory for the specified directory by scanning and reading all files.

Parameters:

src -

Returns:

Throws:

Exception

compareArrays

public static int compareArrays(@Nonnull
                                byte[] aa,
                                @Nonnull
                                byte[] ba)

load

@Nonnull
public static DirectoryInventory load(@Nonnull
                                               File src)
                                        throws Exception

Load the inventory from a file.

Parameters:

src -

Returns:

Throws:

Exception

save

public void save(@Nonnull
                 File src)

Saves the entire inventory.

Parameters:

src -

compareTo

public void compareTo(@Nonnull
                      DirectoryInventory other,
                      @Nonnull
                      DirectoryInventory.IDeltaListener listener)
               throws Exception

Compare this and another inventory, and generate events that tell how THIS would need to change to become OTHER.

Parameters:

other -

Throws:

Exception

compareTo

@Nonnull
public List<DirectoryInventory.DeltaRecord> compareTo(@Nonnull
                                                               DirectoryInventory other)

Compare to inventories and return a list of changes.

Parameters:

other -

Returns:

visit

@Nullable
public <R> R visit(@Nonnull
                             FunctionEx<DirectoryInventory.InvEntry,R> consumer)
                      throws Exception

Visits all entries.

Parameters:

consumer -

Throws:

Exception

main

public static void main(@Nonnull
                        String[] args)
                 throws Exception

Throws:

Exception

getNumFiles

public int getNumFiles()

getNumDirectories

public int getNumDirectories()

getCreationTime

public long getCreationTime()