ch.swaechter.smbjwrapper.core

Class AbstractSharedItem<T extends SharedItem>

java.lang.Object

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

Type Parameters:

T - Generic type that defined a directory/file like node that is used for item creation

All Implemented Interfaces:

SharedItem

Direct Known Subclasses:

SharedDirectory, SharedFile

public abstract class AbstractSharedItem<T extends SharedItem>
extends Object
implements SharedItem

This class provides a common abstracted class that represents a directory/file like node.

Author:

Simon Wächter

Field Summary

Fields

Modifier and Type	Field and Description
protected String	pathName Path name of the abstract shared item.
protected SharedConnection	sharedConnection Shared connection to access the server.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract T	createSharedNodeItem(String pathName) Create a new shared item.
abstract boolean	equals(Object object) Check if the current and the given objects are equals.
String	getName() Get the name of the shared item.
T	getParentPath() Get the parent shared item.
String	getPath() Get the path of the shared item.
T	getRootPath() Get the root shared item.
String	getServerName() Get the server name of the connected server.
String	getShareName() Get the share name of the connected server.
String	getSmbPath() Get the full SMB path including the server, share and path, separated by backslashes.
boolean	isDirectory() Check if the shared item is a directory.
boolean	isExisting() Check if the shared item does exist.
boolean	isFile() Check if the shared item is a file.
boolean	isRootPath() Check if the current shared item or its parent is the root shared item.

Methods inherited from class java.lang.Object

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

Field Detail

sharedConnection

protected final SharedConnection sharedConnection

Shared connection to access the server.

pathName

protected final String pathName

Path name of the abstract shared item.

Constructor Detail

AbstractSharedItem

public AbstractSharedItem(SharedConnection sharedConnection,
                          String pathName)
                   throws IOException

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

Parameters:

sharedConnection - Shared connection

pathName - Path name

Throws:

IOException - Exception in case of a problem

Method Detail

isExisting

public boolean isExisting()

Check if the shared item does exist.

Specified by:

isExisting in interface SharedItem

Returns:

Status of the check

isDirectory

public boolean isDirectory()

Check if the shared item is a directory.

Specified by:

isDirectory in interface SharedItem

Returns:

Status of the check

isFile

public boolean isFile()

Check if the shared item is a file.

Specified by:

isFile in interface SharedItem

Returns:

Status of the check

getName

public String getName()

Get the name of the shared item. If the shared item is a root item, an string name will be returned.

Specified by:

getName in interface SharedItem

Returns:

Real name or empty string

getServerName

public String getServerName()

Get the server name of the connected server.

Specified by:

getServerName in interface SharedItem

Returns:

Name of the server

getShareName

public String getShareName()

Get the share name of the connected server.

Specified by:

getShareName in interface SharedItem

Returns:

Name of the share

getPath

public String getPath()

Get the path of the shared item. If the shared item is a root item, an empty string will be returned.

Specified by:

getPath in interface SharedItem

Returns:

Real path or empty string

getSmbPath

public String getSmbPath()

Get the full SMB path including the server, share and path, separated by backslashes.

Specified by:

getSmbPath in interface SharedItem

Returns:

Full SMB path

getParentPath

public T getParentPath()
                throws IOException

Get the parent shared item. If the shared item us already the root item, the root item will be returned.

Specified by:

getParentPath in interface SharedItem

Returns:

Parent shared item

Throws:

IOException - Exception in case of a problem

getRootPath

public T getRootPath()
              throws IOException

Get the root shared item. If the shared item us already the root item, the root item will be returned.

Specified by:

getRootPath in interface SharedItem

Returns:

Root shared item

Throws:

IOException - Exception in case of a problem

isRootPath

public boolean isRootPath()

Check if the current shared item or its parent is the root shared item.

Specified by:

isRootPath in interface SharedItem

Returns:

Status of the check

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

createSharedNodeItem

protected abstract T createSharedNodeItem(String pathName)
                                   throws IOException

Create a new shared item. This factory method is defined to enable directory/file like decoupling.

Parameters:

pathName - Path name of the shared item

Returns:

Shared item

Throws:

IOException - Exception in case of a problem