Package io.fabric8.maven.docker.util

Class AnsiLogger

java.lang.Object

io.fabric8.maven.docker.util.AnsiLogger

All Implemented Interfaces:

Logger, Closeable, AutoCloseable

public class AnsiLogger
extends Object
implements Logger, Closeable

Simple log handler for printing used during the maven build

Since:

31.03.14

Author:

roland

Nested Class Summary

Nested classes/interfaces inherited from interface io.fabric8.maven.docker.util.Logger

Logger.LogVerboseCategory

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_LOG_PREFIX

Constructor Summary

Constructors

Constructor	Description
AnsiLogger(org.apache.maven.plugin.logging.Log log, boolean useColor, String verbose)
AnsiLogger(org.apache.maven.plugin.logging.Log log, boolean useColor, String verbose, boolean batchMode)
AnsiLogger(org.apache.maven.plugin.logging.Log log, boolean useColor, String verbose, boolean batchMode, String prefix)
AnsiLogger(org.apache.maven.plugin.logging.Log log, boolean useColor, String verbose, boolean batchMode, String prefix, File outpufFile)

Method Summary

Modifier and Type	Method	Description
void	close()
void	debug(String message, Object... params)	Debug message if debugging is enabled.
void	error(String message, Object... params)	Severe errors
String	errorMessage(String message)	Prepare the given message as an error message to be used in exceptions.
void	info(String message, Object... params)	Informational message
boolean	isDebugEnabled()	Whether debugging is enabled.
boolean	isVerboseEnabled()	Whether verbose is enablee
void	progressFinished()	Finis progress meter.
void	progressStart()	Start a progress bar
void	progressUpdate(String layerId, String status, String progressMessage)	Update the progress
void	verbose(Logger.LogVerboseCategory logVerboseCategory, String message, Object... params)	Verbose message for build
void	warn(String message, Object... params)	A warning.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOG_PREFIX

public static final String DEFAULT_LOG_PREFIX

See Also:

Constant Field Values

Constructor Detail

AnsiLogger

public AnsiLogger(org.apache.maven.plugin.logging.Log log,
                  boolean useColor,
                  String verbose)

AnsiLogger

public AnsiLogger(org.apache.maven.plugin.logging.Log log,
                  boolean useColor,
                  String verbose,
                  boolean batchMode)

AnsiLogger

public AnsiLogger(org.apache.maven.plugin.logging.Log log,
                  boolean useColor,
                  String verbose,
                  boolean batchMode,
                  String prefix)

AnsiLogger

public AnsiLogger(org.apache.maven.plugin.logging.Log log,
                  boolean useColor,
                  String verbose,
                  boolean batchMode,
                  String prefix,
                  File outpufFile)

Method Detail

debug

public void debug(String message,
                  Object... params)

Debug message if debugging is enabled.

Specified by:

debug in interface Logger

Parameters:

message - debug message format

params - parameter for formatting message

info

public void info(String message,
                 Object... params)

Informational message

Specified by:

info in interface Logger

Parameters:

message - info message format

params - parameter for formatting message

verbose

public void verbose(Logger.LogVerboseCategory logVerboseCategory,
                    String message,
                    Object... params)

Verbose message for build

Specified by:

verbose in interface Logger

Parameters:

logVerboseCategory - debug level for logging

message - verbose message format

params - parameter for formatting message

warn

public void warn(String message,
                 Object... params)

A warning.

Specified by:

warn in interface Logger

Parameters:

message - warning message format

params - parameter for formatting message

error

public void error(String message,
                  Object... params)

Severe errors

Specified by:

error in interface Logger

Parameters:

message - error message format

params - parameter for formatting message

errorMessage

public String errorMessage(String message)

Description copied from interface: Logger

Prepare the given message as an error message to be used in exceptions.

Specified by:

errorMessage in interface Logger

Parameters:

message - message to prepare

Returns:

prepared error message

isDebugEnabled

public boolean isDebugEnabled()

Whether debugging is enabled.

Specified by:

isDebugEnabled in interface Logger

isVerboseEnabled

public boolean isVerboseEnabled()

Description copied from interface: Logger

Whether verbose is enablee

Specified by:

isVerboseEnabled in interface Logger

progressStart

public void progressStart()

Start a progress bar

Specified by:

progressStart in interface Logger

progressUpdate

public void progressUpdate(String layerId,
                           String status,
                           String progressMessage)

Update the progress

Specified by:

progressUpdate in interface Logger

Parameters:

layerId - the image id of the layer fetched

status - a status message

progressMessage - the progressBar

progressFinished

public void progressFinished()

Finis progress meter. Must be always called if progressStart() has been used.

Specified by:

progressFinished in interface Logger

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException