Package net.obvj.performetrics.config

Class Configuration

java.lang.Object

net.obvj.performetrics.config.Configuration

public class Configuration
extends Object

An object that maintains common configurable parameters for Perfometrics objects.

Since:

2.0.0

Author:

oswaldo.bapvic.jr

Constructor Summary

Constructors

Constructor	Description
Configuration()	Builds a new Configuration with all initial values.

Method Summary

Modifier and Type	Method	Description
ConversionMode	getConversionMode()	Returns the conversion mode applied in supported operations if no specific mode is set.
PrintStyle	getPrintStyle()	Returns the default PrintStyle to be applied when no style is specified.
PrintStyle	getPrintStyleForDetails()	Returns the default PrintStyle for the detailed stopwatch formatter.
PrintStyle	getPrintStyleForSummary()	Returns the default PrintStyle for the summarized stopwatch formatter.
int	getScale()	Returns the maximum number of decimal places applied if double-precision conversion mode is set.
TimeUnit	getTimeUnit()	Returns the time unit maintained by default if no specific time unit is specified.
void	setConversionMode(ConversionMode conversionMode)	Defines the default conversion mode to be applied in supported operations if no specific mode is set.
void	setPrintStyle(PrintStyle printStyle)	Defines the default PrintStyle to be applied when no style is specified.
void	setPrintStyleForDetails(PrintStyle printStyle)	Defines the default PrintStyle for the detailed stopwatch formatter.
void	setPrintStyleForSummary(PrintStyle printStyle)	Defines the default PrintStyle for the summarized stopwatch formatter.
void	setScale(int scale)	Sets a maximum number of decimal places to be applied if double-precision conversion mode is set.
void	setTimeUnit(TimeUnit timeUnit)	Defines the time unit to be maintained by default if no specific time unit is specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Builds a new Configuration with all initial values.

Method Detail

getTimeUnit

public TimeUnit getTimeUnit()

Returns the time unit maintained by default if no specific time unit is specified.

Returns:

the time unit maintained by default

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

Defines the time unit to be maintained by default if no specific time unit is specified.

Parameters:

timeUnit - the TimeUnit to set

Throws:

NullPointerException - if the specified time unit is null

getConversionMode

public ConversionMode getConversionMode()

Returns the conversion mode applied in supported operations if no specific mode is set.

Returns:

the conversion mode applied in supported operations

setConversionMode

public void setConversionMode(ConversionMode conversionMode)

Defines the default conversion mode to be applied in supported operations if no specific mode is set.

Parameters:

conversionMode - the ConversionMode to set

Throws:

NullPointerException - if the specified conversion mode is null

getScale

public int getScale()

Returns the maximum number of decimal places applied if double-precision conversion mode is set.

Returns:

the the maximum number of decimal places applied

setScale

public void setScale(int scale)

Sets a maximum number of decimal places to be applied if double-precision conversion mode is set.

Parameters:

scale - a number between 0 and 16 to be set

Throws:

IllegalArgumentException - if the specified number is outside the allowed range

getPrintStyle

public PrintStyle getPrintStyle()

Returns the default PrintStyle to be applied when no style is specified.

Returns:

the default PrintStyle to be applied when no style is specified

Since:

2.4.0

setPrintStyle

public void setPrintStyle(PrintStyle printStyle)

Defines the default PrintStyle to be applied when no style is specified.

The object will be applied by the following operations:

• TimingSessionContainer.print(java.io.PrintStream)
• TimingSessionContainer.toString()

Parameters:

printStyle - the PrintStyle to be set; not null

Throws:

NullPointerException - if the specified PrintStyle is null

Since:

2.4.0

getPrintStyleForSummary

public PrintStyle getPrintStyleForSummary()

Returns the default PrintStyle for the summarized stopwatch formatter.

Returns:

the default PrintStyle for the summarized stopwatch formatter

Since:

2.2.1

setPrintStyleForSummary

public void setPrintStyleForSummary(PrintStyle printStyle)

Defines the default PrintStyle for the summarized stopwatch formatter.

The object will be used by the following operation:

• TimingSessionContainer.printSummary(java.io.PrintStream)

Parameters:

printStyle - the PrintStyle to be set; not null

Throws:

NullPointerException - if the specified PrintStyle is null

Since:

2.2.1

getPrintStyleForDetails

public PrintStyle getPrintStyleForDetails()

Returns the default PrintStyle for the detailed stopwatch formatter.

Returns:

the default PrintStyle for the detailed stopwatch formatter

Since:

2.2.1

setPrintStyleForDetails

public void setPrintStyleForDetails(PrintStyle printStyle)

Defines the default PrintStyle for the detailed stopwatch formatter.

The object will be used by the following operations:

• TimingSessionContainer.printDetails(java.io.PrintStream)

Parameters:

printStyle - the PrintStyle to be set; not null

Throws:

NullPointerException - if the specified PrintStyle is null

Since:

2.2.1