biolockj.util.paths

Interface PathMapper

All Known Subinterfaces:

DockerMountMapper

All Known Implementing Classes:

BasicDockerMapper, CommonDockerMapper, SimpleDockerMapper

public interface PathMapper

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.
Map<String,String>	getMap() The map at represents the connection of inner path to outer path.

Method Detail

getMap

Map<String,String> getMap()
                   throws BioLockJException

The map at represents the connection of inner path to outer path. Value is the inner path. Key is the outer path.

Returns:

Throws:

BioLockJException

asInnerPath

String asInnerPath(String path)
            throws BioLockJException

Convert path to inner path form.

Parameters:

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

mustConvert - should failure to convert the path result in an exception; if false, the path returned may be identical to the input path

Returns:

inner path form

Throws:

BioLockJException

asOuterPath

String asOuterPath(String path)
            throws BioLockJException

Convert path to outer path form.

Parameters:

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

mustConvert - should failure to convert the path result in an exception; if false, the path returned may be identical to the input path

Returns:

outer path form.

Throws:

BioLockJException