你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
CloudFileDirectory 类
- java.
lang. Object - ListFileItem
- com.
microsoft. azure. storage. file. CloudFileDirectory
- com.
public class CloudFileDirectory implements ListFileItem
表示文件的虚拟目录。
封装为 CloudFileDirectory 对象的目录保存文件,还可以包含子目录。
构造函数摘要
构造函数 | 说明 |
---|---|
CloudFileDirectory(final StorageUri directoryAbsoluteUri) |
使用目录的绝对 URI 创建 类的实例。 |
CloudFileDirectory(final StorageUri directoryAbsoluteUri, final StorageCredentials credentials) |
使用目录和凭据的绝对 URI 创建 类的实例。 |
CloudFileDirectory(final StorageUri uri, final String directoryName, final CloudFileShare share) |
使用指定的地址、共享和客户端创建 类的实例。 |
CloudFileDirectory(final URI directoryAbsoluteUri) |
使用目录的绝对 URI 创建 类的实例。 |
CloudFileDirectory(final URI directoryAbsoluteUri, final StorageCredentials credentials) |
使用目录和凭据的绝对 URI 创建 类的实例。 |
方法摘要
构造函数详细信息
CloudFileDirectory
public CloudFileDirectory(final StorageUri directoryAbsoluteUri)
使用目录的绝对 URI 创建 类的实例。
Parameters:
Throws:
CloudFileDirectory
public CloudFileDirectory(final StorageUri directoryAbsoluteUri, final StorageCredentials credentials)
使用目录和凭据的绝对 URI 创建 类的实例。
Parameters:
Throws:
CloudFileDirectory
protected CloudFileDirectory(final StorageUri uri, final String directoryName, final CloudFileShare share)
使用指定的地址、共享和客户端创建 类的实例。
Parameters:
String
目录名称的 。
CloudFileDirectory
public CloudFileDirectory(final URI directoryAbsoluteUri)
使用目录的绝对 URI 创建 类的实例。
Parameters:
Throws:
CloudFileDirectory
public CloudFileDirectory(final URI directoryAbsoluteUri, final StorageCredentials credentials)
使用目录和凭据的绝对 URI 创建 类的实例。
Parameters:
Throws:
方法详细信息
assertValidFilePermissionOrKey
protected void assertValidFilePermissionOrKey()
验证目录的 filePermission 和 properties.filePermissionKey 是否都未设置。
closeAllHandlesSegmented
public ResultSegment
关闭此文件上的所有 SMB 句柄。
Returns:
Throws:
closeAllHandlesSegmented
public ResultSegment
关闭此文件上的所有 SMB 句柄。
Parameters:
Returns:
Throws:
closeHandleSegmented
public ResultSegment
关闭此文件上的所有 SMB 句柄。
Parameters:
Returns:
Throws:
closeHandleSegmented
public ResultSegment
关闭此文件上的所有 SMB 句柄。
Parameters:
Returns:
Throws:
create
public void create()
创建目录。
Throws:
create
public void create(FileRequestOptions options, OperationContext opContext)
使用指定的选项和操作上下文创建目录。
Parameters:
Throws:
createIfNotExists
public boolean createIfNotExists()
如果目录不存在,则创建该目录。
Returns:
如果目录不存在但已创建,则为 true
;否则为 false
。
Throws:
createIfNotExists
public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文创建目录(如果不存在)。
Parameters:
Returns:
如果目录不存在但已创建,则为 true
;否则为 false
。
Throws:
delete
public void delete()
删除目录。
Throws:
delete
public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文删除目录。
Parameters:
Throws:
deleteIfExists
public boolean deleteIfExists()
删除目录(如果存在)。
Returns:
如果目录不存在但已创建,则为 true
;否则为 false
。
Throws:
deleteIfExists
public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文删除目录(如果存在)。
Parameters:
Returns:
true
如果目录存在并且已删除,则为 ;否则为 false
。
Throws:
downloadAttributes
public void downloadAttributes()
下载目录的属性。
Throws:
downloadAttributes
public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文下载目录的属性。
Parameters:
Throws:
exists
public boolean exists()
返回一个值,该值指示目录是否存在。
Returns:
true
如果目录存在,则为 ;否则为 false
。
Throws:
exists
public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文返回一个值,该值指示目录是否存在。
Parameters:
Returns:
true
如果目录存在,则为 ;否则为 false
。
Throws:
getDirectoryReference
public CloudFileDirectory getDirectoryReference(final String itemName)
返回对 CloudFileDirectory 对象的引用,该对象表示此目录中的目录。
Parameters:
String
,表示目录的名称。
Returns:
Throws:
getFileReference
getMetadata
public HashMap
返回目录的元数据。 此值通过调用 downloadAttributes(),使用目录中的元数据进行初始化,并在目录中通过调用 来 uploadMetadata()设置此值。
Returns:
java.util.HashMap
对象,表示目录的元数据。getName
public String getName()
返回此目录的名称。
Returns:
String
,表示目录的名称。getParent
public CloudFileDirectory getParent()
返回与此 CloudFileDirectory 目录关联的父目录。
Overrides:
CloudFileDirectory.getParent()Returns:
Throws:
getProperties
public FileDirectoryProperties getProperties()
返回 FileDirectoryProperties 保存目录的系统属性的 对象。
Returns:
getServiceClient
public CloudFileClient getServiceClient()
返回与此目录关联的文件服务客户端。
Returns:
getShare
public CloudFileShare getShare()
返回此目录的共享。
Overrides:
CloudFileDirectory.getShare()Returns:
Throws:
getStorageUri
public final StorageUri getStorageUri()
返回所有位置的 URI 列表。
Overrides:
CloudFileDirectory.getStorageUri()Returns:
getUri
public URI getUri()
返回此目录的 URI。
Overrides:
CloudFileDirectory.getUri()Returns:
java.net.URI
对象,表示此目录的 URI。listFilesAndDirectories
public Iterable
返回目录的文件和目录项的可枚举集合。
Returns:
listFilesAndDirectories
public Iterable
返回目录的文件和目录项的可枚举集合。
Parameters:
Returns:
listFilesAndDirectories
public Iterable
返回目录的文件和目录项的可枚举集合。
Parameters:
Returns:
listFilesAndDirectoriesSegmented
public ResultSegment
返回此文件服务客户端的文件和目录的可枚举集合的结果段。
Returns:
Throws:
listFilesAndDirectoriesSegmented
public ResultSegment
使用指定的列表详细信息选项、请求选项和操作上下文返回此目录的文件和目录的可枚举集合的结果段。
Parameters:
null
或大于 5000,服务器将返回最多 5,000 个项。 必须至少为 1。
Returns:
Throws:
listFilesAndDirectoriesSegmented
public ResultSegment
使用指定的列表详细信息选项、请求选项和操作上下文返回此目录的文件和目录的可枚举集合的结果段。
Parameters:
null
或大于 5000,服务器将返回最多 5,000 个项。 必须至少为 1。
Returns:
Throws:
listHandles
public Iterable
获取对此文件打开的 SMB 句柄。
Returns:
可迭代
</code> of the handles that will lazily request new segments. </p>
listHandles
public Iterable listHandles(boolean recursive, FileRequestOptions options, OperationContext opContext)
获取对此文件打开的 SMB 句柄。
Parameters:
recursive
- 指定操作是否应应用于 URI 中指定的目录、其文件、子目录及其文件。
opContext
- 一个 OperationContext 对象,表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
Returns:
可迭代
</code> of the handles that will lazily request new segments. </p>
listHandlesSegmented
public ResultSegment listHandlesSegmented()
获取对此文件打开的 SMB 句柄。
Returns:
一个 ResultSegment<T> 对象,该对象包含表示文件和目录的 ListFileItem 可枚举对象集合的段。
Throws:
StorageException
listHandlesSegmented
public ResultSegment listHandlesSegmented(final Integer maxResults, final boolean recursive, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
获取在此文件上打开的 SMB 句柄。
Parameters:
maxResults
- 要检索的最大结果数。 如果 null
或大于 5000,服务器将返回最多 5,000 个项。 必须至少为 1。
recursive
- 指定操作是否应应用于 URI 中指定的目录、其文件、子目录及其文件。
continuationToken
- 一个 ResultContinuation 对象,该对象表示上一个列表操作返回的继续标记。
opContext
- 一个 OperationContext 对象,表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
Returns:
一个 ResultSegment<T> 对象,该对象包含表示文件和目录的 ListFileItem 对象的可枚举集合的段。
Throws:
StorageException
setFilePermission
public void setFilePermission(String filePermission)
设置目录的文件权限
Parameters:
filePermission
- 表示 String
目录的文件权限的 。
setMetadata
public void setMetadata(HashMap metadata)
使用 调用设置要在目录中 uploadMetadata() 设置的名称/值对的元数据集合。 此集合将覆盖任何现有目录元数据。 如果将其设置为空集合,则会在调用时 uploadMetadata() 清除目录元数据。
Parameters:
metadata
- 一个 java.util.HashMap
对象,表示要分配给目录的元数据。
setProperties
protected final void setProperties(final FileDirectoryProperties properties)
设置目录的属性。
Parameters:
properties
- 一个 FileDirectoryProperties 对象,表示要分配给目录的属性。
setShare
protected final void setShare(final CloudFileShare share)
设置目录的共享。
Parameters:
share
- 一个 CloudFileShare 对象,表示要分配给目录的共享。
setStorageUri
protected void setStorageUri(final StorageUri storageUri)
设置所有位置的 URI 列表。
Parameters:
storageUri
- 一个 StorageUri ,表示所有位置的 URI 列表。
uploadMetadata
public void uploadMetadata()
上传目录的元数据。
Throws:
StorageException
- 如果发生存储服务错误。
URISyntaxException
uploadMetadata
public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文上传目录的元数据。
Parameters:
accessCondition
- 一个 AccessCondition 对象,表示目录的访问条件。
opContext
- 一个 OperationContext 对象,它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
Throws:
StorageException
- 如果发生存储服务错误。
URISyntaxException
uploadProperties
public final void uploadProperties()
将目录的属性上传到存储服务。
使用 downloadAttributes() 从 Microsoft Azure 存储服务检索目录属性和元数据的最新值。
Throws:
StorageException
- 如果发生存储服务错误。
URISyntaxException
uploadProperties
public final void uploadProperties(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
使用访问条件、请求选项和操作上下文上传目录的属性。
使用 downloadAttributes() 从 Microsoft Azure 存储服务检索目录属性和元数据的最新值。
Parameters:
accessCondition
- 一个 AccessCondition 对象,表示目录的访问条件。
opContext
- 一个 OperationContext 对象,它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
Throws:
StorageException
- 如果发生存储服务错误。
URISyntaxException
适用于