ch.swaechter.smbjwrapper

Class SharedDirectory

java.lang.Object

ch.swaechter.smbjwrapper.core.AbstractSharedItem<SharedDirectory>

ch.swaechter.smbjwrapper.SharedDirectory

All Implemented Interfaces:

SharedItem

public final class SharedDirectory
extends AbstractSharedItem<SharedDirectory>

This class represents a shared directory.

Author:

Simon Wächter

Field Summary

Fields inherited from class ch.swaechter.smbjwrapper.core.AbstractSharedItem

PATH_SEPARATOR, ROOT_PATH

Constructor Summary

Constructors

Constructor and Description
SharedDirectory(SharedConnection sharedConnection) Create a new shared directory based on the shared connection.
SharedDirectory(SharedConnection sharedConnection, String pathName) Create a new shared directory based on the shared connection and the path name.

Method Summary

Modifier and Type	Method and Description
void	createDirectory() Create the current directory.
SharedDirectory	createDirectoryInCurrentDirectory(String directoryName) Create a directory in the current directory.
SharedFile	createFileInCurrentDirectory(String fileName) Create a file in the current directory.
protected SharedDirectory	createSharedNodeItem(String pathName) Create a new shared directory via factory.
void	deleteDirectoryRecursively() Delete the current directory with all its subdirectories and subfiles.
void	ensureExists() Ensure that the given directory path does exist - if not, the path is created.
boolean	equals(Object object) Check if the current and the given objects are equals.
List<SharedDirectory>	getDirectories() Get all directories of the current directory.
List<SharedFile>	getFiles() Get all files of the current directory.
List<SharedItem>	listFiles(Predicate<SharedItem> searchPredicate, boolean searchRecursive) List all files and directories that match the search predicate.
List<SharedItem>	listFiles(String searchPattern, boolean searchRecursive) List all files and directories that match the search pattern.
void	renameTo(String newFileName, boolean replaceIfExist) Rename the current item.

Methods inherited from class ch.swaechter.smbjwrapper.core.AbstractSharedItem

getChangeTime, getCreationTime, getDiskShare, getLastAccessTime, getLastWriteTime, getName, getParentPath, getPath, getRootPath, getServerName, getSharedConnection, getShareName, getSmbPath, isDirectory, isExisting, isFile, isRootPath, setPathName

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedDirectory

public SharedDirectory(SharedConnection sharedConnection,
                       String pathName)

Create a new shared directory based on the shared connection and the path name.

Parameters:

sharedConnection - Shared connection

pathName - Path name

SharedDirectory

public SharedDirectory(SharedConnection sharedConnection)

Create a new shared directory based on the shared connection. As path name, the root path is used.

Parameters:

sharedConnection - Shared connection

Method Detail

ensureExists

public void ensureExists()

Ensure that the given directory path does exist - if not, the path is created. In case the path already exists, but is not a directory, an exception will be thrown to ensure application integrity.

createDirectoryInCurrentDirectory

public SharedDirectory createDirectoryInCurrentDirectory(String directoryName)

Create a directory in the current directory.

Parameters:

directoryName - Name of the new directory

Returns:

Newly created directory

createFileInCurrentDirectory

public SharedFile createFileInCurrentDirectory(String fileName)

Create a file in the current directory.

Parameters:

fileName - Name of the new file

Returns:

Newly created file

createDirectory

public void createDirectory()

Create the current directory.

deleteDirectoryRecursively

public void deleteDirectoryRecursively()

Delete the current directory with all its subdirectories and subfiles.

getDirectories

public List<SharedDirectory> getDirectories()

Get all directories of the current directory.

Returns:

List with all directories

getFiles

public List<SharedFile> getFiles()

Get all files of the current directory.

Returns:

List with all files

listFiles

public List<SharedItem> listFiles(Predicate<SharedItem> searchPredicate,
                                  boolean searchRecursive)

List all files and directories that match the search predicate. A recursive search is possible and will result in a flat list with all matching elements.

Parameters:

searchPredicate - Search predicate that is used for testing

searchRecursive - Flag to search recursive

Returns:

Flat list with all matching files and directories

listFiles

public List<SharedItem> listFiles(String searchPattern,
                                  boolean searchRecursive)

List all files and directories that match the search pattern. A recursive search is possible and will result in a flat list with all matching elements.

Parameters:

searchPattern - Search regex pattern that is used for matching

searchRecursive - Flag to search recursive

Returns:

Flat list with all matching files and directories

renameTo

public void renameTo(String newFileName,
                     boolean replaceIfExist)

Rename the current item.

Parameters:

newFileName - New file name

replaceIfExist - Flag to replace an existing path

equals

public boolean equals(Object object)

Check if the current and the given objects are equals.

Specified by:

equals in class AbstractSharedItem<SharedDirectory>

Parameters:

object - Given object to compare against

Returns:

Status of the check

createSharedNodeItem

protected SharedDirectory createSharedNodeItem(String pathName)

Create a new shared directory via factory.

Specified by:

createSharedNodeItem in class AbstractSharedItem<SharedDirectory>

Parameters:

pathName - Path name of the shared item

Returns:

New shared directory