你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CloudFile 类

参考

包:: com.microsoft.azure.storage.file

java.lang.Object
- ListFileItem
- - com.microsoft.azure.storage.file.CloudFile

public class CloudFile implements ListFileItem

表示 Microsoft Azure 文件。

字段摘要

修饰符和类型	字段和描述
CloudFileClient	fileServiceClient 表示文件服务客户端。
CloudFileDirectory	parent 表示文件的目录引用。
int	streamMinimumReadSizeInBytes 使用 FileInputStream时保留最小读取大小。
int	streamWriteSizeInBytes 在写入 FileOutputStream时保留要缓冲的字节数。

构造函数摘要

构造函数	说明
CloudFile(final CloudFile otherFile)	通过从另一个云文件复制值来创建类的实例。
CloudFile(final StorageUri fileAbsoluteUri)	使用指定的绝对 StorageUri 创建类的实例。
CloudFile(final StorageUri fileAbsoluteUri, final StorageCredentials credentials)	使用指定的绝对 StorageUri 和凭据创建类的实例。
CloudFile(final StorageUri uri, final String fileName, final CloudFileShare share)	使用指定的地址、共享和客户端创建类的实例。
CloudFile(final URI fileAbsoluteUri)	使用指定的绝对 URI 创建类的实例。
CloudFile(final URI fileAbsoluteUri, final StorageCredentials credentials)	使用指定的绝对 URI 和凭据创建类的实例。

方法摘要

修饰符和类型	方法和描述
final void	abortCopy(final String copyId) 中止正在进行的 Azure 文件复制操作。
final void	abortCopy(final String copyId, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 中止正在进行的 Azure 文件复制操作。
void	assertValidFilePermissionOrKey() 验证目录的 filePermission 和 properties.filePermissionKey 是否都未设置。
void	clearRange(final long offset, final long length) 清除文件中的范围。调用将释放指定范围使用的存储空间。已清除的范围不再作为文件的一部分进行跟踪。
void	clearRange(final long offset, final long length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的租约 ID、请求选项和操作上下文从文件中清除范围。调用将释放指定范围使用的存储空间。已清除的范围不再作为文件的一部分进行跟踪。
ResultSegment<Integer>	closeAllHandlesSegmented() 关闭此文件上的所有 SMB 句柄。
ResultSegment<Integer>	closeAllHandlesSegmented(final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext) 关闭此文件上的所有 SMB 句柄。
ResultSegment<Integer>	closeHandleSegmented(String handleID) 关闭此文件上的所有 SMB 句柄。
ResultSegment<Integer>	closeHandleSegmented(String handleID, ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext) 关闭此文件上的所有 SMB 句柄。
void	create(final long size) 创建文件。如果文件已存在，这将替换它。
void	create(final long size, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的访问条件、请求选项和操作上下文创建文件。如果文件已存在，这将替换它。
final void	delete() 删除文件。
final void	delete(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的访问条件、请求选项和操作上下文删除文件。
final boolean	deleteIfExists() 删除文件（如果存在）。
final boolean	deleteIfExists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的访问条件、请求选项和操作上下文删除文件（如果存在）。
final void	download(final OutputStream outStream) 将文件的内容下载到流中。
final void	download(final OutputStream outStream, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文将文件的内容下载到流中。
final void	downloadAttributes() 填充文件的属性和元数据。此方法填充文件的系统属性和用户定义的元数据。在读取或修改文件的属性或元数据之前，请调用此方法或其重载，以从 Microsoft Azure 存储服务检索文件属性和元数据的最新值。
final void	downloadAttributes(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文填充文件的属性和元数据。此方法填充文件的系统属性和用户定义的元数据。在读取或修改文件的属性或元数据之前，请调用此方法或其重载，以从 Microsoft Azure 存储服务检索文件属性和元数据的最新值。
ArrayList<FileRange>	downloadFileRanges() 返回文件范围及其起始字节和结束字节偏移量的集合。每个文件范围的起始字节和结束字节偏移是非独占的。
ArrayList<FileRange>	downloadFileRanges(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文返回文件范围及其起始字节和结束字节偏移量的集合。
final void	downloadRange(final long offset, final Long length, final OutputStream outStream) 将文件的内容下载到流。
final void	downloadRange(final long offset, final Long length, final OutputStream outStream, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文将文件的内容下载到流中。
final int	downloadRangeInternal(final long fileOffset, final Long length, final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 将文件中的一系列字节下载到给定字节缓冲区。
final int	downloadRangeToByteArray(final long offset, final Long length, final byte[] buffer, final int bufferOffset) 将文件中的一系列字节下载到给定字节缓冲区。
final int	downloadRangeToByteArray(final long offset, final Long length, final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文将文件中的一系列字节下载到给定的字节缓冲区。
String	downloadText() 使用平台的默认编码将文件下载到字符串。
String	downloadText(final String charsetName, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的编码将文件下载到字符串。
final int	downloadToByteArray(final byte[] buffer, final int bufferOffset) 将文件中的一系列字节下载到给定字节缓冲区。
final int	downloadToByteArray(final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文将文件中的一系列字节下载到给定的字节缓冲区。
void	downloadToFile(final String path) 下载一个文件。
void	downloadToFile(final String path, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 下载一个文件。
final boolean	exists() 检查文件是否存在。
final boolean	exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的访问条件、请求选项和操作上下文检查文件是否存在。
String	generateSharedAccessSignature(final SharedAccessFilePolicy policy, final SharedAccessFileHeaders headers, final String groupPolicyIdentifier) 使用指定的组策略标识符和共享访问文件标头返回文件的共享访问签名。请注意，这不包含前导“？”。
String	generateSharedAccessSignature(final SharedAccessFilePolicy policy, final SharedAccessFileHeaders headers, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols) 使用指定的组策略标识符和共享访问文件标头返回文件的共享访问签名。请注意，这不包含前导“？”。
String	generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier) 使用指定的组策略标识符和共享访问文件标头返回文件的共享访问签名。请注意，这不包含前导“？”。
CopyState	getCopyState() 返回 Azure 文件的复制状态。
final HashMap<String, String>	getMetadata() 返回文件的元数据。
final String	getName() 返回文件的名称。
final CloudFileDirectory	getParent() 返回文件项的父级。
String	getParentNameFromURI(final StorageUri resourceAddress, final CloudFileShare share) 检索文件 URI 的父名称。
final FileProperties	getProperties() 返回文件的属性。
final CloudFileClient	getServiceClient() 返回与文件关联的文件服务客户端。
final CloudFileShare	getShare() 返回文件的共享。
final StorageUri	getStorageUri() 返回所有位置的 URI 列表。
final int	getStreamMinimumReadSizeInBytes() 返回使用 FileInputStream时的最小读取大小。
final int	getStreamWriteSizeInBytes() 获取写入到 FileOutputStream时要缓冲的字节数。
final StorageUri	getTransformedAddress(final OperationContext opContext) 如果给定的凭据需要转换，则返回资源的转换 URI。
final URI	getUri() 返回此文件的 URI。
Iterable<FileHandle>	listHandles() 获取在此文件上打开的 SMB 句柄。
Iterable<FileHandle>	listHandles(FileRequestOptions options, OperationContext opContext) 获取在此文件上打开的 SMB 句柄。
ResultSegment<FileHandle>	listHandlesSegmented() 获取在此文件上打开的 SMB 句柄。
ResultSegment<FileHandle>	listHandlesSegmented(final Integer maxResults, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext) 获取在此文件上打开的 SMB 句柄。
final FileInputStream	openRead() 打开文件输入流以下载文件。使用 setStreamMinimumReadSizeInBytes(final int minimumReadSize) 配置读取大小。
final FileInputStream	openRead(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 打开文件输入流，以使用指定的请求选项和操作上下文下载文件。使用 setStreamMinimumReadSizeInBytes(final int minimumReadSize) 配置读取大小。
FileOutputStream	openWriteExisting() 打开输出流对象以将数据写入文件。该文件必须已存在，并且任何现有数据都可能被覆盖。
FileOutputStream	openWriteExisting(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文打开输出流对象以将数据写入文件。该文件必须已存在，并且任何现有数据都可能被覆盖。
FileOutputStream	openWriteNew(final long length) 打开输出流对象以将数据写入文件。该文件尚不存在，将使用指定的长度创建。如果服务上已存在该文件，则会覆盖该文件。若要避免覆盖并引发错误，请将重载与相应的 AccessCondition结合使用openWriteNew(final long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)。
FileOutputStream	openWriteNew(final long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的租约 ID、请求选项和操作上下文打开输出流对象以将数据写入文件。该文件尚不需要存在，将使用指定的长度创建。如果服务上已存在该文件，则会覆盖该文件。若要避免覆盖并引发错误，请使用传入 AccessCondition 生成的 generateIfNotExistsCondition()。
void	putRangeFromURL(final long destOffset, final long length, final URI sourceUri, final long sourceOffset) 将范围从一个文件上传到另一个文件。
void	putRangeFromURL(final long destOffset, final long length, final URI sourceUri, final long sourceOffset, FileRequestOptions options, OperationContext opContext) 使用指定的租约 ID、请求选项和操作上下文将范围从一个文件上传到另一个文件
void	resize(long size) 将文件大小调整为指定大小。
void	resize(long size, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 将文件大小调整为指定大小。
void	setFilePermission(String filePermission) 设置要设置的文件权限
final void	setMetadata(final HashMap<String, String> metadata) 设置文件的元数据。
final void	setProperties(final FileProperties properties) 设置文件的属性。
final void	setShare(final CloudFileShare share) 设置文件的共享。
void	setStorageUri(final StorageUri storageUri) 设置所有位置的 URI 列表。
void	setStreamMinimumReadSizeInBytes(final int minimumReadSize) 设置使用 FileInputStream时的最小读取大小。
void	setStreamWriteSizeInBytes(final int streamWriteSizeInBytes) 设置写入时 FileOutputStream要缓冲的字节数。
final String	startCopy(final CloudBlob sourceBlob) 请求服务开始将 Blob 的内容、属性和元数据复制到新文件。
final String	startCopy(final CloudBlob sourceBlob, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, FileRequestOptions options, OperationContext opContext) 请求服务使用指定的访问条件、租约 ID、请求选项和操作上下文开始将文件的内容、属性和元数据复制到新文件。
final String	startCopy(final CloudFile sourceFile) 请求服务开始将 Azure 文件的内容、属性和元数据复制到新的 Azure 文件。
final String	startCopy(final CloudFile sourceFile, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, FileRequestOptions options, OperationContext opContext) 请求服务使用指定的访问条件、租约 ID、请求选项和操作上下文开始将 Azure 文件的内容、属性和元数据复制到新的 Azure 文件。
final String	startCopy(final URI source) 请求服务开始将 URI 的内容、属性和元数据复制到新的 Azure 文件。
final String	startCopy(final URI source, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, FileRequestOptions options, OperationContext opContext) 请求服务使用指定的访问条件、租约 ID、请求选项和操作上下文开始将 URI 的内容、属性和元数据复制到新的 Azure 文件。
void	updateEtagAndLastModifiedFromResponse(HttpURLConnection request)
void	updateLengthFromResponse(HttpURLConnection request)
void	upload(final InputStream sourceStream, final long length) 将源流数据上传到文件。如果服务上已存在该文件，则会覆盖该文件。
void	upload(final InputStream sourceStream, final long length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的访问条件、请求选项和操作上下文将源流数据上传到文件。如果服务上已存在该文件，则会覆盖该文件。
void	uploadFromByteArray(final byte[] buffer, final int offset, final int length) 从字节数组中的数据上传文件。如果服务上已存在该文件，则会覆盖该文件。
void	uploadFromByteArray(final byte[] buffer, final int offset, final int length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 从字节数组中的数据上传文件。如果服务上已存在该文件，则会覆盖该文件。
void	uploadFromFile(final String path) 上传本地文件。如果服务上已存在该文件，则会覆盖该文件。
void	uploadFromFile(final String path, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 从本地文件上传文件。如果服务上已存在该文件，则会覆盖该文件。
final void	uploadMetadata() 将文件的元数据上传到存储服务。使用 downloadAttributes() 从 Microsoft Azure 存储服务检索文件属性和元数据的最新值。
final void	uploadMetadata(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用访问条件、请求选项和操作上下文将文件的元数据上传到存储服务。使用 downloadAttributes() 从 Microsoft Azure 存储服务检索文件属性和元数据的最新值。
final void	uploadProperties() 将文件的属性上传到存储服务。使用 downloadAttributes() 从 Microsoft Azure 存储服务检索文件属性和元数据的最新值。
final void	uploadProperties(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用访问条件、请求选项和操作上下文上传文件的属性。使用 downloadAttributes() 从 Microsoft Azure 存储服务检索文件属性和元数据的最新值。
void	uploadRange(final InputStream sourceStream, final long offset, final long length) 将范围上传到文件。
void	uploadRange(final InputStream sourceStream, final long offset, final long length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的租约 ID、请求选项和操作上下文将范围上传到文件。
void	uploadText(final String content) 使用平台的默认编码从字符串上传文件。如果服务上已存在该文件，则会覆盖该文件。
void	uploadText(final String content, final String charsetName, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext) 使用指定的编码从字符串上传文件。如果服务上已存在该文件，则会覆盖该文件。

字段详细信息

fileServiceClient

protected CloudFileClient fileServiceClient

表示文件服务客户端。

parent

protected CloudFileDirectory parent

表示文件的目录引用。

streamMinimumReadSizeInBytes

protected int streamMinimumReadSizeInBytes= Constants.DEFAULT_MINIMUM_READ_SIZE_IN_BYTES

使用 FileInputStream时保留最小读取大小。

streamWriteSizeInBytes

protected int streamWriteSizeInBytes= Constants.DEFAULT_STREAM_WRITE_IN_BYTES

在写入 FileOutputStream时保留要缓冲的字节数。

构造函数详细信息

CloudFile

public CloudFile(final CloudFile otherFile)

通过从另一个云文件复制值来创建类的实例。

Parameters:

otherFile - 一个 CloudFile 表示要复制的文件的对象。

CloudFile

public CloudFile(final StorageUri fileAbsoluteUri)

使用指定的绝对 StorageUri 创建类的实例。

Parameters:

fileAbsoluteUri - 一个 StorageUri 对象，表示文件的绝对 URI。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

CloudFile

public CloudFile(final StorageUri fileAbsoluteUri, final StorageCredentials credentials)

使用指定的绝对 StorageUri 和凭据创建类的实例。

Parameters:

fileAbsoluteUri - 一个 StorageUri 对象，表示文件的绝对 URI。

credentials - StorageCredentials用于对访问进行身份验证的对象。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

CloudFile

protected CloudFile(final StorageUri uri, final String fileName, final CloudFileShare share)

使用指定的地址、共享和客户端创建类的实例。

Parameters:

uri - 表示 StorageUri 文件目录地址的。

fileName - 一个 String ，它表示文件的名称。

share - 一个 CloudFileShare 表示关联文件共享的对象。

CloudFile

public CloudFile(final URI fileAbsoluteUri)

使用指定的绝对 URI 创建类的实例。

Parameters:

fileAbsoluteUri - 一个 java.net.URI 对象，表示文件的绝对 URI。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

CloudFile

public CloudFile(final URI fileAbsoluteUri, final StorageCredentials credentials)

使用指定的绝对 URI 和凭据创建类的实例。

Parameters:

fileAbsoluteUri - 一个 java.net.URI 对象，表示文件的绝对 URI。

credentials - StorageCredentials用于对访问进行身份验证的对象。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

方法详细信息

abortCopy

public final void abortCopy(final String copyId)

中止正在进行的 Azure 文件复制操作。

Parameters:

copyId - 标识 String 复制操作的对象。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

abortCopy

public final void abortCopy(final String copyId, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

中止正在进行的 Azure 文件复制操作。

Parameters:

copyId - 标识 String 复制操作的对象。

accessCondition - 一个 AccessCondition 对象，表示 Azure 文件的访问条件。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

assertValidFilePermissionOrKey

protected void assertValidFilePermissionOrKey()

验证目录的 filePermission 和 properties.filePermissionKey 是否都未设置。

clearRange

public void clearRange(final long offset, final long length)

清除文件中的范围。

调用将释放指定范围使用的存储空间。已清除的范围不再作为文件的一部分进行跟踪。

Parameters:

offset - 要开始清除的偏移量（以字节为单位）。

length - 要清除的数据范围的长度（以字节为单位）。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

clearRange

public void clearRange(final long offset, final long length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的租约 ID、请求选项和操作上下文从文件中清除范围。

调用将释放指定范围使用的存储空间。已清除的范围不再作为文件的一部分进行跟踪。

Parameters:

offset - 一个， long 表示开始清除的偏移量（以字节为单位）。

length - 一个， long 表示要清除的数据范围的长度（以字节为单位）。

accessCondition - 一个 AccessCondition 对象，表示文件的访问条件。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

closeAllHandlesSegmented

public ResultSegment closeAllHandlesSegmented()

关闭此文件上的所有 SMB 句柄。

Returns:

具有 ResultSegment<T> 一个元素，该元素是关闭的句柄数，以及一个在操作花费太长而无法以原子方式完成的情况下要遵循的延续。

Throws:

StorageException

closeAllHandlesSegmented

public ResultSegment closeAllHandlesSegmented(final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)

关闭此文件上的所有 SMB 句柄。

Parameters:

continuationToken - 一个 ResultContinuation 对象，表示上一个列表操作返回的继续标记。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

具有 ResultSegment<T> 一个元素，该元素是关闭的句柄数，以及一个在操作花费太长而无法以原子方式完成的情况下要遵循的延续。

Throws:

StorageException

closeHandleSegmented

public ResultSegment closeHandleSegmented(String handleID)

关闭此文件上的所有 SMB 句柄。

Parameters:

handleID - 要关闭的句柄。

Returns:

具有 ResultSegment<T> 一个元素，该元素是关闭的句柄数，以及一个在操作花费太长而无法以原子方式完成的情况下要遵循的延续。

Throws:

StorageException

closeHandleSegmented

public ResultSegment closeHandleSegmented(String handleID, ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)

关闭此文件上的所有 SMB 句柄。

Parameters:

handleID - 要关闭的句柄。

continuationToken - 一个 ResultContinuation 对象，表示上一个列表操作返回的继续标记。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

具有 ResultSegment<T> 一个元素，该元素是关闭的句柄数，以及一个在操作花费太长而无法以原子方式完成的情况下要遵循的延续。

Throws:

StorageException

create

public void create(final long size)

创建文件。如果文件已存在，这将替换它。

Parameters:

size - 一个 long ，它表示文件的大小（以字节为单位）。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

create

public void create(final long size, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的访问条件、请求选项和操作上下文创建文件。如果文件已存在，这将替换它。

Parameters:

size - 一个 long ，它表示文件的大小（以字节为单位）。

accessCondition - 一个 AccessCondition 对象，表示文件的访问条件。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

delete

public final void delete()

删除文件。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

delete

public final void delete(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的访问条件、请求选项和操作上下文删除文件。

Parameters:

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

deleteIfExists

public final boolean deleteIfExists()

删除文件（如果存在）。

Returns:

true 如果文件已删除，则为 ;否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

deleteIfExists

public final boolean deleteIfExists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的访问条件、请求选项和操作上下文删除文件（如果存在）。

Parameters:

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

true 如果文件存在且已删除，则为 ;否则 false

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException

download

public final void download(final OutputStream outStream)

将文件的内容下载到流中。

Parameters:

outStream - 一个 OutputStream 表示目标流的对象。

Throws:

StorageException - 如果发生存储服务错误。

download

public final void download(final OutputStream outStream, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文将文件的内容下载到流中。

Parameters:

outStream - 一个 OutputStream 表示目标流的对象。

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

downloadAttributes

public final void downloadAttributes()

填充文件的属性和元数据。

此方法填充文件的系统属性和用户定义的元数据。在读取或修改文件的属性或元数据之前，请调用此方法或其重载，以从 Microsoft Azure 存储服务检索文件属性和元数据的最新值。

Throws:

StorageException - 如果发生存储服务错误。

downloadAttributes

public final void downloadAttributes(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文填充文件的属性和元数据。

Parameters:

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

downloadFileRanges

public ArrayList downloadFileRanges()

返回文件范围及其起始字节和结束字节偏移量的集合。

每个文件范围的起始字节和结束字节偏移是非独占的。

Returns:

一个 ArrayList 对象，表示文件范围集及其起始字节和结束字节偏移量。

Throws:

StorageException - 如果发生存储服务错误。

downloadFileRanges

public ArrayList downloadFileRanges(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文返回文件范围及其起始字节和结束字节偏移量的集合。

Parameters:

accessCondition - 一个 AccessCondition 对象，表示文件的访问条件。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。

opContext - 一个 OperationContext 对象，表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

一个 ArrayList 对象，表示文件范围集及其起始字节和结束字节偏移量。

Throws:

StorageException - 如果发生存储服务错误。

downloadRange

public final void downloadRange(final long offset, final Long length, final OutputStream outStream)

将文件的内容下载到流。

Parameters:

offset - 一个 long ，表示用作源起点的偏移量。

length - 一个 Long ，它表示要读取或 null的字节数。

outStream - 表示 OutputStream 目标流的对象。

Throws:

StorageException - 如果发生存储服务错误。

downloadRange

public final void downloadRange(final long offset, final Long length, final OutputStream outStream, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文将文件的内容下载到流中。

Parameters:

offset - 一个 long ，表示用作源起点的偏移量。

length - 一个 Long ，它表示要读取或 null的字节数。

outStream - 表示 OutputStream 目标流的对象。

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

downloadRangeInternal

protected final int downloadRangeInternal(final long fileOffset, final Long length, final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

将文件中的一系列字节下载到给定字节缓冲区。

Parameters:

fileOffset - ， long 它表示要开始下载的文件内的偏移量。

length - 一个 Long ，它表示要读取的字节数。

buffer - 表示 byte 要写入的缓冲区的数组。

bufferOffset - 一个 int ，表示要开始写入的字节缓冲区中的偏移量。

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。

opContext - 一个 OperationContext 对象，用于跟踪操作的执行。

Throws:

StorageException - 表示操作期间发生的任何错误的异常。

downloadRangeToByteArray

public final int downloadRangeToByteArray(final long offset, final Long length, final byte[] buffer, final int bufferOffset)

将文件中的一系列字节下载到给定字节缓冲区。

Parameters:

offset - 一个 long ，表示要用作源起点的字节偏移量。

length - ， Long 它表示要读取的字节数或 null。

buffer - 一个 byte 数组，表示将文件字节下载到的缓冲区。

bufferOffset - 一个 int ，表示用作目标的起点的字节偏移量。

Throws:

StorageException

downloadRangeToByteArray

public final int downloadRangeToByteArray(final long offset, final Long length, final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文将文件中的一系列字节下载到给定的字节缓冲区。

Parameters:

offset - 一个 long ，表示要用作源起点的字节偏移量。

length - 一个 Long ，它表示要读取或 null的字节数。

buffer - 一个 byte 数组，表示将文件字节下载到的缓冲区。

bufferOffset - 一个 int ，表示用作目标的起点的字节偏移量。

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

downloadText

public String downloadText()

使用平台的默认编码将文件下载到字符串。

Returns:

， String 它表示文件的内容。

Throws:

StorageException - 如果发生存储服务错误。

IOException

downloadText

public String downloadText(final String charsetName, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的编码将文件下载到字符串。

Parameters:

charsetName - 一个 String ，表示用于对内容进行编码的字符集的名称。如果为 null，则使用平台的默认编码。

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

， String 它表示文件的内容。

Throws:

StorageException - 如果发生存储服务错误。

IOException

downloadToByteArray

public final int downloadToByteArray(final byte[] buffer, final int bufferOffset)

将文件中的一系列字节下载到给定字节缓冲区。

Parameters:

buffer - 一个 byte 数组，表示将文件字节下载到的缓冲区。

bufferOffset - 一个 int ，表示用作目标的起点的字节偏移量。

Throws:

StorageException - 如果发生存储服务错误。

downloadToByteArray

public final int downloadToByteArray(final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文将文件中的一系列字节下载到给定的字节缓冲区。

Parameters:

buffer - 一个 byte 数组，表示将文件字节下载到的缓冲区。

bufferOffset - 一个 long ，它表示用作目标的起点的字节偏移量。

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

downloadToFile

public void downloadToFile(final String path)

下载一个文件。

Parameters:

path - ， String 它表示要创建的文件的路径。

Throws:

StorageException - 如果发生存储服务错误。

IOException

downloadToFile

public void downloadToFile(final String path, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

下载一个文件。

Parameters:

path - ， String 它表示要创建的文件的路径。

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

IOException

exists

public final boolean exists()

检查文件是否存在。

Returns:

true 如果文件存在，则为 ;否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

exists

public final boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

使用指定的访问条件、请求选项和操作上下文检查文件是否存在。

Parameters:

accessCondition - 一个表示文件访问条件的 AccessCondition 对象。

options - 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

true 如果文件存在，则为 ;否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final SharedAccessFileHeaders headers, final String groupPolicyIdentifier)

使用指定的组策略标识符和共享访问文件标头返回文件的共享访问签名。请注意，这不包含前导“？”。

Parameters:

policy - 一个 SharedAccessFilePolicy 对象，表示共享访问签名的访问策略。

headers - 一个 SharedAccessFileHeaders 对象，表示要为此共享访问签名访问的文件设置的可选标头值。

groupPolicyIdentifier - 表示 String 共享级别访问策略的。

Returns:

表示 String 共享访问签名的。

Throws:

IllegalArgumentException - 如果凭据无效。

InvalidKeyException - 如果凭据无效。

StorageException - 如果发生存储服务错误。

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final SharedAccessFileHeaders headers, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

使用指定的组策略标识符和共享访问文件标头返回文件的共享访问签名。请注意，这不包含前导“？”。

Parameters:

policy - 一个 SharedAccessFilePolicy 对象，表示共享访问签名的访问策略。

headers - 一个 SharedAccessFileHeaders 对象，表示要为此共享访问签名访问的文件设置的可选标头值。

groupPolicyIdentifier - 表示 String 共享级别访问策略的。

ipRange - 包含 IPRange 允许的 IP 地址范围的对象。

protocols - 表示 SharedAccessProtocols 允许的 Internet 协议的。

Returns:

表示 String 共享访问签名的。

Throws:

IllegalArgumentException - 如果凭据无效。

InvalidKeyException - 如果凭据无效。

StorageException - 如果发生存储服务错误。

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)

使用指定的组策略标识符和共享访问文件标头返回文件的共享访问签名。请注意，这不包含前导“？”。

Parameters:

policy - 一个 SharedAccessFilePolicy 对象，表示共享访问签名的访问策略。

groupPolicyIdentifier - 表示 String 共享级别访问策略的。

Returns:

表示 String 共享访问签名的。

Throws:

InvalidKeyException - 如果凭据无效。

StorageException - 如果发生存储服务错误。

getCopyState

public CopyState getCopyState()

返回 Azure 文件的复制状态。

Returns:

一个 CopyState 表示文件复制状态的对象。

getMetadata

public final HashMap getMetadata()

返回文件的元数据。

Returns:

一个 java.util.HashMap 对象，该对象表示文件的元数据。

getName

public final String getName()

返回文件的名称。

Returns:

一个 String ，它表示文件的名称。

getParent

public final CloudFileDirectory getParent()

返回文件项的父级。

Overrides:

CloudFile.getParent()

Returns:

一个 CloudFileDirectory 表示文件的父目录的对象。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getParentNameFromURI

protected static String getParentNameFromURI(final StorageUri resourceAddress, final CloudFileShare share)

检索文件 URI 的父名称。

Parameters:

resourceAddress - 一个 StorageUri 表示资源 URI 的对象。

share - 一个 CloudFileShare 表示文件共享的对象。

Returns:

， String 它表示文件 URI 的父地址。

Throws:

URISyntaxException

getProperties

public final FileProperties getProperties()

返回文件的属性。

Returns:

一个 FileProperties 表示文件属性的对象。

getServiceClient

public final CloudFileClient getServiceClient()

返回与文件关联的文件服务客户端。

Returns:

一个 CloudFileClient 表示客户端的对象。

getShare

public final CloudFileShare getShare()

返回文件的共享。

Overrides:

CloudFile.getShare()

Returns:

一个 CloudFileShare 表示文件共享的对象。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getStorageUri

public final StorageUri getStorageUri()

返回所有位置的 URI 列表。

Overrides:

CloudFile.getStorageUri()

Returns:

一个 StorageUri ，表示所有位置的 URI 列表。

getStreamMinimumReadSizeInBytes

public final int getStreamMinimumReadSizeInBytes()

返回使用 FileInputStream时的最小读取大小。

Returns:

， int 表示使用 FileInputStream 对象时最小读取大小（以字节为单位）。

getStreamWriteSizeInBytes

public final int getStreamWriteSizeInBytes()

获取写入到 FileOutputStream时要缓冲的字节数。

Returns:

一个 int ，表示要缓冲的字节数。

getTransformedAddress

protected final StorageUri getTransformedAddress(final OperationContext opContext)

如果给定的凭据需要转换，则返回资源的转换 URI。

Parameters:

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

一个 StorageUri 表示转换后的 URI 的对象。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getUri

public final URI getUri()

返回此文件的 URI。

Overrides:

CloudFile.getUri()

Returns:

一个 java.net.URI 对象，表示文件的 URI。

listHandles

public Iterable listHandles()

获取在此文件上打开的 SMB 句柄。

Returns:

可迭代

</code> of the handles that will lazily request new segments. </p>


			
				listHandles
				
						public Iterable listHandles(FileRequestOptions options, OperationContext opContext)


						获取在此文件上打开的 SMB 句柄。




						Parameters:
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。
							
							
								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 ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)


						获取在此文件上打开的 SMB 句柄。




						Parameters:
							
								maxResults
									- 要检索的最大结果数。 如果 null 或大于 5000，服务器将返回最多 5,000 个项目。 必须至少为 1。
							
							
								continuationToken
									- 一个 ResultContinuation 对象，表示上一个列表操作返回的继续标记。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							

							Returns:
							一个 ResultSegment<T> 对象，该对象包含表示文件和目录的 ListFileItem 对象的可枚举集合的段。

						Throws:
							
									StorageException

							
				
			
			
				openRead
				
						public final FileInputStream openRead()


						打开文件输入流以下载文件。 
使用 setStreamMinimumReadSizeInBytes(final int minimumReadSize) 配置读取大小。





							Returns:
							一个 InputStream 对象，表示要用于从文件中读取的流。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
				
			
			
				openRead
				
						public final FileInputStream openRead(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						打开文件输入流，以使用指定的请求选项和操作上下文下载文件。 
使用 setStreamMinimumReadSizeInBytes(final int minimumReadSize) 配置读取大小。




						Parameters:
							
								accessCondition
									- 一个表示文件访问条件的 AccessCondition 对象。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							

							Returns:
							一个 InputStream 对象，表示要用于从文件读取的流。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
				
			
			
				openWriteExisting
				
						public FileOutputStream openWriteExisting()


						打开输出流对象以将数据写入文件。 该文件必须已存在，并且任何现有数据都可能被覆盖。





							Returns:
							FileOutputStream用于将数据写入文件的对象。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				openWriteExisting
				
						public FileOutputStream openWriteExisting(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						使用指定的请求选项和操作上下文打开输出流对象以将数据写入文件。 该文件必须已存在，并且任何现有数据都可能被覆盖。




						Parameters:
							
								accessCondition
									- 一个 AccessCondition 对象，表示文件的访问条件。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							

							Returns:
							FileOutputStream用于将数据写入文件的对象。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				openWriteNew
				
						public FileOutputStream openWriteNew(final long length)


						打开输出流对象以将数据写入文件。 该文件尚不存在，将使用指定的长度创建。 如果服务上已存在该文件，则会覆盖该文件。 
若要避免覆盖并引发错误，请将重载与相应的 AccessCondition结合使用openWriteNew(final long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)。




						Parameters:
							
								length
									- 一个 long ，它表示要创建的流的长度（以字节为单位）。
							

							Returns:
							FileOutputStream用于将数据写入文件的对象。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				openWriteNew
				
						public FileOutputStream openWriteNew(final long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						使用指定的租约 ID、请求选项和操作上下文打开输出流对象以将数据写入文件。 该文件尚不需要存在，将使用指定的长度创建。 如果服务上已存在该文件，则会覆盖该文件。 
若要避免覆盖并引发错误，请使用 传入 AccessCondition 生成的 generateIfNotExistsCondition()。




						Parameters:
							
								length
									- 一个 long ，它表示要创建的流的长度（以字节为单位）。
							
							
								accessCondition
									- 一个 AccessCondition 对象，表示文件的访问条件。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							

							Returns:
							FileOutputStream用于将数据写入文件的对象。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				putRangeFromURL
				
						public void putRangeFromURL(final long destOffset, final long length, final URI sourceUri, final long sourceOffset)


						将范围从一个文件上传到另一个文件。




						Parameters:
							
								destOffset
									- 一个 long ，它表示开始写入数据的偏移量（字节数）。
							
							
								length
									- ， long 它表示要写入和读取的数据的长度（以字节为单位）。
							
							
								sourceUri
									- 一个 java.net.URI 指定源 URI 的 对象。
							
							
								sourceOffset
									- 一个 long ，它表示开始读取数据的偏移量（字节数）。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				putRangeFromURL
				
						public void putRangeFromURL(final long destOffset, final long length, final URI sourceUri, final long sourceOffset, FileRequestOptions options, OperationContext opContext)


						使用指定的租约 ID、请求选项和操作上下文将范围从一个文件上传到另一个文件




						Parameters:
							
								destOffset
									- 一个 long ，它表示开始写入数据的偏移量（字节数）。
							
							
								length
									- ， long 它表示要写入和读取的数据的长度（以字节为单位）。
							
							
								sourceUri
									- 一个 java.net.URI 指定源 URI 的 对象。
							
							
								sourceOffset
									- 一个 long ，它表示开始读取数据的偏移量（字节数）。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				resize
				
						public void resize(long size)


						将文件大小调整为指定大小。




						Parameters:
							
								size
									- 一个 long ，它表示文件的大小（以字节为单位）。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				resize
				
						public void resize(long size, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						将文件大小调整为指定大小。




						Parameters:
							
								size
									- 一个 long ，它表示文件的大小（以字节为单位）。
							
							
								accessCondition
									- 一个 AccessCondition 对象，表示文件的访问条件。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				setFilePermission
				
						public void setFilePermission(String filePermission)


						设置要设置的文件权限



						Parameters:
							
								filePermission
									- 一个 String ，表示要设置的文件的文件权限。
							


				
			
			
				setMetadata
				
						public final void setMetadata(final HashMap metadata)


						设置文件的元数据。




						Parameters:
							
								metadata
									- 一个 java.util.HashMap 对象，其中包含要分配给文件的元数据。
							


				
			
			
				setProperties
				
						protected final void setProperties(final FileProperties properties)


						设置文件的属性。




						Parameters:
							
								properties
									- 一个 FileProperties 对象，表示要分配给文件的属性。
							


				
			
			
				setShare
				
						protected final void setShare(final CloudFileShare share)


						设置文件的共享。




						Parameters:
							
								share
									- 一个 CloudFileShare 对象，表示要分配给文件的共享。
							


				
			
			
				setStorageUri
				
						protected void setStorageUri(final StorageUri storageUri)


						设置所有位置的 URI 列表。




						Parameters:
							
								storageUri
									- 一个 StorageUri ，它表示所有位置的 URI 列表。
							


				
			
			
				setStreamMinimumReadSizeInBytes
				
						public void setStreamMinimumReadSizeInBytes(final int minimumReadSize)


						设置使用 FileInputStream时的最小读取大小。




						Parameters:
							
								minimumReadSize
									- 一个 int ，表示在使用 对象时从文件读取时要缓冲的 FileInputStream 最小字节数。 必须大于或等于 16 KB。
							


						Throws:
							
									IllegalArgumentException

									- 如果 minimumReadSize 小于 16 KB。
							
				
			
			
				setStreamWriteSizeInBytes
				
						public void setStreamWriteSizeInBytes(final int streamWriteSizeInBytes)


						设置写入 时 FileOutputStream要缓冲的字节数。




						Parameters:
							
								streamWriteSizeInBytes
									- 一个 int ，表示使用 FileOutputStream 对象时要缓冲的字节数，范围从 512 字节到 4 MB（含）。
							


						Throws:
							
									IllegalArgumentException

									- 如果 streamWriteSizeInBytes 小于 512 字节或大于 4 MB。
							
				
			
			
				startCopy
				
						public final String startCopy(final CloudBlob sourceBlob)


						请求服务开始将 Blob 的内容、属性和元数据复制到新文件。




						Parameters:
							
								sourceBlob
									- 一个 CloudBlob 对象，表示要复制的源 Blob。
							

							Returns:
							， String 它表示与复制操作关联的复制 ID。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				startCopy
				
						public final String startCopy(final CloudBlob sourceBlob, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, FileRequestOptions options, OperationContext opContext)


						请求服务使用指定的访问条件、租约 ID、请求选项和操作上下文开始将文件的内容、属性和元数据复制到新文件。




						Parameters:
							
								sourceBlob
									- 一个 CloudBlob 对象，表示要复制的源 Blob。
							
							
								sourceAccessCondition
									- 一个 AccessCondition 对象，表示源 Blob 的访问条件。
							
							
								destinationAccessCondition
									- 一个 AccessCondition 对象，表示目标文件的访问条件。
							
							
								options
									- 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							

							Returns:
							， String 它表示与复制操作关联的复制 ID。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				startCopy
				
						public final String startCopy(final CloudFile sourceFile)


						请求服务开始将 Azure 文件的内容、属性和元数据复制到新的 Azure 文件。




						Parameters:
							
								sourceFile
									- 一个 CloudFile 对象，表示要复制的源 Azure 文件。
							

							Returns:
							一个 String ，表示与复制操作关联的复制 ID。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				startCopy
				
						public final String startCopy(final CloudFile sourceFile, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, FileRequestOptions options, OperationContext opContext)


						请求服务使用指定的访问条件、租约 ID、请求选项和操作上下文开始将 Azure 文件的内容、属性和元数据复制到新的 Azure 文件。




						Parameters:
							
								sourceFile
									- 一个 CloudFile 表示要复制的源文件的 对象。
							
							
								sourceAccessCondition
									- 一个 AccessCondition 对象，表示源的访问条件。
							
							
								destinationAccessCondition
									- 一个 AccessCondition 对象，表示目标的访问条件。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 (CloudFileClient) 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							

							Returns:
							一个 String ，表示与复制操作关联的复制 ID。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				startCopy
				
						public final String startCopy(final URI source)


						请求服务开始将 URI 的内容、属性和元数据复制到新的 Azure 文件。




						Parameters:
							
								source
									- 源的 java.net.URI。
							

							Returns:
							一个 String ，表示与复制操作关联的复制 ID。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				startCopy
				
						public final String startCopy(final URI source, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, FileRequestOptions options, OperationContext opContext)


						请求服务使用指定的访问条件、租约 ID、请求选项和操作上下文开始将 URI 的内容、属性和元数据复制到新的 Azure 文件。




						Parameters:
							
								source
									- 源的 java.net.URI。
							
							
								sourceAccessCondition
									- 一个 AccessCondition 对象，表示源的访问条件。
							
							
								destinationAccessCondition
									- 一个 AccessCondition 对象，表示目标的访问条件。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 (CloudFileClient) 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							

							Returns:
							一个 String ，表示与复制操作关联的复制 ID。

						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				updateEtagAndLastModifiedFromResponse
				
						protected void updateEtagAndLastModifiedFromResponse(HttpURLConnection request)




						Parameters:
							
								request
							


				
			
			
				updateLengthFromResponse
				
						protected void updateLengthFromResponse(HttpURLConnection request)




						Parameters:
							
								request
							


				
			
			
				upload
				
						public void upload(final InputStream sourceStream, final long length)


						将源流数据上传到文件。 如果服务上已存在该文件，则会覆盖该文件。




						Parameters:
							
								sourceStream
									- 要 InputStream 从中读取的对象。
							
							
								length
									- ， long 它表示流数据的长度（以字节为单位）。 必须为非零。
							


						Throws:
							
									IOException

									- 如果发生 I/O 异常。
							
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				upload
				
						public void upload(final InputStream sourceStream, final long length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						使用指定的访问条件、请求选项和操作上下文将源流数据上传到文件。 如果服务上已存在该文件，则会覆盖该文件。




						Parameters:
							
								sourceStream
									- 要 InputStream 从中读取的对象。
							
							
								length
									- ， long 它表示流数据的长度（以字节为单位）。 这必须大于或等于零。
							
							
								accessCondition
									- 一个 AccessCondition 对象，表示文件的访问条件。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							


						Throws:
							
									IOException

									- 如果发生 I/O 异常。
							
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				uploadFromByteArray
				
						public void uploadFromByteArray(final byte[] buffer, final int offset, final int length)


						从字节数组中的数据上传文件。 如果服务上已存在该文件，则会覆盖该文件。




						Parameters:
							
								buffer
									- 表示 byte 要写入文件的数据的数组。
							
							
								offset
									- 一个 ， int 它表示从中开始上传数据的字节数组的偏移量。
							
							
								length
									- 一个 int ，表示要从输入缓冲区上传的字节数。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									IOException

							
							
									URISyntaxException

							
				
			
			
				uploadFromByteArray
				
						public void uploadFromByteArray(final byte[] buffer, final int offset, final int length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						从字节数组中的数据上传文件。 如果服务上已存在该文件，则会覆盖该文件。




						Parameters:
							
								buffer
									- 表示 byte 要写入文件的数据的数组。
							
							
								offset
									- 一个 ， int 它表示从中开始上传数据的字节数组的偏移量。
							
							
								length
									- 一个 int ，表示要从输入缓冲区上传的字节数。
							
							
								accessCondition
									- 一个表示文件访问条件的 AccessCondition 对象。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									IOException

							
							
									URISyntaxException

							
				
			
			
				uploadFromFile
				
						public void uploadFromFile(final String path)


						上传本地文件。 如果服务上已存在该文件，则会覆盖该文件。




						Parameters:
							
								path
									- ， String 它表示要上传的文件的路径。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									IOException

							
							
									URISyntaxException

							
				
			
			
				uploadFromFile
				
						public void uploadFromFile(final String path, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						从本地文件上传文件。 如果服务上已存在该文件，则会覆盖该文件。




						Parameters:
							
								path
									- ， String 它表示要上传的文件的路径。
							
							
								accessCondition
									- 一个表示文件访问条件的 AccessCondition 对象。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									IOException

							
							
									URISyntaxException

							
				
			
			
				uploadMetadata
				
						public final void uploadMetadata()


						将文件的元数据上传到存储服务。 
使用 downloadAttributes() 从 Microsoft Azure 存储服务检索文件属性和元数据的最新值。






						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				uploadMetadata
				
						public final void uploadMetadata(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						使用访问条件、请求选项和操作上下文将文件的元数据上传到存储服务。 
使用 downloadAttributes() 从 Microsoft Azure 存储服务检索文件属性和元数据的最新值。




						Parameters:
							
								accessCondition
									- 一个表示文件访问条件的 AccessCondition 对象。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。
							
							
								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 对象。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudFileClient) 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				uploadRange
				
						public void uploadRange(final InputStream sourceStream, final long offset, final long length)


						将范围上传到文件。




						Parameters:
							
								sourceStream
									- 一个 InputStream 对象，表示要写入文件的输入流。
							
							
								offset
									- 一个 long ，它表示开始写入数据的偏移量（字节数）。
							
							
								length
									- ， long 它表示要写入的数据的长度（以字节为单位）。
							


						Throws:
							
									IOException

									- 如果发生 I/O 异常。
							
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				uploadRange
				
						public void uploadRange(final InputStream sourceStream, final long offset, final long length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						使用指定的租约 ID、请求选项和操作上下文将范围上传到文件。




						Parameters:
							
								sourceStream
									- 一个 InputStream 对象，表示要写入文件的输入流。
							
							
								offset
									- 一个 long ，它表示开始写入数据的偏移量（字节数）。
							
							
								length
									- ， long 它表示要写入的数据的长度（以字节为单位）。
							
							
								accessCondition
									- 一个 AccessCondition 对象，表示文件的访问条件。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							


						Throws:
							
									IOException

									- 如果发生 I/O 异常。
							
							
									StorageException

									- 如果发生存储服务错误。
							
							
									URISyntaxException

							
				
			
			
				uploadText
				
						public void uploadText(final String content)


						使用平台的默认编码从字符串上传文件。 如果服务上已存在该文件，则会覆盖该文件。




						Parameters:
							
								content
									- 一个 String ，它表示将上传到文件的内容。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									IOException

							
							
									URISyntaxException

							
				
			
			
				uploadText
				
						public void uploadText(final String content, final String charsetName, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)


						使用指定的编码从字符串上传文件。 如果服务上已存在该文件，则会覆盖该文件。




						Parameters:
							
								content
									- 一个 String ，它表示将上传到文件的内容。
							
							
								charsetName
									- 一个 String ，表示用于对内容进行编码的字符集的名称。 如果为 null，则使用平台的默认编码。
							
							
								accessCondition
									- 一个表示文件访问条件的 AccessCondition 对象。
							
							
								options
									- 一个 FileRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudFileClient 的默认请求选项。
							
							
								opContext
									- 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。
							


						Throws:
							
									StorageException

									- 如果发生存储服务错误。
							
							
									IOException

							
							
									URISyntaxException

							
				
			

	适用于