com.spotify.docker.client

Class AnsiProgressHandler

java.lang.Object

com.spotify.docker.client.AnsiProgressHandler

All Implemented Interfaces:

ProgressHandler

public class AnsiProgressHandler
extends Object
implements ProgressHandler

Parses ProgressMessage objects and writes the output to a PrintStream. The output includes ANSI escape characters to move the cursor around to nicely print progress bars.

Field Summary

Fields

Modifier and Type	Field and Description
private static char	ESC_CODE
private Map<String,Integer>	idsToLines
private PrintStream	out

Constructor Summary

Constructors

Constructor and Description
AnsiProgressHandler()
AnsiProgressHandler(PrintStream out)

Method Summary

Methods

Modifier and Type	Method and Description
private void	printProgress(ProgressMessage message) Displays the upload/download status of multiple image layers the same way the docker CLI does.
void	progress(ProgressMessage message) This method will be called for each progress message received from Docker.

Methods inherited from class java.lang.Object

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

Field Detail

ESC_CODE

private static final char ESC_CODE

See Also:

Constant Field Values

out

private final PrintStream out

idsToLines

private final Map<String,Integer> idsToLines

Constructor Detail

AnsiProgressHandler

public AnsiProgressHandler()

AnsiProgressHandler

public AnsiProgressHandler(PrintStream out)

Method Detail

progress

public void progress(ProgressMessage message)
              throws DockerException

Description copied from interface: ProgressHandler

This method will be called for each progress message received from Docker.

Specified by:

progress in interface ProgressHandler

Parameters:

message - the message to process

Throws:

DockerException

printProgress

private void printProgress(ProgressMessage message)

Displays the upload/download status of multiple image layers the same way the docker CLI does. The current status of each layer is show on its own line. As the status updated, we move the cursor to the correct line, and overwrite the old status with the new one.

Parameters:

message - the ProgressMessage to parse