Module org.nasdanika.html.model.app.gen.maven

Package org.nasdanika.html.model.app.gen.maven

Class ActionSiteGeneratorMojo.PrintStreamProgressMonitor

java.lang.Object

org.nasdanika.html.model.app.gen.maven.ActionSiteGeneratorMojo.PrintStreamProgressMonitor

All Implemented Interfaces:

AutoCloseable, org.nasdanika.common.Composeable<org.nasdanika.common.ProgressMonitor>, org.nasdanika.common.ProgressMonitor

Enclosing class:

ActionSiteGeneratorMojo

public class ActionSiteGeneratorMojo.PrintStreamProgressMonitor
extends Object
implements org.nasdanika.common.ProgressMonitor

Progress monitor reporting to a PrintStream, e.g. ``System.out``. This monitor indents sub-tasks and worked messages. It can be thought of as a hierarchical logger.

Author:

Pavel

Field Summary

Fields

Modifier and Type	Field	Description
protected int	indentIncrement

Constructor Summary

Constructors

Constructor	Description
PrintStreamProgressMonitor()	Constructs a progres monitor outputting to System.out with indent 0, indentIncrement 2 and not closing the stream.
PrintStreamProgressMonitor(PrintStream out, int indent, int indentIncrement, boolean closeStream)	Constructs a progress monitor for a given print stream.

Method Summary

Modifier and Type	Method	Description
void	close()
protected String	formatDetail(Object detail, String indent)	Formats detail element for output.
boolean	isCancelled()
org.nasdanika.common.ProgressMonitor	setWorkRemaining(double size)
org.nasdanika.common.ProgressMonitor	split(String taskName, double size, Object... data)
void	worked(org.nasdanika.common.Status status, double work, String progressMessage, Object... data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nasdanika.common.ProgressMonitor

compose, scale, worked

Field Detail

indentIncrement

protected int indentIncrement

Constructor Detail

PrintStreamProgressMonitor

public PrintStreamProgressMonitor(PrintStream out,
                                  int indent,
                                  int indentIncrement,
                                  boolean closeStream)

Constructs a progress monitor for a given print stream.

Parameters:

out -

indent - Indent in spaces for this monitor.

indentIncrement - Increment to add to the indent of this monitor when constructing a sub-monitor.

closeStream - if true the monitor closes the stream in its close() method.

PrintStreamProgressMonitor

public PrintStreamProgressMonitor()

Constructs a progres monitor outputting to System.out with indent 0, indentIncrement 2 and not closing the stream.

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.nasdanika.common.ProgressMonitor

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.nasdanika.common.ProgressMonitor

split

public org.nasdanika.common.ProgressMonitor split(String taskName,
                                                  double size,
                                                  Object... data)

Specified by:

split in interface org.nasdanika.common.ProgressMonitor

formatDetail

protected String formatDetail(Object detail,
                              String indent)

Formats detail element for output. This implementation concatenates the indent with the detail.

Parameters:

detail -

indent -

Returns:

worked

public void worked(org.nasdanika.common.Status status,
                   double work,
                   String progressMessage,
                   Object... data)

Specified by:

worked in interface org.nasdanika.common.ProgressMonitor

setWorkRemaining

public org.nasdanika.common.ProgressMonitor setWorkRemaining(double size)

Specified by:

setWorkRemaining in interface org.nasdanika.common.ProgressMonitor