PathUtility (Microsoft Azure Storage Client SDK 2.2.0 API)

java.lang.Object
- com.microsoft.azure.storage.core.PathUtility

```
public final class PathUtility
extends Object
```
RESERVED FOR INTERNAL USE. A class to help modify paths

Method Summary

Methods
Modifier and Type	Method and Description
`static StorageUri`	`addToQuery(StorageUri resourceURI, String queryString)` Adds a queryString to an URI.
`static URI`	`addToQuery(URI resourceURI, String queryString)` Adds a queryString to an URI.
`static URI`	`addToSingleUriQuery(URI resourceURI, HashMap<String,String[]> fieldCollection)` Adds a queryString to an URI.
`static URI`	`appendPathToSingleUri(URI uri, String relativeOrAbsoluteUri)` Appends a path to a URI correctly using "/" as separator.
`static URI`	`appendPathToSingleUri(URI uri, String relativeUri, String separator)` Appends a path to a URI correctly using the given separator.
`static StorageUri`	`appendPathToUri(StorageUri uriList, String relativeOrAbsoluteUri)` Appends a path to a list of URIs correctly using "/" as separator.
`static StorageUri`	`appendPathToUri(StorageUri uriList, String relativeOrAbsoluteUri, String separator)` Appends a path to a list of URIs correctly using "/" as separator.
`static String`	`getBlobNameFromURI(URI inURI, boolean usePathStyleUris)` Gets the blob name from the URI.
`static String`	`getCanonicalPathFromCredentials(StorageCredentials credentials, String absolutePath)` Gets the canonical path for an object from the credentials.
`static String`	`getContainerNameFromUri(URI resourceAddress, boolean usePathStyleUris)` Get the container name from address from the URI.
`static StorageUri`	`getContainerURI(StorageUri blobAddress, boolean usePathStyleUris)` Gets the container URI from a blob address
`static String`	`getFileNameFromURI(URI inURI, boolean usePathStyleUris)` Gets the file name from the URI.
`static String`	`getQueueNameFromUri(URI resourceAddress, boolean usePathStyleUris)` Get the queue name from address from the URI.
`static StorageUri`	`getServiceClientBaseAddress(StorageUri addressUri, boolean usePathStyleUris)` Get the service client address from a complete Uri.
`static String`	`getServiceClientBaseAddress(URI address, boolean usePathStyleUris)` Get the service client address from a complete Uri.
`static String`	`getShareNameFromUri(URI resourceAddress, boolean usePathStyleUris)` Get the share name from address from the URI.
`static StorageUri`	`getShareURI(StorageUri fileAddress, boolean usePathStyleUris)` Gets the share URI from a file address
`static String`	`getTableNameFromUri(URI resourceAddress, boolean usePathStyleUris)` Get the table name from address from the URI.
`static HashMap<String,String[]>`	`parseQueryString(String parseString)` Parses a query string into a one to many hashmap.
`static URI`	`stripSingleURIQueryAndFragment(URI inUri)` Strips the Query and Fragment from the uri.
`static StorageUri`	`stripURIQueryAndFragment(StorageUri inUri)` Strips the Query and Fragment from the uri.

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

- Method Detail
  - addToSingleUriQuery
```
public static URI addToSingleUriQuery(URI resourceURI,
                      HashMap<String,String[]> fieldCollection)
                               throws URISyntaxException,
                                      StorageException
```
    Adds a queryString to an URI.
    
    Parameters:
    resourceURI - the URI of the resource
    fieldCollection - the key/ values collection to append.
    
    Returns:
    an appended URI.
    
    Throws:
    
    URISyntaxException - if the resulting URI is invalid.
    
    StorageException
  - addToQuery
```
public static StorageUri addToQuery(StorageUri resourceURI,
                    String queryString)
                             throws URISyntaxException,
                                    StorageException
```
    Adds a queryString to an URI.
    
    Parameters:
    resourceURI - the URI of the resource
    queryString - the query string to add
    
    Returns:
    an appended URI.
    
    Throws:
    
    URISyntaxException - if the resulting URI is invalid.
    
    StorageException
  - addToQuery
```
public static URI addToQuery(URI resourceURI,
             String queryString)
                      throws URISyntaxException,
                             StorageException
```
    Adds a queryString to an URI.
    
    Parameters:
    resourceURI - the URI of the resource
    queryString - the query string to add
    
    Returns:
    an appended URI.
    
    Throws:
    
    URISyntaxException - if the resulting URI is invalid.
    
    StorageException
  - appendPathToUri
```
public static StorageUri appendPathToUri(StorageUri uriList,
                         String relativeOrAbsoluteUri)
                                  throws URISyntaxException
```
    Appends a path to a list of URIs correctly using "/" as separator.
    
    Parameters:
    uriList - The base Uri.
    relativeOrAbslouteUri - The relative or absloute URI.
    
    Returns:
    The appended Uri.
    
    Throws:
    
    URISyntaxException
  - appendPathToUri
```
public static StorageUri appendPathToUri(StorageUri uriList,
                         String relativeOrAbsoluteUri,
                         String separator)
                                  throws URISyntaxException
```
    Appends a path to a list of URIs correctly using "/" as separator.
    
    Parameters:
    uriList - The base Uri.
    relativeOrAbslouteUri - The relative or absloute URI.
    
    Returns:
    The appended Uri.
    
    Throws:
    
    URISyntaxException
  - appendPathToSingleUri
```
public static URI appendPathToSingleUri(URI uri,
                        String relativeOrAbsoluteUri)
                                 throws URISyntaxException
```
    Appends a path to a URI correctly using "/" as separator.
    
    Parameters:
    uriList - The base Uri.
    relativeOrAbslouteUri - The relative or absloute URI.
    
    Returns:
    The appended Uri.
    
    Throws:
    
    URISyntaxException
  - appendPathToSingleUri
```
public static URI appendPathToSingleUri(URI uri,
                        String relativeUri,
                        String separator)
                                 throws URISyntaxException
```
    Appends a path to a URI correctly using the given separator.
    
    Parameters:
    uri - The base Uri.
    relativeUri - The relative URI.
    separator - the separator to use.
    
    Returns:
    The appended Uri.
    
    Throws:
    
    URISyntaxException - a valid Uri cannot be constructed
  - getBlobNameFromURI
```
public static String getBlobNameFromURI(URI inURI,
                        boolean usePathStyleUris)
                                 throws URISyntaxException
```
    Gets the blob name from the URI.
    
    Parameters:
    inURI - the resource address
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    the blobs name
    
    Throws:
    
    URISyntaxException
  - getCanonicalPathFromCredentials
```
public static String getCanonicalPathFromCredentials(StorageCredentials credentials,
                                     String absolutePath)
```
    Gets the canonical path for an object from the credentials.
    
    Parameters:
    credentials - the credentials to use.
    absolutePath - the Absolute path of the object.
    
    Returns:
    the canonical path for an object from the credentials
  - getContainerNameFromUri
```
public static String getContainerNameFromUri(URI resourceAddress,
                             boolean usePathStyleUris)
```
    Get the container name from address from the URI.
    
    Parameters:
    resourceAddress - The container Uri.
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    container name from address from the URI.
    
    Throws:
    
    IllegalArgumentException
  - getFileNameFromURI
```
public static String getFileNameFromURI(URI inURI,
                        boolean usePathStyleUris)
```
    Gets the file name from the URI.
    
    Parameters:
    inURI - the resource address
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    the file's name
  - getShareNameFromUri
```
public static String getShareNameFromUri(URI resourceAddress,
                         boolean usePathStyleUris)
```
    Get the share name from address from the URI.
    
    Parameters:
    resourceAddress - The share Uri.
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    share name from address from the URI.
    
    Throws:
    
    IllegalArgumentException
  - getTableNameFromUri
```
public static String getTableNameFromUri(URI resourceAddress,
                         boolean usePathStyleUris)
```
    Get the table name from address from the URI.
    
    Parameters:
    resourceAddress - The table Uri.
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    table name from address from the URI.
    
    Throws:
    
    IllegalArgumentException
  - getContainerURI
```
public static StorageUri getContainerURI(StorageUri blobAddress,
                         boolean usePathStyleUris)
                                  throws URISyntaxException
```
    Gets the container URI from a blob address
    
    Parameters:
    blobAddress - the blob address
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    the container URI from a blob address
    
    Throws:
    
    URISyntaxException
  - getShareURI
```
public static StorageUri getShareURI(StorageUri fileAddress,
                     boolean usePathStyleUris)
                              throws URISyntaxException
```
    Gets the share URI from a file address
    
    Parameters:
    fileAddress - the file address
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    the share URI from a file address
    
    Throws:
    
    URISyntaxException
  - getQueueNameFromUri
```
public static String getQueueNameFromUri(URI resourceAddress,
                         boolean usePathStyleUris)
```
    Get the queue name from address from the URI.
    
    Parameters:
    resourceAddress - The queue Uri.
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    container name from address from the URI.
    
    Throws:
    
    IllegalArgumentException
  - getServiceClientBaseAddress
```
public static String getServiceClientBaseAddress(URI address,
                                 boolean usePathStyleUris)
                                          throws URISyntaxException
```
    Get the service client address from a complete Uri.
    
    Parameters:
    address - Complete address of the resource.
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    the service client address from a complete Uri.
    
    Throws:
    
    URISyntaxException
  - getServiceClientBaseAddress
```
public static StorageUri getServiceClientBaseAddress(StorageUri addressUri,
                                     boolean usePathStyleUris)
                                              throws URISyntaxException
```
    Get the service client address from a complete Uri.
    
    Parameters:
    address - Complete address of the resource.
    usePathStyleUris - a value indicating if the address is a path style uri.
    
    Returns:
    the service client address from a complete Uri.
    
    Throws:
    
    URISyntaxException
  - parseQueryString
```
public static HashMap<String,String[]> parseQueryString(String parseString)
                                                 throws StorageException
```
    Parses a query string into a one to many hashmap.
    
    Parameters:
    parseString - the string to parse
    
    Returns:
    a HashMap of the key values.
    
    Throws:
    
    StorageException
  - stripSingleURIQueryAndFragment
```
public static URI stripSingleURIQueryAndFragment(URI inUri)
                                          throws StorageException
```
    Strips the Query and Fragment from the uri.
    
    Parameters:
    inUri - the uri to alter
    
    Returns:
    the stripped uri.
    
    Throws:
    
    StorageException
  - stripURIQueryAndFragment
```
public static StorageUri stripURIQueryAndFragment(StorageUri inUri)
                                           throws StorageException
```
    Strips the Query and Fragment from the uri.
    
    Parameters:
    inUri - the uri to alter
    
    Returns:
    the stripped uri.
    
    Throws:
    
    StorageException

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addToSingleUriQuery

addToQuery

addToQuery

appendPathToUri

appendPathToUri

appendPathToSingleUri

appendPathToSingleUri

getBlobNameFromURI

getCanonicalPathFromCredentials

getContainerNameFromUri

getFileNameFromURI

getShareNameFromUri

getTableNameFromUri

getContainerURI

getShareURI

getQueueNameFromUri

getServiceClientBaseAddress

getServiceClientBaseAddress

parseQueryString

stripSingleURIQueryAndFragment

stripURIQueryAndFragment