ch.swaechter.smbjwrapper

Class SmbDirectory

java.lang.Object

ch.swaechter.smbjwrapper.SmbItem

ch.swaechter.smbjwrapper.SmbDirectory

public final class SmbDirectory
extends SmbItem

This class represents a SMB directory.

Author:

Simon Wächter

Field Summary

Fields inherited from class ch.swaechter.smbjwrapper.SmbItem

PATH_SEPARATOR, ROOT_PATH

Constructor Summary

Constructors

Constructor and Description
SmbDirectory(SmbConnection smbConnection) Create a new SMB directory based on the SMB connection.
SmbDirectory(SmbConnection smbConnection, String pathName) Create a new SMB directory based on the SMB connection and the path name.

Method Summary

Modifier and Type	Method and Description
void	createDirectory() Create the current directory.
SmbDirectory	createDirectoryInCurrentDirectory(String directoryName) Create a directory in the current directory.
SmbFile	createFileInCurrentDirectory(String fileName) Create a file in the current directory.
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<SmbDirectory>	getDirectories() Get all directories of the current directory.
List<SmbFile>	getFiles() Get all files of the current directory.
List<SmbItem>	listItems() List all files and directories of the current directory.
List<SmbItem>	listItems(Predicate<SmbItem> searchPredicate, boolean searchRecursive) List all files and directories that match the search predicate.
List<SmbItem>	listItems(String searchPattern, boolean searchRecursive) List all files and directories that match the search pattern.
SmbDirectory	renameTo(String newDirectoryName, boolean replaceIfExist) Rename the current item and return it as newly renamed item.

Methods inherited from class ch.swaechter.smbjwrapper.SmbItem

buildProperItemPath, getChangeTime, getCreationTime, getDiskShare, getLastAccessTime, getLastWriteTime, getName, getParentPath, getPath, getRootPath, getServerName, getShareName, getSmbConnection, getSmbPath, isDirectory, isExisting, isFile, isHidden, isRootPath, isValidSmbItemName

Methods inherited from class java.lang.Object

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

Constructor Detail

SmbDirectory

public SmbDirectory(SmbConnection smbConnection,
                    String pathName)

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

Parameters:

smbConnection - SMB connection

pathName - Path name

SmbDirectory

public SmbDirectory(SmbConnection smbConnection)

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

Parameters:

smbConnection - SMB 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 SmbDirectory createDirectoryInCurrentDirectory(String directoryName)

Create a directory in the current directory.

Parameters:

directoryName - Name of the new directory

Returns:

Newly created directory

createFileInCurrentDirectory

public SmbFile 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<SmbDirectory> getDirectories()

Get all directories of the current directory.

Returns:

List with all directories

getFiles

public List<SmbFile> getFiles()

Get all files of the current directory.

Returns:

List with all files

listItems

public List<SmbItem> listItems()

List all files and directories of the current directory. No recursive search or filtering is performed.

Returns:

Flat list with all files and directories of the current directory

listItems

public List<SmbItem> listItems(Predicate<SmbItem> 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

listItems

public List<SmbItem> listItems(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 SmbDirectory renameTo(String newDirectoryName,
                             boolean replaceIfExist)

Rename the current item and return it as newly renamed item. Renames are only possible from/to the same type. For example it's not possible to rename a file to an existing directory.

Specified by:

renameTo in class SmbItem

Parameters:

newDirectoryName - New item name

replaceIfExist - Flag to replace an existing path of the same type (File/Directory)

Returns:

Newly renamed SMB item with the new path

equals

public boolean equals(Object object)

Check if the current and the given objects are equals.

Specified by:

equals in class SmbItem

Parameters:

object - Given object to compare against

Returns:

Status of the check