net.sourceforge.javadpkg.plugin.impl

Class DataEntryNode

java.lang.Object

net.sourceforge.javadpkg.plugin.impl.DataEntryNode

public class DataEntryNode
extends Object

A node of a DataEntry.

This class is part of the pre-processing / the parsing of the configuration.

Version:

1.0, 19.05.2016 by Gerrit Hohl

Author:

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

Constructor Summary

Constructors

Constructor and Description
DataEntryNode(File source, String name, Path parent, Long groupId, String groupName, Long userId, String userName, Integer mode, boolean process, String encoding) Creates a node for a regular file.
DataEntryNode(String name, Path parent, Long groupId, String groupName, Long userId, String userName, Integer mode) Creates a node for a directory.
DataEntryNode(String name, Path parent, String symLink, Long groupId, String groupName, Long userId, String userName, Integer mode) Creates a node for a symbolic link.

Method Summary

Modifier and Type	Method and Description
String	getEncoding() Returns the encoding for the processing.
Long	getGroupId() Returns the group ID.
String	getGroupName() returns the group name.
Integer	getMode() Returns the mode.
String	getName() Returns the name of the file in the target.
Path	getParent() Returns the path of the parent in the target.
File	getSource() Returns the source file.
String	getSymLink() Returns the The target file or directory of the symbolic link the target.
Long	getUserId() Returns the user ID.
String	getUserName() returns the user name.
boolean	isProcess() Returns the flag if the file should be processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEntryNode

public DataEntryNode(String name,
                     Path parent,
                     Long groupId,
                     String groupName,
                     Long userId,
                     String userName,
                     Integer mode)

Creates a node for a directory.

Parameters:

name - The name of the directory in the target.

parent - The path of the parent in the target.

groupId - The group ID (optional).

groupName - The group name (optional).

userId - The user ID (optional).

userName - The user name (optional).

mode - The mode (optional).

Throws:

IllegalArgumentException - If any of the non-optional parameters are null.

DataEntryNode

public DataEntryNode(File source,
                     String name,
                     Path parent,
                     Long groupId,
                     String groupName,
                     Long userId,
                     String userName,
                     Integer mode,
                     boolean process,
                     String encoding)

Creates a node for a regular file.

Parameters:

source - The source file.

name - The name of the directory in the target.

parent - The path of the parent in the target.

groupId - The group ID (optional).

groupName - The group name (optional).

userId - The user ID (optional).

userName - The user name (optional).

mode - The mode (optional).

process - The flag if the file should be processed.

encoding - The encoding for the processing (optional).

Throws:

IllegalArgumentException - If any of the non-optional parameters are null.

DataEntryNode

public DataEntryNode(String name,
                     Path parent,
                     String symLink,
                     Long groupId,
                     String groupName,
                     Long userId,
                     String userName,
                     Integer mode)

Creates a node for a symbolic link.

Parameters:

name - The name of the symbolic link in the target.

parent - The path of the parent in the target.

symLink - The target file or directory of the symbolic link the target.

groupId - The group ID (optional).

groupName - The group name (optional).

userId - The user ID (optional).

userName - The user name (optional).

mode - The mode (optional).

Throws:

IllegalArgumentException - If any of the non-optional parameters are null.

Method Detail

getSource

public File getSource()

Returns the source file.

Returns:

The source file or null, if this node doesn't represent a regular file.

getName

public String getName()

Returns the name of the file in the target.

Returns:

The name.

getParent

public Path getParent()

Returns the path of the parent in the target.

Returns:

The path.

getSymLink

public String getSymLink()

Returns the The target file or directory of the symbolic link the target.

Returns:

The target or null, if this node doesn't represent a symbolic link.

getGroupId

public Long getGroupId()

Returns the group ID.

Returns:

The group ID or null, if the group ID is not set.

getGroupName

public String getGroupName()

returns the group name.

Returns:

The group name or null, if the group name is not set.

getUserId

public Long getUserId()

Returns the user ID.

Returns:

The user ID or null, if the user ID is not set.

getUserName

public String getUserName()

returns the user name.

Returns:

The user name or null, if the user name is not set.

getMode

public Integer getMode()

Returns the mode.

Returns:

The mode or null, if the mode is not set.

isProcess

public boolean isProcess()

Returns the flag if the file should be processed.

This flag has only an effect if this node represents a regular file.

Returns:

The flag: true, if the file should be processed, false otherwise.

See Also:

getSource(), getEncoding()

getEncoding

public String getEncoding()

Returns the encoding for the processing.

This flag has only an effect if this node should be processed.

Returns:

The encoding or null, if the default encoding should be used.

See Also:

isProcess()