it.cnr.isti.hpc.log

Class ProgressLogger

java.lang.Object

it.cnr.isti.hpc.log.ProgressLogger

public class ProgressLogger
extends Object

A progress logger, print a configurable message when a the method

up()

is called a number k of times, so when:

status % k == 0

Author:

Diego Ceccarelli, diego.ceccarelli@isti.cnr.it created on 19/lug/2012

Constructor Summary

Constructors

Constructor and Description
ProgressLogger() Creates a progress logger, the print frequency is initialized using the system property logat.
ProgressLogger(int logFrequency) Creates a progress logger.
ProgressLogger(String logDesc) Creates a progress logger.
ProgressLogger(String logDesc, int logFrequency) Creates a progress logger.

Method Summary

Methods

Modifier and Type	Method and Description
int	up() Updates the progress status and print a line base on logFrequency;

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressLogger

public ProgressLogger()

Creates a progress logger, the print frequency is initialized using the system property logat. If logat is not set no progress will be print.

ProgressLogger

public ProgressLogger(int logFrequency)

Creates a progress logger.

Parameters:

logFrequency - the print frequency.

ProgressLogger

public ProgressLogger(String logDesc,
              int logFrequency)

Creates a progress logger.

Parameters:

logDesc - the message to print, the string {} will be replaced with the number of times that up() has been called.

logFrequency - the print frequency.

ProgressLogger

public ProgressLogger(String logDesc)

Creates a progress logger. the print frequency is initialized using the system property logat. If logat is not set no progress will be print.

Parameters:

logDesc - the message to print, the string {} will be replaced with the number of times that up() has been called.

Method Detail

up

public int up()

Updates the progress status and print a line base on logFrequency;

Returns:

the number of times up() has been called;