net.sourceforge.javadpkg.store

Class DataStoreNode

java.lang.Object

net.sourceforge.javadpkg.store.DataStoreNode

All Implemented Interfaces:

DebianPackageConstants, GlobalConstants

public class DataStoreNode
extends Object
implements DebianPackageConstants

A node representing a directory or file in the DataStore.

Version:

1.0, 26.04.2016 by Gerrit Hohl

Author:

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

Field Summary

Fields inherited from interface net.sourceforge.javadpkg.DebianPackageConstants

CONFFILES_ENTRY, CONFIG_ENTRY, CONTROL_ENTRY, CONTROL_NAME, CONTROL_TAR_PREFIX, DATA_NAME, DATA_TAR_PREFIX, DEBIAN_BINARY, DIRECTORY_MODE, DOC_BASE_PATH, FILE_MODE, MD5SUMS_ENTRY, POSTINST_ENTRY, POSTRM_ENTRY, PREINST_ENTRY, PRERM_ENTRY, ROOT_GROUP_ID, ROOT_GROUP_NAME, ROOT_USER_ID, ROOT_USER_NAME, SCRIPT_MODE, SHLIBS_ENTRY, SYMBOLS_ENTRY, TAR_BZIP2_SUFFIX, TAR_GZIP_SUFFIX, TAR_XZ_SUFFIX, TEMPLATES_ENTRY, TRIGGERS_ENTRY, USR_PATH, USR_SHARE_PATH

Fields inherited from interface net.sourceforge.javadpkg.GlobalConstants

UTF_8, UTF_8_CHARSET

Constructor Summary

Constructors

Constructor and Description
DataStoreNode() Creates the root node.
DataStoreNode(DataSource source, String name, FileOwner owner, FileMode mode) Creates a node for a file.
DataStoreNode(String name, FileOwner owner, FileMode mode) Creates a node for a directory.
DataStoreNode(String name, String target, FileOwner owner, FileMode mode) Creates a node for a symbolic link.

Method Summary

Modifier and Type	Method and Description
void	addChildNode(DataStoreNode childNode) Adds a child node.
List<FileHash>	createFileHashes(MessageDigest digest) Creates the file hashes for all files within the directory and its sub-directories (if this node represents a directory) or for the file (if this node represents a file).
DataStoreNode	getChildNodeByName(String name) Returns the child node with the specified name.
String	getName() Returns the name.
DataStoreNode	getParentNode() Returns the parent node.
String	getPath() Returns the path.
long	getSize() Returns the size of the files under this node and its sub-nodes.
boolean	isDirectory() Returns the flag if the node is a directory node.
boolean	isFile() Returns the flag if the node is a file node.
boolean	isSymbolicLink() Returns the flag if the node is a symbolic link node.
void	write(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream out) Writes the node and its child nodes into the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataStoreNode

public DataStoreNode()

Creates the root node.

DataStoreNode

public DataStoreNode(String name,
                     FileOwner owner,
                     FileMode mode)

Creates a node for a directory.

Parameters:

name - The name.

owner - The owner.

mode - The mode.

Throws:

IllegalArgumentException - If any of the parameters are null.

DataStoreNode

public DataStoreNode(DataSource source,
                     String name,
                     FileOwner owner,
                     FileMode mode)

Creates a node for a file.

Parameters:

source - The source for the content of the file.

name - The name.

owner - The owner.

mode - The mode.

Throws:

IllegalArgumentException - If any of the parameters are null.

DataStoreNode

public DataStoreNode(String name,
                     String target,
                     FileOwner owner,
                     FileMode mode)

Creates a node for a symbolic link.

Parameters:

name - The name.

target - The target of the symbolic link.

owner - The owner.

mode - The mode.

Throws:

IllegalArgumentException - If any of the parameters are null.

Method Detail

getName

public String getName()

Returns the name.

Returns:

The name.

getPath

public String getPath()

Returns the path.

Returns:

The path.

isDirectory

public boolean isDirectory()

Returns the flag if the node is a directory node.

Returns:

The flag: true, if the node is a directory node, false otherwise.

See Also:

isFile()

isFile

public boolean isFile()

Returns the flag if the node is a file node.

Symbolic links are also files.

Returns:

The flag: true, if the node is a file node, false otherwise.

See Also:

isDirectory(), isSymbolicLink()

isSymbolicLink

public boolean isSymbolicLink()

Returns the flag if the node is a symbolic link node.

Returns:

The flag: true, if the node is a symbolic link node, false otherwise.

See Also:

isFile()

getSize

public long getSize()
             throws IOException

Returns the size of the files under this node and its sub-nodes.

Returns:

The size in bytes.

Throws:

IOException - If the size of a file can't be determined.

addChildNode

public void addChildNode(DataStoreNode childNode)

Adds a child node.

Parameters:

childNode - The child node.

Throws:

IllegalArgumentException - If the child node is null, this node is not a directory node, the child node is already added to a node or this node already contains a child node with the same name.

getChildNodeByName

public DataStoreNode getChildNodeByName(String name)

Returns the child node with the specified name.

Parameters:

name - The name.

Returns:

The node or null, if this node doesn't contain such a node.

Throws:

IllegalArgumentException - If the name is null or this node is not a directory node.

getParentNode

public DataStoreNode getParentNode()

Returns the parent node.

Returns:

The parent node or null, if the node wasn't add to any other node.

write

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

Writes the node and its child nodes into the stream.

Parameters:

out - The stream.

Throws:

IOException - If an I/O error occurs.

IllegalArgumentException - If the stream is null.

createFileHashes

public List<FileHash> createFileHashes(MessageDigest digest)
                                throws IOException

Creates the file hashes for all files within the directory and its sub-directories (if this node represents a directory) or for the file (if this node represents a file).

Symbolic links are ignored. No hash will be created for them.

Parameters:

digest - The digest used for creating the hashes.

Returns:

The hashes.

Throws:

IOException - If an I/O error occurs.