CloudFileDirectory (Microsoft Azure Storage Client SDK 2.2.0 API)

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

All Implemented Interfaces:

ListFileItem
```
public final class CloudFileDirectory
extends Object
implements ListFileItem
```
Represents a virtual directory of files.
Directories, which are encapsulated as CloudFileDirectories objects, hold files and can also contain sub-directories.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CloudFileDirectory(StorageUri directoryAbsoluteUri, CloudFileClient client)` Creates an instance of the `CloudFileDirectory` class using an absolute URI to the directory.
`protected`	`CloudFileDirectory(StorageUri uri, String directoryName, CloudFileShare share)` Creates an instance of the `CloudFileDirectory` class using the specified address, share, and client.
	`CloudFileDirectory(URI directoryAbsoluteUri, CloudFileClient client)` Creates an instance of the `CloudFileDirectory` class using an absolute URI to the directory.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`create()` Creates the directory.
`void`	`create(FileRequestOptions options, OperationContext opContext)` Creates the directory using the specified options and operation context.
`boolean`	`createIfNotExists()` Creates the directory if it does not exist.
`boolean`	`createIfNotExists(FileRequestOptions options, OperationContext opContext)` Creates the directory if it does not exist, using the specified request options and operation context.
`void`	`delete()` Deletes the directory.
`void`	`delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Deletes the directory using the specified request options and operation context.
`boolean`	`deleteIfExists()` Deletes the directory if it exists.
`boolean`	`deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Deletes the directory if it exists using the specified request options and operation context.
`void`	`downloadAttributes()` Downloads the directory's properties.
`void`	`downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Downloads the directory's properties using the specified request options and operation context.
`boolean`	`exists()` Returns a value that indicates whether the directory exists.
`boolean`	`exists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)` Returns a value that indicates whether the directory exists, using the specified request options and operation context.
`CloudFileDirectory`	`getDirectoryReference(String itemName)` Returns a reference to a `CloudFileDirectory` object that represents a directory in this directory.
`CloudFile`	`getFileReference(String fileName)` Returns a reference to a `CloudFile` object that represents a file in this directory.
`String`	`getName()` Returns the name of this directory.
`CloudFileDirectory`	`getParent()` Returns the `CloudFileDirectory` parent directory associated with this directory.
`FileDirectoryProperties`	`getProperties()` Returns the `FileDirectoryProperties` object that holds the directory's system properties.
`CloudFileClient`	`getServiceClient()` Returns the File service client associated with this directory.
`CloudFileShare`	`getShare()` Returns the share for this directory.
`StorageUri`	`getStorageUri()` Returns the list of URIs for all locations.
`CloudFileDirectory`	`getSubDirectoryReference(String itemName)` Deprecated. as of 2.0.0. Use `#getDirectoryReference()` instead.
`URI`	`getUri()` Returns the URI for this directory.
`Iterable<ListFileItem>`	`listFilesAndDirectories()` Returns an enumerable collection of file and directory items for the directory.
`Iterable<ListFileItem>`	`listFilesAndDirectories(FileRequestOptions options, OperationContext opContext)` Returns an enumerable collection of file and directory items for the directory.
`ResultSegment<ListFileItem>`	`listFilesAndDirectoriesSegmented()` Returns a result segment of an enumerable collection of files and directories for this File service client.
`ResultSegment<ListFileItem>`	`listFilesAndDirectoriesSegmented(Integer maxResults, ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)` Returns a result segment of an enumerable collection of files and directories for this directory, using the specified listing details options, request options, and operation context.
`protected void`	`setProperties(FileDirectoryProperties properties)` Sets the properties for the directory.
`protected void`	`setShare(CloudFileShare share)` Sets the share for the directory.
`protected void`	`setStorageUri(StorageUri storageUri)` Sets the list of URIs for all locations.

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

- Constructor Detail
  - CloudFileDirectory
```
public CloudFileDirectory(URI directoryAbsoluteUri,
                  CloudFileClient client)
                   throws StorageException,
                          URISyntaxException
```
    Creates an instance of the CloudFileDirectory class using an absolute URI to the directory.
    
    Parameters:
    directoryAbsoluteUri - A URI that represents the file directory's address.
    client - A CloudFileClient object that represents the associated service client.
    
    Throws:
    
    StorageException
    
    URISyntaxException
  - CloudFileDirectory
```
public CloudFileDirectory(StorageUri directoryAbsoluteUri,
                  CloudFileClient client)
                   throws StorageException,
                          URISyntaxException
```
    Creates an instance of the CloudFileDirectory class using an absolute URI to the directory.
    
    Parameters:
    directoryAbsoluteUri - A StorageUri that represents the file directory's address.
    client - A CloudFileClient object that represents the associated service client.
    
    Throws:
    
    StorageException
    
    URISyntaxException
  - CloudFileDirectory
```
protected CloudFileDirectory(StorageUri uri,
                  String directoryName,
                  CloudFileShare share)
```
    Creates an instance of the CloudFileDirectory class using the specified address, share, and client.
    
    Parameters:
    uri - A StorageUri that represents the file directory's address.
    directoryName - A String that represents the name of the directory.
    share - A CloudFileShare object that represents the associated file share.
- Method Detail
  - create
```
@DoesServiceRequest
public void create()
            throws StorageException
```
    Creates the directory.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - create
```
@DoesServiceRequest
public void create(FileRequestOptions options,
                             OperationContext opContext)
            throws StorageException
```
    Creates the directory using the specified options and operation context.
    
    Parameters:
    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.
  - createIfNotExists
```
@DoesServiceRequest
public boolean createIfNotExists()
                          throws StorageException
```
    Creates the directory if it does not exist.
    
    Returns:
    true if the directory did not already exist and was created; otherwise, false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - createIfNotExists
```
@DoesServiceRequest
public boolean createIfNotExists(FileRequestOptions options,
                                           OperationContext opContext)
                          throws StorageException
```
    Creates the directory if it does not exist, using the specified request options and operation context.
    
    Parameters:
    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 directory did not already exist and was created; otherwise, false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - delete
```
@DoesServiceRequest
public void delete()
            throws StorageException
```
    Deletes the directory.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - delete
```
@DoesServiceRequest
public void delete(AccessCondition accessCondition,
                             FileRequestOptions options,
                             OperationContext opContext)
            throws StorageException
```
    Deletes the directory using the specified request options and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the directory.
    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 boolean deleteIfExists()
                       throws StorageException
```
    Deletes the directory if it exists.
    
    Returns:
    true if the directory did not already exist and was created; otherwise, false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - deleteIfExists
```
@DoesServiceRequest
public boolean deleteIfExists(AccessCondition accessCondition,
                                        FileRequestOptions options,
                                        OperationContext opContext)
                       throws StorageException
```
    Deletes the directory if it exists using the specified request options and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the directory.
    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 directory existed and was deleted; otherwise, false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - exists
```
@DoesServiceRequest
public boolean exists()
               throws StorageException
```
    Returns a value that indicates whether the directory exists.
    
    Returns:
    true if the directory exists, otherwise false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - exists
```
@DoesServiceRequest
public boolean exists(AccessCondition accessCondition,
                                FileRequestOptions options,
                                OperationContext opContext)
               throws StorageException
```
    Returns a value that indicates whether the directory exists, using the specified request options and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the share.
    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 directory exists, otherwise false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadAttributes
```
@DoesServiceRequest
public void downloadAttributes()
                        throws StorageException
```
    Downloads the directory's properties.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadAttributes
```
@DoesServiceRequest
public void downloadAttributes(AccessCondition accessCondition,
                                         FileRequestOptions options,
                                         OperationContext opContext)
                        throws StorageException
```
    Downloads the directory's properties using the specified request options and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the directory.
    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.
  - listFilesAndDirectories
```
@DoesServiceRequest
public Iterable<ListFileItem> listFilesAndDirectories()
```
    Returns an enumerable collection of file and directory items for the directory.
    
    Returns:
    An enumerable collection of ListFileItem objects that represent the file and directory items in this directory.
  - listFilesAndDirectories
```
@DoesServiceRequest
public Iterable<ListFileItem> listFilesAndDirectories(FileRequestOptions options,
                                                                OperationContext opContext)
```
    Returns an enumerable collection of file and directory items for the directory.
    
    Parameters:
    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 enumerable collection of ListFileItem objects that represent the file and directory items in this directory.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - listFilesAndDirectoriesSegmented
```
@DoesServiceRequest
public ResultSegment<ListFileItem> listFilesAndDirectoriesSegmented()
                                                             throws StorageException
```
    Returns a result segment of an enumerable collection of files and directories for this File service client.
    
    Returns:
    A ResultSegment object that contains a segment of the enumerable collection of ListFileItem objects that represent the files and directories.
    
    Throws:
    
    StorageException
  - listFilesAndDirectoriesSegmented
```
@DoesServiceRequest
public ResultSegment<ListFileItem> listFilesAndDirectoriesSegmented(Integer maxResults,
                                                                              ResultContinuation continuationToken,
                                                                              FileRequestOptions options,
                                                                              OperationContext opContext)
                                                             throws StorageException
```
    Returns a result segment of an enumerable collection of files and directories for this directory, using the specified listing details options, request options, and operation context.
    
    Parameters:
    maxResults - The maximum number of results to retrieve. If null or greater than 5000, the server will return up to 5,000 items. Must be at least 1.
    continuationToken - A ResultContinuation object that represents a continuation token returned by a previous listing operation.
    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 ResultSegment object that contains a segment of the enumerable collection of ListFileItem objects that represent the files and directories in this directory.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - getFileReference
```
public CloudFile getFileReference(String fileName)
                           throws URISyntaxException,
                                  StorageException
```
    Returns a reference to a CloudFile object that represents a file in this directory.
    
    Parameters:
    fileName - A String that represents the name of the file.
    
    Returns:
    A CloudFile object that represents a reference to the specified file.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - getDirectoryReference
```
public CloudFileDirectory getDirectoryReference(String itemName)
                                         throws URISyntaxException,
                                                StorageException
```
    Returns a reference to a CloudFileDirectory object that represents a directory in this directory.
    
    Parameters:
    itemName - A String that represents the name of the directory.
    
    Returns:
    A CloudFileDirectory object that represents a reference to the specified directory.
    
    Throws:
    
    URISyntaxException - If the resource URI is invalid.
    
    StorageException
  - getSubDirectoryReference
```
@Deprecated
public CloudFileDirectory getSubDirectoryReference(String itemName)
                                            throws URISyntaxException,
                                                   StorageException
```
    Deprecated. as of 2.0.0. Use #getDirectoryReference() instead.
    
    Returns a reference to a CloudFileDirectory object that represents a subdirectory in this directory.
    
    Parameters:
    itemName - A String that represents the name of the subdirectory.
    
    Returns:
    A CloudFileDirectory object that represents a reference to the specified directory.
    
    Throws:
    
    URISyntaxException - If the resource URI is invalid.
    
    StorageException
  - getUri
```
public URI getUri()
```
    Returns the URI for this directory.
    
    Specified by:
    
    getUri in interface ListFileItem
    
    Returns:
    A java.net.URI object that represents the URI for this directory.
  - 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.
  - getServiceClient
```
public CloudFileClient getServiceClient()
```
    Returns the File service client associated with this directory.
    
    Returns:
    An CloudFileClient object that represents the service client associated with the directory.
  - getName
```
public String getName()
```
    Returns the name of this directory.
    
    Returns:
    An String that represents the name of the directory.
  - getProperties
```
public FileDirectoryProperties getProperties()
```
    Returns the FileDirectoryProperties object that holds the directory's system properties.
    
    Returns:
    A FileDirectoryProperties object that holds the system properties associated with the directory.
  - getParent
```
public CloudFileDirectory getParent()
                             throws URISyntaxException,
                                    StorageException
```
    Returns the CloudFileDirectory parent directory associated with this directory.
    
    Specified by:
    
    getParent in interface ListFileItem
    
    Returns:
    An CloudFileDirectory object that represents the parent directory associated with the directory.
    
    Throws:
    
    StorageException
    
    URISyntaxException
  - getShare
```
public CloudFileShare getShare()
                        throws StorageException,
                               URISyntaxException
```
    Returns the share for this directory.
    
    Specified by:
    
    getShare in interface ListFileItem
    
    Returns:
    A CloudFileShare that represents the share for this directory.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - setShare
```
protected final void setShare(CloudFileShare share)
```
    Sets the share for the directory.
    
    Parameters:
    share - A CloudFileShare object that represents the share being assigned to the directory.
  - setProperties
```
protected final void setProperties(FileDirectoryProperties properties)
```
    Sets the properties for the directory.
    
    Parameters:
    properties - A FileDirectoryProperties object that represents the properties being assigned to the directory.
  - 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.

/** 
* 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 CloudFileDirectory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CloudFileDirectory

CloudFileDirectory

CloudFileDirectory

Method Detail

create

create

createIfNotExists

createIfNotExists

delete

delete

deleteIfExists

deleteIfExists

exists

exists

downloadAttributes

downloadAttributes

listFilesAndDirectories

listFilesAndDirectories

listFilesAndDirectoriesSegmented

listFilesAndDirectoriesSegmented

getFileReference

getDirectoryReference

getSubDirectoryReference

getUri

getStorageUri

getServiceClient

getName

getProperties

getParent

getShare

setShare

setProperties

setStorageUri