com.hierynomus.smbj.share

Class Directory

java.lang.Object

com.hierynomus.smbj.share.DiskEntry

com.hierynomus.smbj.share.Directory

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<FileIdBothDirectoryInformation>

public class Directory
extends DiskEntry
implements java.lang.Iterable<FileIdBothDirectoryInformation>

Field Summary

Fields inherited from class com.hierynomus.smbj.share.DiskEntry

fileId, fileName, logger, share

Method Summary

Modifier and Type	Method and Description
SMB2FileId	getFileId()
java.util.Iterator<FileIdBothDirectoryInformation>	iterator() Equivalent to calling iterator(FileIdBothDirectoryInformation.class, null).
<F extends FileDirectoryQueryableInformation> java.util.Iterator<F>	iterator(java.lang.Class<F> informationClass) Equivalent to calling iterator(informationClass, null).
<F extends FileDirectoryQueryableInformation> java.util.Iterator<F>	iterator(java.lang.Class<F> informationClass, java.lang.String searchPattern) Returns an iterator of the contents of this directory.
java.util.List<FileIdBothDirectoryInformation>	list() Equivalent to calling list(FileIdBothDirectoryInformation.class, null).
<F extends FileDirectoryQueryableInformation> java.util.List<F>	list(java.lang.Class<F> informationClass) Equivalent to calling list(informationClass, null).
<F extends FileDirectoryQueryableInformation> java.util.List<F>	list(java.lang.Class<F> informationClass, java.lang.String searchPattern) Calls iterator(FileIdBothDirectoryInformation.class, null) and collects the contents of the returned iterator in a list.
java.lang.String	toString()

Methods inherited from class com.hierynomus.smbj.share.DiskEntry

close, closeSilently, createHardlink, createHardlink, deleteOnClose, flush, getDiskShare, getFileInformation, getFileInformation, getFileName, getSecurityInformation, ioctl, ioctl, rename, rename, rename, setFileInformation, setSecurityInformation, setSecurityInformation

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

list

public java.util.List<FileIdBothDirectoryInformation> list()
                                                    throws SMBApiException

Equivalent to calling list(FileIdBothDirectoryInformation.class, null).

Throws:

SMBApiException

See Also:

list(Class, String)

list

public <F extends FileDirectoryQueryableInformation> java.util.List<F> list(java.lang.Class<F> informationClass)
                                                                     throws SMBApiException

Equivalent to calling list(informationClass, null).

Throws:

SMBApiException

See Also:

list(Class, String)

list

public <F extends FileDirectoryQueryableInformation> java.util.List<F> list(java.lang.Class<F> informationClass,
                                                                            java.lang.String searchPattern)

Calls iterator(FileIdBothDirectoryInformation.class, null) and collects the contents of the returned iterator in a list.

See Also:

iterator(Class, String)

iterator

public java.util.Iterator<FileIdBothDirectoryInformation> iterator()

Equivalent to calling iterator(FileIdBothDirectoryInformation.class, null).

Specified by:

iterator in interface java.lang.Iterable<FileIdBothDirectoryInformation>

See Also:

iterator(Class, String)

iterator

public <F extends FileDirectoryQueryableInformation> java.util.Iterator<F> iterator(java.lang.Class<F> informationClass)

Equivalent to calling iterator(informationClass, null).

See Also:

iterator(Class, String)

iterator

public <F extends FileDirectoryQueryableInformation> java.util.Iterator<F> iterator(java.lang.Class<F> informationClass,
                                                                                    java.lang.String searchPattern)

Returns an iterator of the contents of this directory.

The optional searchPattern parameter can contain the name of a file (or multiple files, if wildcards are used) within this directory. When it is not null only files whose names match the search pattern string are included in the resulting iterator. When it is null all files are included.

Two wild card characters are supported in the search pattern. The "?" (question mark) character matches a single character. If a search pattern contains one or more "?" characters, then exactly that number of characters is matched by the wildcards. For example, the criterion "??x" matches "abx" but not "abcx" or "ax", because the two file names do not have enough characters preceding the literal. When a file name criterion has "?" characters trailing a literal, then the match is made with specified number of characters or less. For example, the criterion "x??" matches "xab", "xa", and "x", but not "xabc". If only "?" characters are present in the file name selection criterion, then the match is made as if the criterion contained "?" characters trailing a literal. The "*" (asterisk) character matches an entire file name. A null or empty specification criterion also selects all file names. For example, "*.abc" or ".abc" match any file with an extension of "abc". "*.*", "*", or empty string("") match all files in a directory.

getFileId

public SMB2FileId getFileId()

Overrides:

getFileId in class DiskEntry

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object