com.github.dockerjava.api.model

Class Volume

java.lang.Object

com.github.dockerjava.api.model.Volume

All Implemented Interfaces:

java.io.Serializable

public class Volume
extends java.lang.Object
implements java.io.Serializable

Represents a bind mounted volume in a Docker container.

Due to an inconsistency in the Docker REST API implementation the response to a container command might include either "Mounts" : [ { "Destination" : "/path/to/mount" } ] or "Mounts" : [ { "Destination" : { "path" : "/path/to/mount" } } ] JSON snippets. However, both variants have to be mapped to this class. Therefore, both a single-argument constructor as well as a single-argument factory method is provided either of which handles the former or latter variant (with path key), respectively.

See Also:

Bind, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Volume(java.lang.String path) Creates a volume referring to the given path.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPath()
static Volume	parse(java.util.Map<java.lang.String,java.lang.String> primitive) Handles the { "Destination" : { "path" : "/path/to/mount" } } variant.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Volume

public Volume(java.lang.String path)

Creates a volume referring to the given path. Handles the { "Destination" : "/path/to/mount" } variant.

Parameters:

path - the destination path of the bind mounted volume

Method Detail

parse

@Nonnull
public static Volume parse(java.util.Map<java.lang.String,java.lang.String> primitive)

Handles the { "Destination" : { "path" : "/path/to/mount" } } variant.

Parameters:

path - the destination path of the bind mounted volume

Returns:

a volume instance referring to the given path.

getPath

public java.lang.String getPath()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object