Package org.codice.ddf.commands.catalog

Class CommandSupport

java.lang.Object

org.codice.ddf.commands.catalog.CommandSupport

All Implemented Interfaces:

org.apache.karaf.shell.api.action.Action

Direct Known Subclasses:

EnvListCommand, SubjectCommands

public abstract class CommandSupport
extends Object
implements org.apache.karaf.shell.api.action.Action

CommandSupport provides printing and progress bar support for extending classes

Field Summary

Fields

Modifier and Type	Field	Description
protected final PrintStream	console
protected static final org.fusesource.jansi.Ansi.Color	ERROR_COLOR
protected static final double	MS_PER_SECOND

Constructor Summary

Constructors

Constructor	Description
CommandSupport()

Method Summary

Modifier and Type	Method	Description
protected int	calculateRecordsPerSecond(long currentCount, long start, long end)
protected void	printColor(org.fusesource.jansi.Ansi.Color color, String message)
protected void	printErrorMessage(String message)
protected void	printHeaderMessage(String message)
protected void	printProgressAndFlush(long start, long totalCount, long currentCount)	Logic mimics org.apache.karaf.main.StartupListener#showProgressBar
protected void	printSuccessMessage(String message)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.karaf.shell.api.action.Action

execute

Field Details

MS_PER_SECOND

protected static final double MS_PER_SECOND

See Also:

• Constant Field Values

ERROR_COLOR

protected static final org.fusesource.jansi.Ansi.Color ERROR_COLOR

console

protected final PrintStream console

Constructor Details

CommandSupport

public CommandSupport()

Method Details

printColor

protected void printColor(org.fusesource.jansi.Ansi.Color color,
 String message)

printErrorMessage

protected void printErrorMessage(String message)

printHeaderMessage

protected void printHeaderMessage(String message)

printSuccessMessage

protected void printSuccessMessage(String message)

printProgressAndFlush

protected void printProgressAndFlush(long start,
 long totalCount,
 long currentCount)

Logic mimics org.apache.karaf.main.StartupListener#showProgressBar

Parameters:

start - time started processing records

totalCount - count of total records

currentCount - count of records completed

calculateRecordsPerSecond

protected int calculateRecordsPerSecond(long currentCount,
 long start,
 long end)