net.sourceforge.javadpkg.plugin.cfg

Class DataEntry

java.lang.Object

net.sourceforge.javadpkg.plugin.cfg.DataEntry

public class DataEntry
extends Object

An entry in the DataConfiguration.

Version:

1.0, 03.05.2016 by Gerrit Hohl

Author:

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

Constructor Summary

Constructors

Constructor and Description
DataEntry() Creates an entry.
DataEntry(String sourcePath, String targetPath, String symLinkPath, Long groupId, String groupName, Long userId, String userName, Integer mode, boolean recursive, boolean process, String encoding) Creates an entry

Method Summary

Modifier and Type	Method and Description
String	getEncoding() Returns the encoding of the file which should be processed.
Long	getGroupId() Returns the group ID.
String	getGroupName() Returns the group name.
Integer	getMode() Returns the mode.
String	getSourcePath() Returns the source path.
String	getSymLinkPath() Returns the symbolic link path.
String	getTargetPath() Returns the target path.
Long	getUserId() Returns the user ID.
String	getUserName() Returns the user name.
boolean	isProcess() Returns the flag if the file should be processed.
boolean	isRecursive() Returns the flag if the directory should be included recursively.
void	setEncoding(String encoding) Sets the encoding of the file which should be processed.
void	setGroupId(Long groupId) Sets the group ID.
void	setGroupName(String groupName) Sets the group name.
void	setMode(Integer mode) Sets the mode.
void	setProcess(boolean process) Sets the flag if the file should be processed.
void	setRecursive(boolean recursive) Sets the flag if the directory should be included recursively.
void	setSourcePath(String sourcePath) Sets the source path.
void	setSymLinkPath(String symLinkPath) Sets the symbolic link path.
void	setTargetPath(String targetPath) Sets the target path.
void	setUserId(Long userId) Sets the user ID.
void	setUserName(String userName) Sets the user name.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEntry

public DataEntry()

Creates an entry.

DataEntry

public DataEntry(String sourcePath,
                 String targetPath,
                 String symLinkPath,
                 Long groupId,
                 String groupName,
                 Long userId,
                 String userName,
                 Integer mode,
                 boolean recursive,
                 boolean process,
                 String encoding)

Creates an entry

Parameters:

sourcePath - The source path.

targetPath - The target path.

symLinkPath - The symbolic link path.

groupId - The group ID.

groupName - The group name.

userId - The user ID.

userName - The user name.

mode - The mode.

recursive - The flag if the directory should be included recursively.

process - The flag if the file should be processed.

encoding - The encoding for the processing.

Method Detail

getSourcePath

public String getSourcePath()

Returns the source path.

Returns:

The source path.

setSourcePath

public void setSourcePath(String sourcePath)

Sets the source path.

Parameters:

sourcePath - The source path.

getTargetPath

public String getTargetPath()

Returns the target path.

Returns:

The target path.

setTargetPath

public void setTargetPath(String targetPath)

Sets the target path.

Parameters:

targetPath - The target path.

getSymLinkPath

public String getSymLinkPath()

Returns the symbolic link path.

Returns:

The symbolic link path.

setSymLinkPath

public void setSymLinkPath(String symLinkPath)

Sets the symbolic link path.

Parameters:

symLinkPath - The symbolic link path.

getGroupId

public Long getGroupId()

Returns the group ID.

Returns:

The group ID.

setGroupId

public void setGroupId(Long groupId)

Sets the group ID.

Parameters:

groupId - The group ID.

getGroupName

public String getGroupName()

Returns the group name.

Returns:

The group name.

setGroupName

public void setGroupName(String groupName)

Sets the group name.

Parameters:

groupName - The group name.

getUserId

public Long getUserId()

Returns the user ID.

Returns:

The user ID.

setUserId

public void setUserId(Long userId)

Sets the user ID.

Parameters:

userId - The user ID.

getUserName

public String getUserName()

Returns the user name.

Returns:

The user name.

setUserName

public void setUserName(String userName)

Sets the user name.

Parameters:

userName - The user name.

getMode

public Integer getMode()

Returns the mode.

Returns:

The mode.

setMode

public void setMode(Integer mode)

Sets the mode.

Parameters:

mode - The mode.

isRecursive

public boolean isRecursive()

Returns the flag if the directory should be included recursively.

This flag has only an effect if the source path is pointing on a directory.

Returns:

The flag: true, if the directory should be included recursively, false otherwise.

setRecursive

public void setRecursive(boolean recursive)

Sets the flag if the directory should be included recursively.

This flag has only an effect if the source path is pointing on a directory.

Parameters:

recursive - The flag: true, if the directory should be included recursively, false otherwise.

isProcess

public boolean isProcess()

Returns the flag if the file should be processed.

This flag has only an effect if the source path is pointing on a regular file. Another possibility if the source path is pointing on a directory, but the recursive option is activated (see the isRecursive() method). Then all found regular files are processed.

All variables in that file will be replaced. Therefore it has to be a text file.

Returns:

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

See Also:

getEncoding()

setProcess

public void setProcess(boolean process)

Sets the flag if the file should be processed.

This flag has only an effect if the source path is pointing on a regular file. Another possibility if the source path is pointing on a directory, but the recursive option is activated (see the isRecursive() method). Then all found regular files are processed.

All variables in that file will be replaced. Therefore it has to be a text file.

Parameters:

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

See Also:

setEncoding(String)

getEncoding

public String getEncoding()

Returns the encoding of the file which should be processed.

Returns:

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

See Also:

isProcess()

setEncoding

public void setEncoding(String encoding)

Sets the encoding of the file which should be processed.

Parameters:

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

See Also:

setProcess(boolean)