net.sourceforge.javadpkg.store

Interface DataStore

All Known Implementing Classes:

DataStoreImpl

public interface DataStore

A store for managing the files in the data archive of a Debian package.

Version:

1.0, 26.04.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
void	addDirectory(String path) Adds a directory to the store.
void	addDirectory(String path, FileOwner owner, FileMode mode) Adds a directory to the store.
void	addFile(DataSource source, String path) Adds a file to the store.
void	addFile(DataSource source, String path, FileOwner owner, FileMode mode) Adds a file to the store.
void	addSymLink(String path, String target, FileOwner owner, FileMode mode) Adds a symbolic link to the store.
List<FileHash>	createFileHashes(MessageDigest digest) Creates the hashes for all files in the store using the specified digest.
boolean	exists(String path) Returns the flag if a directory or file with the specified path exists.
Size	getSize() Returns the size of all files added to the store.
void	write(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream out) Writes the directories and files added to the store into a TAR archive using the specified stream.

Method Detail

addDirectory

void addDirectory(String path)

Adds a directory to the store.

This method is equal to the method addDirectory(String, FileOwner, FileMode) using the following values:

group ID	group name	user ID	user name	mode (octal)
0	root	0	root	0755

Parameters:

path - The installation path.

Throws:

IllegalArgumentException - If the installation path is null, the parent directory wasn't added before or already contains an entry with the same name. Only exception is the root "/" directory which always exists.

addDirectory

void addDirectory(String path,
                  FileOwner owner,
                  FileMode mode)

Adds a directory to the store.

Parameters:

path - The installation path.

owner - The owner.

mode - The mode.

Throws:

IllegalArgumentException - If any of the parameters are null, the path doesn't contain an valid path, the parent directory wasn't added before or already contains an entry with the same name. Only exception is the root "/" directory which always exists.

addFile

void addFile(DataSource source,
             String path)

Adds a file to the store.

This method is equal to the method addFile(DataSource, String, FileOwner, FileMode) using the following values:

group ID	group name	user ID	user name	mode (octal)
0	root	0	root	0644

Parameters:

source - The source for the context of the file.

path - The installation path.

Throws:

IllegalArgumentException - If any of the parameters are null, the parent directory wasn't added before or already contains an entry with the same name. Only exception is the root "/" directory which always exists.

addFile

void addFile(DataSource source,
             String path,
             FileOwner owner,
             FileMode mode)

Adds a file to the store.

Parameters:

source - The source for the content of the file.

path - The installation path.

owner - The owner.

mode - The mode.

Throws:

IllegalArgumentException - If any of the parameters are null, the parent directory wasn't added before or already contains an entry with the same name. Only exception is the root "/" directory which always exists.

addSymLink

void addSymLink(String path,
                String target,
                FileOwner owner,
                FileMode mode)

Adds a symbolic link to the store.

Parameters:

path - The installation path.

target - The target of the symbolic link.

owner - The owner.

mode - The mode.

Throws:

IllegalArgumentException - If any of the parameters are null, the parent directory wasn't added before or already contains an entry with the same name. Only exception is the root "/" directory which always exists.

exists

boolean exists(String path)

Returns the flag if a directory or file with the specified path exists.

Parameters:

path - The path.

Returns:

The flag: true, if the path exists, false otherwise.

Throws:

IllegalArgumentException - If the path is null.

getSize

Size getSize()
      throws IOException

Returns the size of all files added to the store.

Returns:

The size.

Throws:

IOException - If an I/O error occurs.

write

void write(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream out)
    throws IOException

Writes the directories and files added to the store into a TAR archive using the specified stream.

Parameters:

out - The stream on the TAR archive.

Throws:

IllegalArgumentException - If the stream is null.

IOException - If an I/O error occurs.

createFileHashes

List<FileHash> createFileHashes(MessageDigest digest)
                         throws IOException

Creates the hashes for all files in the store using the specified digest.

Parameters:

digest - The digest.

Returns:

The hashes.

Throws:

IllegalArgumentException - If the digest is null.

IOException - If an I/O error occurs.