com.github.dockerjava.api.model.Bind Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docker-java Show documentation
Java API Client for Docker
There is a newer version: 3.4.1
package com.github.dockerjava.api.model;



import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

/**
 * Represents a host path being bind mounted as a {@link Volume}
 * in a Docker container.
 * The Bind can be in read only or read write access mode.
 */
public class Bind {

	private String path;

	private Volume volume;

	private AccessMode accessMode;

	public Bind(String path, Volume volume) {
		this(path, volume, AccessMode.DEFAULT);
	}

	public Bind(String path, Volume volume, AccessMode accessMode) {
		this.path = path;
		this.volume = volume;
		this.accessMode = accessMode;
	}

	public String getPath() {
		return path;
	}

	public Volume getVolume() {
		return volume;
	}
	
	public AccessMode getAccessMode() {
		return accessMode;
	}


	/**
	 * Parses a bind mount specification to a {@link Bind}.
	 * 
	 * @param serialized the specification, e.g. /host:/container:ro
	 * @return a {@link Bind} matching the specification
	 * @throws IllegalArgumentException if the specification cannot be parsed
	 */
	public static Bind parse(String serialized) {
		try {
			String[] parts = serialized.split(":");
			switch (parts.length) {
			case 2: {
				return new Bind(parts[0], Volume.parse(parts[1]));
			}
			case 3: {
				AccessMode accessMode = AccessMode.valueOf(parts[2].toLowerCase());
				return new Bind(parts[0], Volume.parse(parts[1]), accessMode);
			}
			default: {
				throw new IllegalArgumentException();
			}
			}
		} catch (Exception e) {
			throw new IllegalArgumentException("Error parsing Bind '" + serialized
					+ "'");
		}
	}

	@Override
	public boolean equals(Object obj) {
		if (obj instanceof Bind) {
			Bind other = (Bind) obj;
			return new EqualsBuilder().append(path, other.getPath())
					.append(volume, other.getVolume())
					.append(accessMode, other.getAccessMode()).isEquals();
		} else
			return super.equals(obj);
	}

	@Override
	public int hashCode() {
		return new HashCodeBuilder().append(path).append(volume)
				.append(accessMode).toHashCode();
	}

	/**
	 * Returns a string representation of this {@link Bind} suitable
	 * for inclusion in a JSON message.
	 * The format is <host path>:<container path>:<access mode>,
	 * like the argument in {@link #parse(String)}.
	 * 
	 * @return a string representation of this {@link Bind}
	 */
	@Override
	public String toString() {
		return path + ":" + volume.toString() + ":" + accessMode.toString();
	}

}