com.github.dockerjava.api.model

Class Volume

java.lang.Object

com.github.dockerjava.api.model.Volume

All Implemented Interfaces:

Serializable

public class Volume
extends Object
implements 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(String path) Creates a volume referring to the given path.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Volume

public Volume(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
 @Deprecated
public static Volume parse(String path)

Deprecated. use parse(Map)

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.

parse

@Nonnull
public static Volume parse(Map<String,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 String getPath()

toString

public String toString()

Overrides:

toString in class Object