CloudFile (Microsoft Azure Storage Client SDK 2.2.0 API)

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

All Implemented Interfaces:

ListFileItem
```
public class CloudFile
extends Object
implements ListFileItem
```
Represents a Microsoft Azure File.

Field Summary

Fields
Modifier and Type	Field and Description
`protected CloudFileClient`	`fileServiceClient` Represents the file service client.
`protected CloudFileDirectory`	`parent` Represents the file's directory reference.
`protected int`	`streamMinimumReadSizeInBytes` Holds the minimum read size when using a `FileInputStream`.
`protected int`	`streamWriteSizeInBytes` Holds the number of bytes to buffer when writing to a `FileOutputStream`.

Constructor Summary

Constructors
Constructor and Description
`CloudFile(CloudFile otherFile)` Creates an instance of the `CloudFile` class by copying values from another cloud file.
`CloudFile(StorageUri fileAbsoluteUri, CloudFileClient client)` Creates an instance of the `CloudFile` class using the specified URI and storage service client.
`CloudFile(StorageUri fileAbsoluteUri, CloudFileClient client, CloudFileShare share)` Creates an instance of the `CloudFile` class using the specified absolute StorageUri, storage service client and share.
`CloudFile(URI fileAbsoluteUri, CloudFileClient client)` Creates an instance of the `CloudFile` class using the specified absolute URI and storage service client.
`CloudFile(URI fileAbsoluteUri, CloudFileClient client, CloudFileShare share)` Creates an instance of the `CloudFile` class using the specified absolute URI, storage service client and share.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearRange(long offset, long length)` Clears a range from a file.
`void`	`clearRange(long offset, long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Clears a range from a file using the specified lease ID, request options, and operation context.
`void`	`create(long size)` Creates a file.
`void`	`create(long size, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Creates a file using the specified access condition, request options and operation context.
`void`	`delete()` Deletes the file.
`void`	`delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Deletes the file using the specified access condition, request options, and operation context.
`boolean`	`deleteIfExists()` Deletes the file if it exists.
`boolean`	`deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Deletes the file if it exists, using the specified access condition, request options, and operation context.
`void`	`download(OutputStream outStream)` Downloads the contents of a file to a stream.
`void`	`download(OutputStream outStream, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Downloads the contents of a file to a stream using the specified request options and operation context.
`void`	`downloadAttributes()` Populates a file's properties and metadata.
`void`	`downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Populates a file's properties and metadata using the specified request options and operation context.
`ArrayList<FileRange>`	`downloadFileRanges()` Returns a collection of file ranges and their starting and ending byte offsets.
`ArrayList<FileRange>`	`downloadFileRanges(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Returns a collection of file ranges and their starting and ending byte offsets using the specified request options and operation context.
`void`	`downloadRange(long offset, Long length, OutputStream outStream)` Downloads the contents of a file to a stream.
`void`	`downloadRange(long offset, Long length, OutputStream outStream, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Downloads the contents of a file to a stream using the specified request options and operation context.
`protected int`	`downloadRangeInternal(long fileOffset, Long length, byte[] buffer, int bufferOffset, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Downloads a range of bytes from the file to the given byte buffer.
`int`	`downloadRangeToByteArray(long offset, Long length, byte[] buffer, int bufferOffet)` Downloads a range of bytes from the file to the given byte buffer.
`int`	`downloadRangeToByteArray(long offset, Long length, byte[] buffer, int bufferOffset, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Downloads a range of bytes from the file to the given byte buffer, using the specified request options and operation context.
`String`	`downloadText()` Downloads a file to a string using the platform's default encoding.
`String`	`downloadText(String charsetName, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Downloads a file to a string using the specified encoding.
`int`	`downloadToByteArray(byte[] buffer, int bufferOffet)` Downloads a range of bytes from the file to the given byte buffer.
`int`	`downloadToByteArray(byte[] buffer, int bufferOffset, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Downloads a range of bytes from the file to the given byte buffer, using the specified request options and operation context.
`void`	`downloadToFile(String path)` Downloads a file.
`void`	`downloadToFile(String path, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Downloads a file.
`boolean`	`exists()` Checks to see if the file exists.
`boolean`	`exists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Checks to see if the file exists, using the specified access condition, request options and operation context.
`HashMap<String,String>`	`getMetadata()` Returns the metadata for the file.
`String`	`getName()` Returns the name of the file.
`CloudFileDirectory`	`getParent()` Returns the file item's parent.
`protected static String`	`getParentNameFromURI(StorageUri resourceAddress, CloudFileShare share)` Retrieves the parent name for a file URI.
`FileProperties`	`getProperties()` Returns the file's properties.
`CloudFileClient`	`getServiceClient()` Returns the File service client associated with the file.
`CloudFileShare`	`getShare()` Returns the file's share.
`StorageUri`	`getStorageUri()` Returns the list of URIs for all locations.
`int`	`getStreamMinimumReadSizeInBytes()` Returns the minimum read size when using a `FileInputStream`.
`int`	`getStreamWriteSizeInBytes()` Gets the number of bytes to buffer when writing to a `FileOutputStream`.
`protected StorageUri`	`getTransformedAddress(OperationContext opContext)` Returns the transformed URI for the resource if the given credentials require transformation.
`URI`	`getUri()` Returns the URI for this file.
`FileInputStream`	`openRead()` Opens a file input stream to download the file.
`FileInputStream`	`openRead(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Opens a file input stream to download the file using the specified request options and operation context.
`FileOutputStream`	`openWriteExisting()` Opens an output stream object to write data to the file.
`FileOutputStream`	`openWriteExisting(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Opens an output stream object to write data to the file, using specified request options and operation context.
`FileOutputStream`	`openWriteNew(long length)` Opens an output stream object to write data to the file.
`FileOutputStream`	`openWriteNew(long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Opens an output stream object to write data to the file, using the specified lease ID, request options and operation context.
`void`	`resize(long size)` Resizes the file to the specified size.
`void`	`resize(long size, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Resizes the file to the specified size.
`void`	`setMetadata(HashMap<String,String> metadata)` Sets the metadata for the file.
`protected void`	`setProperties(FileProperties properties)` Sets the properties for the file.
`protected void`	`setShare(CloudFileShare share)` Sets the share for the file.
`protected void`	`setStorageUri(StorageUri storageUri)` Sets the list of URIs for all locations.
`void`	`setStreamMinimumReadSizeInBytes(int minimumReadSize)` Sets the minimum read size when using a `FileInputStream`.
`void`	`setStreamWriteSizeInBytes(int streamWriteSizeInBytes)` Sets the number of bytes to buffer when writing to a `FileOutoutStream`.
`protected void`	`updateEtagAndLastModifiedFromResponse(HttpURLConnection request)`
`protected void`	`updateLengthFromResponse(HttpURLConnection request)`
`void`	`upload(InputStream sourceStream, long length)` Uploads the source stream data to the file.
`void`	`upload(InputStream sourceStream, long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Uploads the source stream data to the file using the specified access condition, request options, and operation context.
`void`	`uploadFromByteArray(byte[] buffer, int offset, int length)` Uploads a file from data in a byte array.
`void`	`uploadFromByteArray(byte[] buffer, int offset, int length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Uploads a file from data in a byte array.
`void`	`uploadFromFile(String path)` Uploads a file.
`void`	`uploadFromFile(String path, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Uploads a file from a file.
`void`	`uploadMetadata()` Uploads the file's metadata to the storage service.
`void`	`uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Uploads the file's metadata to the storage service using the access condition, request options, and operation context.
`void`	`uploadProperties()` Updates the file's properties to the storage service.
`void`	`uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Updates the file's properties using the access condition, request options, and operation context.
`void`	`uploadRange(InputStream sourceStream, long offset, long length)` Uploads a range to a file.
`void`	`uploadRange(InputStream sourceStream, long offset, long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Uploads a range to a file using the specified lease ID, request options, and operation context.
`void`	`uploadText(String content)` Uploads a file from a string using the platform's default encoding.
`void`	`uploadText(String content, String charsetName, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Uploads a file from a string using the specified encoding.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - streamWriteSizeInBytes
```
protected int streamWriteSizeInBytes
```
    Holds the number of bytes to buffer when writing to a FileOutputStream.
  - streamMinimumReadSizeInBytes
```
protected int streamMinimumReadSizeInBytes
```
    Holds the minimum read size when using a FileInputStream.
  - parent
```
protected CloudFileDirectory parent
```
    Represents the file's directory reference.
  - fileServiceClient
```
protected CloudFileClient fileServiceClient
```
    Represents the file service client.
- Constructor Detail
  - CloudFile
```
public CloudFile(URI fileAbsoluteUri,
         CloudFileClient client)
          throws StorageException,
                 URISyntaxException
```
    Creates an instance of the CloudFile class using the specified absolute URI and storage service client.
    
    Parameters:
    fileAbsoluteUri - A java.net.URI object that represents the absolute URI to the file.
    client - A CloudFileClient object that specifies the endpoint for the File service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException
  - CloudFile
```
public CloudFile(StorageUri fileAbsoluteUri,
         CloudFileClient client)
          throws StorageException,
                 URISyntaxException
```
    Creates an instance of the CloudFile class using the specified URI and storage service client.
    
    Parameters:
    fileAbsoluteUri - A StorageUri object that represents the absolute URI to the file.
    client - A CloudFileClient object that specifies the endpoint for the File service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException
  - CloudFile
```
public CloudFile(URI fileAbsoluteUri,
         CloudFileClient client,
         CloudFileShare share)
          throws StorageException,
                 URISyntaxException
```
    Creates an instance of the CloudFile class using the specified absolute URI, storage service client and share.
    
    Parameters:
    fileAbsoluteUri - A java.net.URI object that represents the absolute URI to the file.
    client - A CloudFileClient object that specifies the endpoint for the File service.
    share - A CloudFileShare object that represents the share to use for the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException
  - CloudFile
```
public CloudFile(StorageUri fileAbsoluteUri,
         CloudFileClient client,
         CloudFileShare share)
          throws StorageException,
                 URISyntaxException
```
    Creates an instance of the CloudFile class using the specified absolute StorageUri, storage service client and share.
    
    Parameters:
    fileAbsoluteUri - A StorageUri object that represents the absolute URI to the file.
    client - A CloudFileClient object that specifies the endpoint for the File service.
    share - A CloudFileShare object that represents the share to use for the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException
  - CloudFile
```
public CloudFile(CloudFile otherFile)
```
    Creates an instance of the CloudFile class by copying values from another cloud file.
    
    Parameters:
    otherFile - A CloudFile object that represents the file to copy.
- Method Detail
  - clearRange
```
@DoesServiceRequest
public void clearRange(long offset,
                                 long length)
                throws StorageException
```
    Clears a range from a file.
    Calling clearRange releases the storage space used by the specified range. Ranges that have been cleared are no longer tracked as part of the file.
    
    Parameters:
    offset - The offset, in bytes, at which to begin clearing.
    length - The length, in bytes, of the data range to be cleared.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - clearRange
```
@DoesServiceRequest
public void clearRange(long offset,
                                 long length,
                                 AccessCondition accessCondition,
                                 FileRequestOptions options,
                                 OperationContext opContext)
                throws StorageException
```
    Clears a range from a file using the specified lease ID, request options, and operation context.
    Calling clearRange releases the storage space used by the specified range. Ranges that have been cleared are no longer tracked as part of the file.
    
    Parameters:
    offset - A long which represents the offset, in bytes, at which to begin clearing.
    length - A long which represents the length, in bytes, of the data range to be cleared.
    accessCondition - An AccessCondition object which represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - create
```
@DoesServiceRequest
public void create(long size)
            throws StorageException
```
    Creates a file.
    
    Parameters:
    size - A long which represents the size, in bytes, of the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - create
```
@DoesServiceRequest
public void create(long size,
                             AccessCondition accessCondition,
                             FileRequestOptions options,
                             OperationContext opContext)
            throws StorageException
```
    Creates a file using the specified access condition, request options and operation context.
    
    Parameters:
    size - A long which represents the size, in bytes, of the file.
    accessCondition - An AccessCondition object which represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - delete
```
@DoesServiceRequest
public final void delete()
                  throws StorageException
```
    Deletes the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - delete
```
@DoesServiceRequest
public final void delete(AccessCondition accessCondition,
                             FileRequestOptions options,
                             OperationContext opContext)
                  throws StorageException
```
    Deletes the file using the specified access condition, request options, and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - deleteIfExists
```
@DoesServiceRequest
public final boolean deleteIfExists()
                             throws StorageException
```
    Deletes the file if it exists.
    
    Returns:
    true if the file was deleted; otherwise, false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - deleteIfExists
```
@DoesServiceRequest
public final boolean deleteIfExists(AccessCondition accessCondition,
                                        FileRequestOptions options,
                                        OperationContext opContext)
                             throws StorageException
```
    Deletes the file if it exists, using the specified access condition, request options, and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    true if the file existed and was deleted; otherwise, false
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - download
```
@DoesServiceRequest
public final void download(OutputStream outStream)
                    throws StorageException
```
    Downloads the contents of a file to a stream.
    
    Parameters:
    outStream - An OutputStream object that represents the target stream.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - download
```
@DoesServiceRequest
public final void download(OutputStream outStream,
                               AccessCondition accessCondition,
                               FileRequestOptions options,
                               OperationContext opContext)
                    throws StorageException
```
    Downloads the contents of a file to a stream using the specified request options and operation context.
    
    Parameters:
    outStream - An OutputStream object that represents the target stream.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadRange
```
@DoesServiceRequest
public final void downloadRange(long offset,
                                    Long length,
                                    OutputStream outStream)
                         throws StorageException
```
    Downloads the contents of a file to a stream.
    
    Parameters:
    offset - A long which represents the offset to use as the starting point for the source.
    length - A Long which represents the number of bytes to read or null.
    outStream - An OutputStream object that represents the target stream.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadRange
```
@DoesServiceRequest
public final void downloadRange(long offset,
                                    Long length,
                                    OutputStream outStream,
                                    AccessCondition accessCondition,
                                    FileRequestOptions options,
                                    OperationContext opContext)
                         throws StorageException
```
    Downloads the contents of a file to a stream using the specified request options and operation context.
    
    Parameters:
    offset - A long which represents the offset to use as the starting point for the source.
    length - A Long which represents the number of bytes to read or null.
    outStream - An OutputStream object that represents the target stream.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadRangeInternal
```
@DoesServiceRequest
protected final int downloadRangeInternal(long fileOffset,
                                           Long length,
                                           byte[] buffer,
                                           int bufferOffset,
                                           AccessCondition accessCondition,
                                           FileRequestOptions options,
                                           OperationContext opContext)
                                   throws StorageException
```
    Downloads a range of bytes from the file to the given byte buffer.
    
    Parameters:
    fileOffset - A long which represents the offset within the file to begin downloading.
    length - A Long which represents the number of bytes to read.
    buffer - A byte array which represents the buffer to write to.
    bufferOffset - An int which represents the offset in the byte buffer to begin writing.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request.
    opContext - An OperationContext object used to track the execution of the operation.
    
    Throws:
    
    StorageException - an exception representing any error which occurred during the operation.
  - downloadRangeToByteArray
```
@DoesServiceRequest
public final int downloadRangeToByteArray(long offset,
                                              Long length,
                                              byte[] buffer,
                                              int bufferOffet)
                                   throws StorageException
```
    Downloads a range of bytes from the file to the given byte buffer.
    
    Parameters:
    offset - A long which represents the byte offset to use as the starting point for the source.
    length - A Long which represents the number of bytes to read or null.
    buffer - A byte array which represents the buffer to which the file bytes are downloaded.
    bufferOffet - An int which represents the byte offset to use as the starting point for the target.
    
    Throws:
    
    StorageException
  - downloadRangeToByteArray
```
@DoesServiceRequest
public final int downloadRangeToByteArray(long offset,
                                              Long length,
                                              byte[] buffer,
                                              int bufferOffset,
                                              AccessCondition accessCondition,
                                              FileRequestOptions options,
                                              OperationContext opContext)
                                   throws StorageException
```
    Downloads a range of bytes from the file to the given byte buffer, using the specified request options and operation context.
    
    Parameters:
    offset - A long which represents the byte offset to use as the starting point for the source.
    length - A Long which represents the number of bytes to read or null.
    buffer - A byte array which represents the buffer to which the file bytes are downloaded.
    bufferOffset - An int which represents the byte offset to use as the starting point for the target.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadToByteArray
```
@DoesServiceRequest
public final int downloadToByteArray(byte[] buffer,
                                         int bufferOffet)
                              throws StorageException
```
    Downloads a range of bytes from the file to the given byte buffer.
    
    Parameters:
    buffer - A byte array which represents the buffer to which the file bytes are downloaded.
    bufferOffet - An int which represents the byte offset to use as the starting point for the target.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadToByteArray
```
@DoesServiceRequest
public final int downloadToByteArray(byte[] buffer,
                                         int bufferOffset,
                                         AccessCondition accessCondition,
                                         FileRequestOptions options,
                                         OperationContext opContext)
                              throws StorageException
```
    Downloads a range of bytes from the file to the given byte buffer, using the specified request options and operation context.
    
    Parameters:
    buffer - A byte array which represents the buffer to which the file bytes are downloaded.
    bufferOffet - A long which represents the byte offset to use as the starting point for the target.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadToFile
```
public void downloadToFile(String path)
                    throws StorageException,
                           IOException
```
    Downloads a file.
    
    Parameters:
    path - A String which represents the path to the file that will be created.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - downloadToFile
```
public void downloadToFile(String path,
                  AccessCondition accessCondition,
                  FileRequestOptions options,
                  OperationContext opContext)
                    throws StorageException,
                           IOException
```
    Downloads a file.
    
    Parameters:
    path - A String which represents the path to the file that will be created.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - downloadText
```
public String downloadText()
                    throws StorageException,
                           IOException
```
    Downloads a file to a string using the platform's default encoding.
    
    Returns:
    A String which represents the file's contents.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - downloadText
```
public String downloadText(String charsetName,
                  AccessCondition accessCondition,
                  FileRequestOptions options,
                  OperationContext opContext)
                    throws StorageException,
                           IOException
```
    Downloads a file to a string using the specified encoding.
    
    Parameters:
    charsetName - A String which represents the name of the charset to use to encode the content. If null, the platform's default encoding is used.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    A String which represents the file's contents.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - downloadFileRanges
```
@DoesServiceRequest
public ArrayList<FileRange> downloadFileRanges()
                                        throws StorageException
```
    Returns a collection of file ranges and their starting and ending byte offsets.
    The start and end byte offsets for each file range are inclusive.
    
    Returns:
    An ArrayList object which represents the set of file ranges and their starting and ending byte offsets.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadFileRanges
```
@DoesServiceRequest
public ArrayList<FileRange> downloadFileRanges(AccessCondition accessCondition,
                                                         FileRequestOptions options,
                                                         OperationContext opContext)
                                        throws StorageException
```
    Returns a collection of file ranges and their starting and ending byte offsets using the specified request options and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object which represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    An ArrayList object which represents the set of file ranges and their starting and ending byte offsets.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadAttributes
```
@DoesServiceRequest
public final void downloadAttributes()
                              throws StorageException
```
    Populates a file's properties and metadata.
    This method populates the file's system properties and user-defined metadata. Before reading or modifying a file's properties or metadata, call this method or its overload to retrieve the latest values for the file's properties and metadata from the Microsoft Azure storage service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadAttributes
```
@DoesServiceRequest
public final void downloadAttributes(AccessCondition accessCondition,
                                         FileRequestOptions options,
                                         OperationContext opContext)
                              throws StorageException
```
    Populates a file's properties and metadata using the specified request options and operation context.
    This method populates the file's system properties and user-defined metadata. Before reading or modifying a file's properties or metadata, call this method or its overload to retrieve the latest values for the file's properties and metadata from the Microsoft Azure storage service.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - exists
```
@DoesServiceRequest
public final boolean exists()
                     throws StorageException
```
    Checks to see if the file exists.
    
    Returns:
    true if the file exists, otherwise false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - exists
```
@DoesServiceRequest
public final boolean exists(AccessCondition accessCondition,
                                FileRequestOptions options,
                                OperationContext opContext)
                     throws StorageException
```
    Checks to see if the file exists, using the specified access condition, request options and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    true if the file exists, otherwise false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openRead
```
@DoesServiceRequest
public final FileInputStream openRead()
                               throws StorageException
```
    Opens a file input stream to download the file.
    Use CloudFileClient#setStreamMinimumReadSizeInBytes to configure the read size.
    
    Returns:
    An InputStream object that represents the stream to use for reading from the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openRead
```
@DoesServiceRequest
public final FileInputStream openRead(AccessCondition accessCondition,
                                          FileRequestOptions options,
                                          OperationContext opContext)
                               throws StorageException
```
    Opens a file input stream to download the file using the specified request options and operation context.
    Use CloudFileClient#setStreamMinimumReadSizeInBytes to configure the read size.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    An InputStream object that represents the stream to use for reading from the File.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openWriteExisting
```
@DoesServiceRequest
public FileOutputStream openWriteExisting()
                                   throws StorageException
```
    Opens an output stream object to write data to the file. The file must already exist.
    
    Returns:
    A FileOutputStream object used to write data to the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openWriteExisting
```
@DoesServiceRequest
public FileOutputStream openWriteExisting(AccessCondition accessCondition,
                                                    FileRequestOptions options,
                                                    OperationContext opContext)
                                   throws StorageException
```
    Opens an output stream object to write data to the file, using specified request options and operation context. The file must already exist.
    
    Parameters:
    accessCondition - An AccessCondition object which represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    A FileOutputStream object used to write data to the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openWriteNew
```
@DoesServiceRequest
public FileOutputStream openWriteNew(long length)
                              throws StorageException
```
    Opens an output stream object to write data to the file. The file does not yet exist and will be created with the length specified.
    
    Parameters:
    length - A long which represents the length, in bytes, of the stream to create.
    
    Returns:
    A FileOutputStream object used to write data to the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - openWriteNew
```
@DoesServiceRequest
public FileOutputStream openWriteNew(long length,
                                               AccessCondition accessCondition,
                                               FileRequestOptions options,
                                               OperationContext opContext)
                              throws StorageException
```
    Opens an output stream object to write data to the file, using the specified lease ID, request options and operation context. The file does not need to yet exist and will be created with the length specified.
    
    Parameters:
    length - A long which represents the length, in bytes, of the stream to create.
    accessCondition - An AccessCondition object which represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    A FileOutputStream object used to write data to the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - uploadFromByteArray
```
public void uploadFromByteArray(byte[] buffer,
                       int offset,
                       int length)
                         throws StorageException,
                                IOException
```
    Uploads a file from data in a byte array.
    
    Parameters:
    buffer - A byte array which represents the data to write to the file.
    offset - A int which represents the offset of the byte array from which to start the data upload.
    length - An int which represents the number of bytes to upload from the input buffer.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - uploadFromByteArray
```
public void uploadFromByteArray(byte[] buffer,
                       int offset,
                       int length,
                       AccessCondition accessCondition,
                       FileRequestOptions options,
                       OperationContext opContext)
                         throws StorageException,
                                IOException
```
    Uploads a file from data in a byte array.
    
    Parameters:
    buffer - A byte array which represents the data to write to the file.
    offset - A int which represents the offset of the byte array from which to start the data upload.
    length - An int which represents the number of bytes to upload from the input buffer.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - uploadFromFile
```
public void uploadFromFile(String path)
                    throws StorageException,
                           IOException
```
    Uploads a file.
    
    Parameters:
    path - A String which represents the path to the file to be uploaded.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - uploadFromFile
```
public void uploadFromFile(String path,
                  AccessCondition accessCondition,
                  FileRequestOptions options,
                  OperationContext opContext)
                    throws StorageException,
                           IOException
```
    Uploads a file from a file.
    
    Parameters:
    path - A String which represents the path to the file to be uploaded.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - uploadText
```
public void uploadText(String content)
                throws StorageException,
                       IOException
```
    Uploads a file from a string using the platform's default encoding.
    
    Parameters:
    content - A String which represents the content that will be uploaded to the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - uploadText
```
public void uploadText(String content,
              String charsetName,
              AccessCondition accessCondition,
              FileRequestOptions options,
              OperationContext opContext)
                throws StorageException,
                       IOException
```
    Uploads a file from a string using the specified encoding.
    
    Parameters:
    content - A String which represents the content that will be uploaded to the file.
    charsetName - A String which represents the name of the charset to use to encode the content. If null, the platform's default encoding is used.
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    IOException
  - uploadRange
```
@DoesServiceRequest
public void uploadRange(InputStream sourceStream,
                                  long offset,
                                  long length)
                 throws StorageException,
                        IOException
```
    Uploads a range to a file.
    
    Parameters:
    sourceStream - An IntputStream object which represents the input stream to write to the file.
    offset - A long which represents the offset, in number of bytes, at which to begin writing the data.
    length - A long which represents the length, in bytes, of the data to write.
    
    Throws:
    
    IOException - If an I/O exception occurred.
    
    StorageException - If a storage service error occurred.
  - uploadRange
```
@DoesServiceRequest
public void uploadRange(InputStream sourceStream,
                                  long offset,
                                  long length,
                                  AccessCondition accessCondition,
                                  FileRequestOptions options,
                                  OperationContext opContext)
                 throws StorageException,
                        IOException
```
    Uploads a range to a file using the specified lease ID, request options, and operation context.
    
    Parameters:
    sourceStream - An IntputStream object which represents the input stream to write to the file.
    offset - A long which represents the offset, in number of bytes, at which to begin writing the data.
    length - A long which represents the length, in bytes, of the data to write.
    accessCondition - An AccessCondition object which represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    IOException - If an I/O exception occurred.
    
    StorageException - If a storage service error occurred.
  - uploadMetadata
```
@DoesServiceRequest
public final void uploadMetadata()
                          throws StorageException
```
    Uploads the file's metadata to the storage service.
    Use downloadAttributes() to retrieve the latest values for the file's properties and metadata from the Microsoft Azure storage service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - uploadMetadata
```
@DoesServiceRequest
public final void uploadMetadata(AccessCondition accessCondition,
                                     FileRequestOptions options,
                                     OperationContext opContext)
                          throws StorageException
```
    Uploads the file's metadata to the storage service using the access condition, request options, and operation context.
    Use downloadAttributes() to retrieve the latest values for the file's properties and metadata from the Microsoft Azure storage service.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - uploadProperties
```
@DoesServiceRequest
public final void uploadProperties()
                            throws StorageException
```
    Updates the file's properties to the storage service.
    Use downloadAttributes() to retrieve the latest values for the file's properties and metadata from the Microsoft Azure storage service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - uploadProperties
```
@DoesServiceRequest
public final void uploadProperties(AccessCondition accessCondition,
                                       FileRequestOptions options,
                                       OperationContext opContext)
                            throws StorageException
```
    Updates the file's properties using the access condition, request options, and operation context.
    Use downloadAttributes() to retrieve the latest values for the file's properties and metadata from the Microsoft Azure storage service.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - resize
```
public void resize(long size)
            throws StorageException
```
    Resizes the file to the specified size.
    
    Parameters:
    size - A long which represents the size of the file, in bytes.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - resize
```
public void resize(long size,
          AccessCondition accessCondition,
          FileRequestOptions options,
          OperationContext opContext)
            throws StorageException
```
    Resizes the file to the specified size.
    
    Parameters:
    size - A long which represents the size of the file, in bytes.
    accessCondition - An AccessCondition object which represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - upload
```
@DoesServiceRequest
public void upload(InputStream sourceStream,
                             long length)
            throws StorageException,
                   IOException
```
    Uploads the source stream data to the file.
    
    Parameters:
    sourceStream - An IntputStream object to read from.
    length - A long which represents the length, in bytes, of the stream data. Must be non zero.
    
    Throws:
    
    IOException - If an I/O exception occurred.
    
    StorageException - If a storage service error occurred.
  - upload
```
@DoesServiceRequest
public void upload(InputStream sourceStream,
                             long length,
                             AccessCondition accessCondition,
                             FileRequestOptions options,
                             OperationContext opContext)
            throws StorageException,
                   IOException
```
    Uploads the source stream data to the file using the specified access condition, request options, and operation context.
    
    Parameters:
    sourceStream - An IntputStream object to read from.
    length - A long which represents the length, in bytes, of the stream data. This must be great than zero.
    accessCondition - An AccessCondition object which represents the access conditions for the file.
    options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
    opContext - An OperationContext object which represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    IOException - If an I/O exception occurred.
    
    StorageException - If a storage service error occurred.
  - getParentNameFromURI
```
protected static String getParentNameFromURI(StorageUri resourceAddress,
                          CloudFileShare share)
                                      throws URISyntaxException
```
    Retrieves the parent name for a file URI.
    
    Parameters:
    resourceAddress - A StorageUri object which represents the resource URI.
    delimiter - A String which specifies the directory delimiter to use.
    usePathStyleUris - A Boolean which specifies whether path style URIs are used.
    share - A CloudFileShare object which represents the file share.
    
    Returns:
    A String which represents the parent address for a file URI.
    
    Throws:
    
    URISyntaxException
  - updateEtagAndLastModifiedFromResponse
```
protected void updateEtagAndLastModifiedFromResponse(HttpURLConnection request)
```
  - updateLengthFromResponse
```
protected void updateLengthFromResponse(HttpURLConnection request)
```
  - getShare
```
public final CloudFileShare getShare()
                              throws StorageException,
                                     URISyntaxException
```
    Returns the file's share.
    
    Specified by:
    
    getShare in interface ListFileItem
    
    Returns:
    A CloudFileShare object that represents the share of the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - getMetadata
```
public final HashMap<String,String> getMetadata()
```
    Returns the metadata for the file.
    
    Returns:
    A java.util.HashMap object that represents the metadata for the file.
  - getName
```
public final String getName()
```
    Returns the name of the file.
    
    Returns:
    A String that represents the name of the file.
  - getParent
```
public final CloudFileDirectory getParent()
                                   throws URISyntaxException,
                                          StorageException
```
    Returns the file item's parent.
    
    Specified by:
    
    getParent in interface ListFileItem
    
    Returns:
    A CloudFileDirectory object that represents the parent directory for the file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - getProperties
```
public final FileProperties getProperties()
```
    Returns the file's properties.
    
    Returns:
    A FileProperties object that represents the properties of the file.
  - getServiceClient
```
public final CloudFileClient getServiceClient()
```
    Returns the File service client associated with the file.
    
    Returns:
    A CloudFileClient object that represents the client.
  - getStreamWriteSizeInBytes
```
public final int getStreamWriteSizeInBytes()
```
    Gets the number of bytes to buffer when writing to a FileOutputStream.
    
    Returns:
    A int which represents the number of bytes to buffer.
  - getStreamMinimumReadSizeInBytes
```
public final int getStreamMinimumReadSizeInBytes()
```
    Returns the minimum read size when using a FileInputStream.
    
    Returns:
    A int which represents the minimum read size, in bytes, when using a FileInputStream object.
  - getStorageUri
```
public final StorageUri getStorageUri()
```
    Returns the list of URIs for all locations.
    
    Specified by:
    
    getStorageUri in interface ListFileItem
    
    Returns:
    A StorageUri that represents the list of URIs for all locations.
  - getUri
```
public final URI getUri()
```
    Returns the URI for this file.
    
    Specified by:
    
    getUri in interface ListFileItem
    
    Returns:
    A java.net.URI object that represents the URI for the file.
  - setShare
```
protected final void setShare(CloudFileShare share)
```
    Sets the share for the file.
    
    Parameters:
    share - A CloudFileShare object that represents the share being assigned to the file.
  - setMetadata
```
public final void setMetadata(HashMap<String,String> metadata)
```
    Sets the metadata for the file.
    
    Parameters:
    metadata - A java.util.HashMap object that contains the metadata being assigned to the file.
  - setProperties
```
protected final void setProperties(FileProperties properties)
```
    Sets the properties for the file.
    
    Parameters:
    properties - A FileProperties object that represents the properties being assigned to the file.
  - setStorageUri
```
protected void setStorageUri(StorageUri storageUri)
```
    Sets the list of URIs for all locations.
    
    Parameters:
    storageUri - A StorageUri that represents the list of URIs for all locations.
  - setStreamMinimumReadSizeInBytes
```
public void setStreamMinimumReadSizeInBytes(int minimumReadSize)
```
    Sets the minimum read size when using a FileInputStream.
    
    Parameters:
    minimumReadSize - An int that represents the minimum number of bytes to buffer when reading from a file while using a FileInputStream object. Must be greater than or equal to 16 KB.
    
    Throws:
    
    IllegalArgumentException - If minimumReadSize is less than 16 KB.
  - setStreamWriteSizeInBytes
```
public void setStreamWriteSizeInBytes(int streamWriteSizeInBytes)
```
    Sets the number of bytes to buffer when writing to a FileOutoutStream.
    
    Parameters:
    streamWriteSizeInBytes - An int which represents the number of bytes to buffer while using a FileOutputStream object, ranging from 512 bytes to 4 MB, inclusive.
    
    Throws:
    
    IllegalArgumentException - If streamWriteSizeInBytes is less than 512 bytes or greater than 4 MB.
  - getTransformedAddress
```
protected final StorageUri getTransformedAddress(OperationContext opContext)
                                          throws URISyntaxException,
                                                 StorageException
```
    Returns the transformed URI for the resource if the given credentials require transformation.
    
    Parameters:
    opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    A StorageUri object that represents the transformed URI.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class CloudFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

streamWriteSizeInBytes

streamMinimumReadSizeInBytes

parent

fileServiceClient

Constructor Detail

CloudFile

CloudFile

CloudFile

CloudFile

CloudFile

Method Detail

clearRange

clearRange

create

create

delete

delete

deleteIfExists

deleteIfExists

download

download

downloadRange

downloadRange

downloadRangeInternal

downloadRangeToByteArray

downloadRangeToByteArray

downloadToByteArray

downloadToByteArray

downloadToFile

downloadToFile

downloadText

downloadText

downloadFileRanges

downloadFileRanges

downloadAttributes

downloadAttributes

exists

exists

openRead

openRead

openWriteExisting

openWriteExisting

openWriteNew

openWriteNew

uploadFromByteArray

uploadFromByteArray

uploadFromFile

uploadFromFile

uploadText

uploadText

uploadRange

uploadRange

uploadMetadata

uploadMetadata

uploadProperties

uploadProperties

resize

resize

upload

upload

getParentNameFromURI

updateEtagAndLastModifiedFromResponse

updateLengthFromResponse

getShare

getMetadata

getName

getParent

getProperties

getServiceClient

getStreamWriteSizeInBytes

getStreamMinimumReadSizeInBytes

getStorageUri

getUri

setShare