[JCLOUDS-1021] Add JavaDoc to cover behavior of repoTags() method in org.jclouds.docker.domain.Image
Project: http://git-wip-us.apache.org/repos/asf/jclouds/repo Commit: http://git-wip-us.apache.org/repos/asf/jclouds/commit/746038e8 Tree: http://git-wip-us.apache.org/repos/asf/jclouds/tree/746038e8 Diff: http://git-wip-us.apache.org/repos/asf/jclouds/diff/746038e8 Branch: refs/heads/master Commit: 746038e8b29e7e52757bd0b10541274c27327816 Parents: 3260fa5 Author: Josef Cacek <[email protected]> Authored: Wed Oct 21 16:57:42 2015 +0200 Committer: Ignasi Barrera <[email protected]> Committed: Wed Oct 21 17:16:27 2015 +0200 ---------------------------------------------------------------------- .../compute/strategy/DockerComputeServiceAdapter.java | 6 ++++++ .../main/java/org/jclouds/docker/domain/Image.java | 14 ++++++++++++++ .../java/org/jclouds/docker/features/ImageApi.java | 3 +++ 3 files changed, 23 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/jclouds/blob/746038e8/apis/docker/src/main/java/org/jclouds/docker/compute/strategy/DockerComputeServiceAdapter.java ---------------------------------------------------------------------- diff --git a/apis/docker/src/main/java/org/jclouds/docker/compute/strategy/DockerComputeServiceAdapter.java b/apis/docker/src/main/java/org/jclouds/docker/compute/strategy/DockerComputeServiceAdapter.java index b1041d0..6af757f 100644 --- a/apis/docker/src/main/java/org/jclouds/docker/compute/strategy/DockerComputeServiceAdapter.java +++ b/apis/docker/src/main/java/org/jclouds/docker/compute/strategy/DockerComputeServiceAdapter.java @@ -174,6 +174,12 @@ public class DockerComputeServiceAdapter implements return hardware; } + /** + * Method based on {@link org.jclouds.docker.features.ImageApi#listImages()}. It retrieves additional + * information by inspecting each image. + * + * @see org.jclouds.compute.ComputeServiceAdapter#listImages() + */ @Override public Set<Image> listImages() { Set<Image> images = Sets.newHashSet(); http://git-wip-us.apache.org/repos/asf/jclouds/blob/746038e8/apis/docker/src/main/java/org/jclouds/docker/domain/Image.java ---------------------------------------------------------------------- diff --git a/apis/docker/src/main/java/org/jclouds/docker/domain/Image.java b/apis/docker/src/main/java/org/jclouds/docker/domain/Image.java index f49a7b0..a696c5f 100644 --- a/apis/docker/src/main/java/org/jclouds/docker/domain/Image.java +++ b/apis/docker/src/main/java/org/jclouds/docker/domain/Image.java @@ -26,6 +26,9 @@ import org.jclouds.json.SerializedNames; import com.google.auto.value.AutoValue; +/** + * Represents a response from Docker "Inspect an image" call (<code>GET /images/(name)/json</code>). + */ @AutoValue public abstract class Image { @@ -55,6 +58,17 @@ public abstract class Image { public abstract long virtualSize(); + /** + * Tags of the image. The value is <code>null</code> when the instance comes + * from {@link org.jclouds.docker.features.ImageApi#inspectImage(String)}. + * Other methods can populate the content (e.g. + * {@link org.jclouds.docker.compute.strategy.DockerComputeServiceAdapter#listImages()} + * call. + * <p> + * The tags are in form "ubuntu:12.10", "docker.io/busybox:1.23.2", ... + * </p> + * @return list of tags or <code>null</code> + */ @Nullable public abstract List<String> repoTags(); Image() { http://git-wip-us.apache.org/repos/asf/jclouds/blob/746038e8/apis/docker/src/main/java/org/jclouds/docker/features/ImageApi.java ---------------------------------------------------------------------- diff --git a/apis/docker/src/main/java/org/jclouds/docker/features/ImageApi.java b/apis/docker/src/main/java/org/jclouds/docker/features/ImageApi.java index cfca40d..441f1c0 100644 --- a/apis/docker/src/main/java/org/jclouds/docker/features/ImageApi.java +++ b/apis/docker/src/main/java/org/jclouds/docker/features/ImageApi.java @@ -63,6 +63,9 @@ public interface ImageApi { List<ImageSummary> listImages(ListImageOptions options); /** + * Return low-level information on the image with given name. Not all fields from the returned {@link Image} instance + * are populated by this method (e.g. {@link Image#repoTags()}). + * * @param imageName The id of the image to inspect. * @return low-level information on the image name */
