Apache
/
jclouds
mirror of https://github.com/apache/jclouds.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

openstack-glance: documenting multiple vararg usage

This commit is contained in:
Adam Lowe 2012-05-31 14:19:51 +01:00
parent 7de87a1238
commit fe53765de0
3 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
labs/openstack-glance/src/main/java/org/jclouds/openstack/glance/v1_0/options/CreateImageOptions.java
View File

@ -23,6 +23,18 @@ import org.jclouds.openstack.glance.v1_0.domain.DiskFormat;
import org.jclouds.openstack.glance.v1_0.domain.StoreType;
/**
*
* <h2></h2>Usage</h2> The recommended way to instantiate a CreateImageOptions object is to statically import
* CreateImageOptions.Builder.* and invoke a static creation method for each option as needed:
* <p/>
* <code>
* import static org.jclouds.openstack.glance.v1_0.options.CreateImageOptions.Builder.*
*
*
* // this will create an image with the name "imageName", minimum required disk of 10GB, etc.
* details = client.create("imageName", minDisk(10), isPublic(true), property("mykey", "somevalue"));
* <code>
* @author Adam Lowe
* @see <a href="http://glance.openstack.org/glanceapi.html"/>
*/

11
labs/openstack-glance/src/main/java/org/jclouds/openstack/glance/v1_0/options/ListImageOptions.java
View File

@ -28,6 +28,17 @@ import org.jclouds.openstack.glance.v1_0.domain.Image.Status;
import org.jclouds.openstack.options.BaseListOptions;
/**
* <h2></h2>Usage</h2> The recommended way to instantiate a ListImageOptions object is to statically import
* ListImageOptions.Builder.* and invoke a static creation method for each option as needed:
* <p/>
* <code>
* import static org.jclouds.openstack.glance.v1_0.options.ListImageOptions.Builder.*
*
*
* // this will list the first 10 images with the name "name", minimum required disk of 5GB.
* list = client.list(name("newName"), maxResults(10), minDisk(5));
* <code>
*
* @author Adam Lowe
* @see <a href="http://glance.openstack.org/glanceapi.html"/>
*/

10
labs/openstack-glance/src/main/java/org/jclouds/openstack/glance/v1_0/options/UpdateImageOptions.java
View File

@ -26,6 +26,16 @@ import org.jclouds.openstack.glance.v1_0.domain.DiskFormat;
import org.jclouds.openstack.glance.v1_0.domain.StoreType;
/**
* <h2></h2>Usage</h2> The recommended way to instantiate a UpdateImageOptions object is to statically import
* UpdateImageOptions.Builder.* and invoke a static creation method for each option as needed:
* <p/>
* <code>
* import static org.jclouds.openstack.glance.v1_0.options.UpdateImageOptions.Builder.*
*
*
* // this will adjust the image with id 'id' the name "newName", minimum required disk of 5GB, etc.
* details = client.update(id, name("newName"), minDisk(5), isPublic(true), property("mykey", "somevalue"));
* <code>
* @author Adam Lowe
* @see <a href="http://glance.openstack.org/glanceapi.html"/>
*/