LoggerStopwatch (GST Site Foundation for WebCenter Sites 12.0.1 API)

java.lang.Object
- tools.gsf.time.LoggerStopwatch

All Implemented Interfaces:

Stopwatch
```
public final class LoggerStopwatch
extends Object
implements Stopwatch
```
Stopwatch that records records into a logger. If the logger specified is not enabled at the debug level, this timer does nothing. Designed for performance measurements. Very lightweight object. Upon instantiation, the current time is measured once.

Since:

2016-07-17

Author:

Tony Field

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_LOGGER_NAME` Default logger name used by this timer if no other logger is named.
`static String`	`MESSAGE_FORMAT_ELAPSED` Stopwatch message format string.
`static String`	`MESSAGE_FORMAT_SPLIT` Stopwatch message format string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`elapsed(String msg)` Record the elapsed time since the stopwatch was started/restarted.
`void`	`elapsed(String msg, Object... args)` Record the elapsed time since the stopwatch was started/restarted.
`static Stopwatch`	`getInstance()` Create a stopwatch using the default logger, if debug is enabled.
`static Stopwatch`	`getInstance(org.slf4j.Logger logger)` Create a logger stopwatch using the logger specified.
`static Stopwatch`	`getInstance(String logger)` Create a logger stopwatch using the logger specified.
`void`	`split(String msg)` Record time elapsed since the last interval measurement or since started/restarted.
`void`	`split(String msg, Object... args)` Record time elapsed since the last interval measurement or since started/restarted.
`void`	`start()` Starts the stopwatch.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LOGGER_NAME
```
public static final String DEFAULT_LOGGER_NAME
```
    Default logger name used by this timer if no other logger is named.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_FORMAT_SPLIT
```
public static final String MESSAGE_FORMAT_SPLIT
```
    Stopwatch message format string. This format will be used for all split measurements. The first {} marker will be replaced by the time in microseconds. The second marker will be replaced by the human-readable version of the time. The provided message will be appended to the end.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_FORMAT_ELAPSED
```
public static final String MESSAGE_FORMAT_ELAPSED
```
    Stopwatch message format string. This format will be used for all cumulative measurements. The first {} marker will be replaced by the time in microseconds. The second marker will be replaced by the human-readable version of the time. The provided message will be appended to the end.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static Stopwatch getInstance(org.slf4j.Logger logger)
```
    Create a logger stopwatch using the logger specified. If debug is not enabled, the NoopStopwatch is returned
    
    Parameters:
    
    logger - logger instance
    
    Returns:
    
    the stopwatch or the NoopStopwatch if debug is not enabled
    
    See Also:
    
    NoopStopwatch
  - getInstance
```
public static Stopwatch getInstance(String logger)
```
    Create a logger stopwatch using the logger specified. If debug is not enabled, the NoopStopwatch is returned
    
    Parameters:
    
    logger - logger instance
    
    Returns:
    
    the stopwatch or the NoopStopwatch if debug is not enabled
    
    See Also:
    
    NoopStopwatch
  - getInstance
```
public static Stopwatch getInstance()
```
    Create a stopwatch using the default logger, if debug is enabled. If debug is not enabled, the NoopStopwatch is returned.
    
    Returns:
    
    the stopwatch or the NoopStopwatch if debug is not enabled
    
    See Also:
    
    NoopStopwatch, DEFAULT_LOGGER_NAME
  - start
```
public void start()
```
    Description copied from interface: Stopwatch
    
    Starts the stopwatch. Must be called before taking a split or elapsed time.
    
    Specified by:
    
    start in interface Stopwatch
  - split
```
public void split(String msg)
```
    Description copied from interface: Stopwatch
    
    Record time elapsed since the last interval measurement or since started/restarted. Resets the interval timer.
    
    Specified by:
    
    split in interface Stopwatch
    
    Parameters:
    
    msg - message to record (typically a description of the functionality measured, like a component name.)
  - split
```
public void split(String msg,
                  Object... args)
```
    Description copied from interface: Stopwatch
    
    Record time elapsed since the last interval measurement or since started/restarted. Resets the interval timer.
    
    Specified by:
    
    split in interface Stopwatch
    
    Parameters:
    
    msg - message to record (typically a description of the functionality measured, like a component name.)
    
    args - arguments to be substituted into the message. Parameterization operates as in slf4j: http://www.slf4j.org/faq.html#logging_performance
  - elapsed
```
public void elapsed(String msg)
```
    Description copied from interface: Stopwatch
    
    Record the elapsed time since the stopwatch was started/restarted. Does not reset either the interval timer or the cumulative timer.
    
    Specified by:
    
    elapsed in interface Stopwatch
    
    Parameters:
    
    msg - message to record (typically a description of the functionality measured, like a component name.)
  - elapsed
```
public void elapsed(String msg,
                    Object... args)
```
    Description copied from interface: Stopwatch
    
    Record the elapsed time since the stopwatch was started/restarted. Does not reset either the interval timer or the cumulative timer.
    
    Specified by:
    
    elapsed in interface Stopwatch
    
    Parameters:
    
    msg - message to record (typically a description of the functionality measured, like a component name.)
    
    args - arguments to be substituted into the message. Parameterization operates as in slf4j: http://www.slf4j.org/faq.html#logging_performance

Class LoggerStopwatch

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOGGER_NAME

MESSAGE_FORMAT_SPLIT

MESSAGE_FORMAT_ELAPSED

Method Detail

getInstance

getInstance

getInstance

start

split

split

elapsed

elapsed