biolockj.util.paths

Interface DockerMountMapper

All Superinterfaces:

PathMapper

All Known Implementing Classes:

BasicDockerMapper, CommonDockerMapper, SimpleDockerMapper

public interface DockerMountMapper
extends PathMapper

Introduced with BioLockJ v1.3.18.

Author:

Ivory Blakley

Method Summary

Modifier and Type	Method and Description
String	asInnerPath(String path) Convert path to inner path form.
String	asOuterPath(String path) Convert path to outer path form.
String	builtForVersion() The BioLockJ version that a class was built for and tested with.
TreeMap<String,String>	getMap() The map at represents the connection of inner path to outer path.
String	version() Changes to a mapper class should be accompanied by a increment in version.

Method Detail

getMap

TreeMap<String,String> getMap()
                       throws DockerVolCreationException

The map at represents the connection of inner path to outer path. Value is the inner path, the path form that can be used inside the docker container. Key is the outer path, the path form that represents the path on the host machine.

Specified by:

getMap in interface PathMapper

Returns:

Throws:

DockerVolCreationException

asInnerPath

String asInnerPath(String path)
            throws DockerVolCreationException

Convert path to inner path form.

Specified by:

asInnerPath in interface PathMapper

Parameters:

path - A path represented as a String, representing the outer path form

Returns:

inner path form

Throws:

DockerVolCreationException

asOuterPath

String asOuterPath(String path)
            throws DockerVolCreationException

Convert path to outer path form.

Specified by:

asOuterPath in interface PathMapper

Parameters:

path - A path represented as a String, representing the inner path form

Returns:

outer path form.

Throws:

DockerVolCreationException

version

String version()

Changes to a mapper class should be accompanied by a increment in version. The is a string and open form, but using the major.minor.patch semantic versioning is recommended.

Returns:

builtForVersion

String builtForVersion()

The BioLockJ version that a class was built for and tested with.

Returns:

the current or previous BioLockJ version