ContainerApi (Apache jclouds 1.7.3 API)

```
public interface ContainerApi
```
Provides access to the OpenStack Object Storage (Swift) Container API features.
This API is new to jclouds and hence is in Beta. That means we need people to use it and give us feedback. Based on that feedback, minor changes to the interfaces may happen. This code will replace org.jclouds.openstack.swift.SwiftClient in jclouds 2.0 and it is recommended you adopt it sooner than later.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`create(String containerName)` Creates a container, if not already present.
`boolean`	`create(String containerName, CreateContainerOptions options)` Creates a container, if not already present.
`boolean`	`createIfAbsent(String containerName, CreateContainerOptions options)` Deprecated. Please use either `create(String)` or `create(String, CreateContainerOptions)` as this method will be removed in jclouds 1.8.
`boolean`	`deleteIfEmpty(String containerName)` Deletes a `Container`, if empty.
`boolean`	`deleteMetadata(String containerName, Map<String,String> metadata)` Deletes `Container` metadata.
`Container`	`get(String containerName)` Gets the `Container`.
`Container`	`head(String containerName)` Deprecated. Please use `get(String)` as this method will be removed in jclouds 1.8.
`com.google.common.collect.FluentIterable<Container>`	`list()` Lists up to 10,000 containers.
`com.google.common.collect.FluentIterable<Container>`	`list(ListContainerOptions options)` Lists containers with the supplied `ListContainerOptions`.
`boolean`	`update(String containerName, UpdateContainerOptions options)` Updates the `Container`.
`boolean`	`updateMetadata(String containerName, Map<String,String> metadata)` Creates or updates the `Container` metadata.

- Method Detail
  - list
```
@Named(value="container:list")
com.google.common.collect.FluentIterable<Container> list()
```
    Lists up to 10,000 containers.
    NOTE
    This method returns a list of Container objects without metadata. To retrieve the Container metadata, use the get(String) method.
    
    Returns:
    a list of containers ordered by name.
  - list
```
@Named(value="container:list")
com.google.common.collect.FluentIterable<Container> list(ListContainerOptions options)
```
    Lists containers with the supplied ListContainerOptions.
    NOTE
    This method returns a list of Container objects without metadata. To retrieve the Container metadata, use the get(String) method.
    
    Parameters:
    options - the options to control the output list.
    
    Returns:
    a list of containers ordered by name.
  - create
```
@Named(value="container:create")
boolean create(String containerName)
```
    Creates a container, if not already present.
    
    Parameters:
    containerName - corresponds to Container.getName().
    
    Returns:
    true if the container was created, false if the container already existed.
  - create
```
@Named(value="container:create")
boolean create(String containerName,
                   CreateContainerOptions options)
```
    Creates a container, if not already present.
    
    Parameters:
    containerName - corresponds to Container.getName().
    options - the options to use when creating the container.
    
    Returns:
    true if the container was created, false if the container already existed.
  - get
```
@Named(value="container:get")
@Nullable
Container get(String containerName)
```
    Gets the Container.
    
    Parameters:
    containerName - corresponds to Container.getName().
    
    Returns:
    the Container, or null if not found.
  - update
```
@Named(value="container:update")
boolean update(String containerName,
                   UpdateContainerOptions options)
```
    Updates the Container.
    
    Parameters:
    containerName - the container name corresponding to Container.getName().
    options - the container options to update.
    
    Returns:
    true if the container metadata was successfully created or updated, false if not.
  - updateMetadata
```
@Named(value="container:updateMetadata")
boolean updateMetadata(String containerName,
                           Map<String,String> metadata)
```
    Creates or updates the Container metadata.
    
    Parameters:
    containerName - the container name corresponding to Container.getName().
    metadata - the container metadata to create or update.
    
    Returns:
    true if the container metadata was successfully created or updated, false if not.
  - deleteMetadata
```
@Named(value="container:deleteMetadata")
boolean deleteMetadata(String containerName,
                           Map<String,String> metadata)
```
    Deletes Container metadata.
    
    Parameters:
    containerName - corresponds to Container.getName().
    metadata - the container metadata to delete.
    
    Returns:
    true if the container metadata was successfully deleted, false if not.
  - deleteIfEmpty
```
@Named(value="container:deleteIfEmpty")
boolean deleteIfEmpty(String containerName)
                      throws IllegalStateException
```
    Deletes a Container, if empty.
    
    Parameters:
    containerName - corresponds to Container.getName().
    
    Returns:
    false if the container was not present.
    
    Throws:
    
    IllegalStateException - if the container was not empty.
  - createIfAbsent
```
@Deprecated
@Named(value="container:createIfAbsent")
boolean createIfAbsent(String containerName,
                                      CreateContainerOptions options)
```
    Deprecated. Please use either create(String) or create(String, CreateContainerOptions) as this method will be removed in jclouds 1.8.
    
    Creates a container, if not already present.
    
    Parameters:
    containerName - corresponds to Container.getName().
    options - the options to use when creating the container.
    
    Returns:
    true if the container was created, false if the container already existed.
  - head
```
@Deprecated
@Named(value="container:get")
@Nullable
Container head(String containerName)
```
    Deprecated. Please use get(String) as this method will be removed in jclouds 1.8.
    
    Gets the Container metadata, including the number of objects in the container and the total bytes for all objects stored in the container.
    
    Parameters:
    containerName - corresponds to Container.getName().
    
    Returns:
    the Container, or null if not found.

Interface ContainerApi

Method Summary

Method Detail

list

NOTE

list

NOTE

create

create

get

update

updateMetadata

deleteMetadata

deleteIfEmpty

createIfAbsent

head