Class Directory
- java.lang.Object
-
- com.hierynomus.smbj.share.Open<DiskShare>
-
- 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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private class
Directory.DirectoryIterator<F extends FileDirectoryQueryableInformation>
-
Nested classes/interfaces inherited from class com.hierynomus.smbj.share.Open
Open.LockBuilder
-
-
Constructor Summary
Constructors Constructor Description Directory(SMB2FileId fileId, DiskShare diskShare, SmbPath fileName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SMB2FileId
getFileId()
java.util.Iterator<FileIdBothDirectoryInformation>
iterator()
Equivalent to callingiterator(FileIdBothDirectoryInformation.class, null)
.<F extends FileDirectoryQueryableInformation>
java.util.Iterator<F>iterator(java.lang.Class<F> informationClass)
Equivalent to callingiterator(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 callinglist(FileIdBothDirectoryInformation.class, null)
.<F extends FileDirectoryQueryableInformation>
java.util.List<F>list(java.lang.Class<F> informationClass)
Equivalent to callinglist(informationClass, null)
.<F extends FileDirectoryQueryableInformation>
java.util.List<F>list(java.lang.Class<F> informationClass, java.lang.String searchPattern)
Callsiterator(FileIdBothDirectoryInformation.class, null)
and collects the contents of the returned iterator in a list.java.lang.String
toString()
java.util.concurrent.Future<SMB2ChangeNotifyResponse>
watchAsync(java.util.Set<SMB2CompletionFilter> completionFilter, boolean watchTree)
Send a change notify request and and return a Future for change notify response.-
Methods inherited from class com.hierynomus.smbj.share.DiskEntry
closeNoWait, createHardlink, createHardlink, deleteOnClose, equals, flush, getDiskShare, getFileInformation, getFileInformation, getFileName, getPath, getSecurityInformation, getUncPath, hashCode, ioctl, ioctl, ioctl, rename, rename, rename, setFileInformation, setSecurityInformation, setSecurityInformation
-
Methods inherited from class com.hierynomus.smbj.share.Open
close, closeSilently, lockRequest, requestLock
-
-
-
-
Constructor Detail
-
Directory
Directory(SMB2FileId fileId, DiskShare diskShare, SmbPath fileName)
-
-
Method Detail
-
list
public java.util.List<FileIdBothDirectoryInformation> list() throws SMBApiException
Equivalent to callinglist(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 callinglist(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)
Callsiterator(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 callingiterator(FileIdBothDirectoryInformation.class, null)
.- Specified by:
iterator
in interfacejava.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 callingiterator(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 isnull
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.
-
watchAsync
public java.util.concurrent.Future<SMB2ChangeNotifyResponse> watchAsync(java.util.Set<SMB2CompletionFilter> completionFilter, boolean watchTree)
Send a change notify request and and return a Future for change notify response.- Parameters:
completionFilter
- types of changes to monitorwatchTree
- monitor changes on any file or directory contained beneath the directory- Returns:
- a Future to be used to retrieve the change notify response packet
-
getFileId
public SMB2FileId getFileId()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-