ch.pontius.nio.smb

Class SMBFileStore

java.lang.Object

java.nio.file.FileStore

ch.pontius.nio.smb.SMBFileStore

public final class SMBFileStore
extends FileStore

This class represents a single SMB share on a specific SMBFileSystem. It provides access to basic attributes of that share.

Since:

1.0

Version:

1.0

Author:

Ralph Gasser

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Object	getAttribute(String attribute) Always throws an UnsupportedOperationException as FileStoreAttributeView are currently not supported.
<V extends FileStoreAttributeView> V	getFileStoreAttributeView(Class<V> type) Always returns null as FileStoreAttributeView are currently not supported.
long	getTotalSpace() Returns the total capacity of the share represented by this SMBFileStore instance.
long	getUnallocatedSpace() Returns the number of bytes that are currently available on the share represented by this SMBFileStore instance.
long	getUsableSpace() Returns the number of bytes that are currently available on the share represented by this SMBFileStore instance.
int	hashCode()
boolean	isReadOnly() Returns false because generally, SMBFileStore's are not considered to be read-only.
String	name() Returns the full name of this SMBFileStore, which includes the FQN of the SMBFileSystem and the name of the associated share.
boolean	supportsFileAttributeView(Class<? extends FileAttributeView> type) Checks whether or not this SMBFileStore supports the file attributes identified by the given file attribute view.
boolean	supportsFileAttributeView(String name) Checks whether or not this SMBFileStore supports the file attributes identified by the given file attribute view.
String	type() Returns the type of the SMBFileStore, which is "share".

Methods inherited from class java.lang.Object

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

Method Detail

name

public String name()

Returns the full name of this SMBFileStore, which includes the FQN of the SMBFileSystem and the name of the associated share.

Specified by:

name in class FileStore

Returns:

Full name of SMBFileStore

type

public String type()

Returns the type of the SMBFileStore, which is "share".

Specified by:

type in class FileStore

Returns:

"share"

isReadOnly

public boolean isReadOnly()

Returns false because generally, SMBFileStore's are not considered to be read-only. However, the concrete access permissions are specific to a file or resource.

Specified by:

isReadOnly in class FileStore

Returns:

false

getTotalSpace

public long getTotalSpace()
                   throws IOException

Returns the total capacity of the share represented by this SMBFileStore instance.

Specified by:

getTotalSpace in class FileStore

Returns:

Total capacity of the share represented by this SMBFileStore instance

Throws:

IOException - If total capacity cannot be determined.

getUsableSpace

public long getUsableSpace()
                    throws IOException

Returns the number of bytes that are currently available on the share represented by this SMBFileStore instance. The value returned by this method is always the same as getUnallocatedSpace()

Specified by:

getUsableSpace in class FileStore

Returns:

Number of bytes currently available.

Throws:

IOException - If usable space cannot be determined.

getUnallocatedSpace

public long getUnallocatedSpace()
                         throws IOException

Returns the number of bytes that are currently available on the share represented by this SMBFileStore instance. The value returned by this method is always the same as getUsableSpace()

Specified by:

getUnallocatedSpace in class FileStore

Returns:

Number of bytes currently available.

Throws:

IOException - If usable space cannot be determined.

supportsFileAttributeView

public boolean supportsFileAttributeView(Class<? extends FileAttributeView> type)

Checks whether or not this SMBFileStore supports the file attributes identified by the given file attribute view.

Specified by:

supportsFileAttributeView in class FileStore

Parameters:

type - The type of the FileAttributeView for which support should be verified.

Returns:

True if FileAttributeView is supported, false otherwise.

supportsFileAttributeView

public boolean supportsFileAttributeView(String name)

Checks whether or not this SMBFileStore supports the file attributes identified by the given file attribute view.

Specified by:

supportsFileAttributeView in class FileStore

Parameters:

name - Name of the FileAttributeView for which support should be verified.

Returns:

True if FileAttributeView is supported, false otherwise.

getFileStoreAttributeView

public <V extends FileStoreAttributeView> V getFileStoreAttributeView(Class<V> type)

Always returns null as FileStoreAttributeView are currently not supported.

Specified by:

getFileStoreAttributeView in class FileStore

Parameters:

type - The Class object corresponding to the attribute view

Returns:

null

getAttribute

public Object getAttribute(String attribute)
                    throws IOException

Always throws an UnsupportedOperationException as FileStoreAttributeView are currently not supported.

Specified by:

getAttribute in class FileStore

Throws:

UnsupportedOperationException - Always

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object