SmbItem (smbjwraper 1.1.0 API)

java.lang.Object
- ch.swaechter.smbjwrapper.SmbItem

Direct Known Subclasses:

SmbDirectory, SmbFile
```
public abstract class SmbItem
extends Object
```
This class provides a common abstracted class that represents a SMB directory/file like node.

Author:

Simon Wächter

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`PATH_SEPARATOR` String used to separate paths.
`protected static String`	`ROOT_PATH` String used to represent the root path.

Constructor Summary

Constructors
Constructor and Description

SmbItem(SmbConnection smbConnection, String pathName)
Create a new abstract SMB item based on the SMB connection and the path name.

Constructors
Constructor and Description
`SmbItem(SmbConnection smbConnection, String pathName)` Create a new abstract SMB item based on the SMB connection and the path name.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`equals(Object object)` Check if the current and the given objects are equals.
`com.hierynomus.msdtyp.FileTime`	`getChangeTime()` Get the change time of the SMB item.
`com.hierynomus.msdtyp.FileTime`	`getCreationTime()` Get the creation time of the SMB item.
`protected com.hierynomus.smbj.share.DiskShare`	`getDiskShare()` Get the disk share of the SMB connection.
`com.hierynomus.msdtyp.FileTime`	`getLastAccessTime()` Get the last access time of the SMB item.
`com.hierynomus.msdtyp.FileTime`	`getLastWriteTime()` Get the last write time of the SMB item.
`String`	`getName()` Get the name of the SMB item.
`SmbDirectory`	`getParentPath()` Get the parent SMB item.
`String`	`getPath()` Get the path of the SMB item.
`SmbDirectory`	`getRootPath()` Get the root SMB item.
`String`	`getServerName()` Get the server name of the connected server.
`String`	`getShareName()` Get the share name of the connected server.
`protected SmbConnection`	`getSmbConnection()` Get the SMB connection.
`String`	`getSmbPath()` Get the full SMB path including the server, share and path, separated by backslashes.
`boolean`	`isDirectory()` Check if the SMB item is a directory.
`boolean`	`isExisting()` Check if the SMB item does exist.
`boolean`	`isFile()` Check if the SMB item is a file.
`boolean`	`isHidden()` Check if the SMB item is hidden on an SMB level.
`boolean`	`isRootPath()` Check if the current SMB item is the root SMB item.
`abstract SmbItem`	`renameTo(String newItemName, boolean replaceIfExist)` Rename the current item and return it as newly renamed item.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PATH_SEPARATOR
```
protected static final String PATH_SEPARATOR
```
    String used to separate paths.
    
    See Also:
    
    Constant Field Values
  - ROOT_PATH
```
protected static final String ROOT_PATH
```
    String used to represent the root path.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SmbItem
```
public SmbItem(SmbConnection smbConnection,
               String pathName)
```
    Create a new abstract SMB item based on the SMB connection and the path name.
    
    Parameters:
    
    smbConnection - SMB connection
    
    pathName - Path name
    
    Throws:
    
    RuntimeException - Exception in case of an invalid path name
- Method Detail
  - isExisting
```
public boolean isExisting()
```
    Check if the SMB item does exist.
    
    Returns:
    
    Status of the check
  - isDirectory
```
public boolean isDirectory()
```
    Check if the SMB item is a directory.
    
    Returns:
    
    Status of the check
  - isFile
```
public boolean isFile()
```
    Check if the SMB item is a file.
    
    Returns:
    
    Status of the check
  - isHidden
```
public boolean isHidden()
```
    Check if the SMB item is hidden on an SMB level. Depending on the server configuration, dotted UNIX files can also be interpreted as hidden files ("hide dot files = yes").
    
    Returns:
    
    Status of the check (Depending on the server configuration)
    
    See Also:
    
    Hide dot files option
  - getServerName
```
public String getServerName()
```
    Get the server name of the connected server.
    
    Returns:
    
    Name of the server
  - getShareName
```
public String getShareName()
```
    Get the share name of the connected server.
    
    Returns:
    
    Name of the share
  - getName
```
public String getName()
```
    Get the name of the SMB item. If the SMB item is a root item, an empty string will be returned.
    
    Returns:
    
    Real name or empty string
  - getPath
```
public String getPath()
```
    Get the path of the SMB item. If the SMB item is a root item, an empty string will be returned.
    
    Returns:
    
    Real path or empty string
  - getSmbPath
```
public String getSmbPath()
```
    Get the full SMB path including the server, share and path, separated by backslashes.
    
    Returns:
    
    Full SMB path
  - getParentPath
```
public SmbDirectory getParentPath()
```
    Get the parent SMB item. If the SMB item us already the root item, the root item will be re-returned.
    
    Returns:
    
    Parent SMB item
  - getRootPath
```
public SmbDirectory getRootPath()
```
    Get the root SMB item.
    
    Returns:
    
    Root SMB item
  - isRootPath
```
public boolean isRootPath()
```
    Check if the current SMB item is the root SMB item.
    
    Returns:
    
    Status of the check
  - getCreationTime
```
public com.hierynomus.msdtyp.FileTime getCreationTime()
```
    Get the creation time of the SMB item.
    
    Returns:
    
    Creation time of the SMB item
  - getLastAccessTime
```
public com.hierynomus.msdtyp.FileTime getLastAccessTime()
```
    Get the last access time of the SMB item.
    
    Returns:
    
    Last access time of the SMB item
  - getLastWriteTime
```
public com.hierynomus.msdtyp.FileTime getLastWriteTime()
```
    Get the last write time of the SMB item.
    
    Returns:
    
    Last write time of the SMB item
  - getChangeTime
```
public com.hierynomus.msdtyp.FileTime getChangeTime()
```
    Get the change time of the SMB item.
    
    Returns:
    
    Change time of the SMB item
  - equals
```
public abstract boolean equals(Object object)
```
    Check if the current and the given objects are equals.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - Given object to compare against
    
    Returns:
    
    Status of the check
  - getSmbConnection
```
protected SmbConnection getSmbConnection()
```
    Get the SMB connection.
    
    Returns:
    
    SMB connection
  - getDiskShare
```
protected com.hierynomus.smbj.share.DiskShare getDiskShare()
```
    Get the disk share of the SMB connection.
    
    Returns:
    
    Disk share of the SMB connection
  - renameTo
```
public abstract SmbItem renameTo(String newItemName,
                                 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.
    
    Parameters:
    
    newItemName - 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

Class SmbItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH_SEPARATOR

ROOT_PATH

Constructor Detail

SmbItem

Method Detail

isExisting

isDirectory

isFile

isHidden

getServerName

getShareName

getName

getPath

getSmbPath

getParentPath

getRootPath

isRootPath

getCreationTime

getLastAccessTime

getLastWriteTime

getChangeTime

equals

getSmbConnection

getDiskShare

renameTo