com.leafactor.cli.engine.logging

Class SimpleIterationPhaseLogEntry

java.lang.Object

com.leafactor.cli.engine.logging.SimpleIterationPhaseLogEntry

All Implemented Interfaces:

IterationLogEntry, IterationPhaseLogEntry

public class SimpleIterationPhaseLogEntry
extends java.lang.Object
implements IterationPhaseLogEntry

Represents a simple general purpose implementation of the IterationPhaseLogEntry interface

Constructor Summary

Constructors

Constructor and Description
SimpleIterationPhaseLogEntry(RefactoringRule rule, java.lang.String name, java.lang.String description) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Getter for the description of the entry
java.time.Instant	getEndPhaseTimestamp() Getter for the timestamp of the end of the phase
java.lang.String	getName() Getter for the name of the entry
java.time.Duration	getPhaseDuration() Getter for the elapsed time between the start and the end of the phase
RefactoringRule	getRule() Getter for the refactoring rule
java.time.Instant	getStartPhaseTimestamp() Getter for the timestamp of the start of the phase
java.time.Instant	getTimeStamp() Getter for the timestamp of the entry, which is the timestamp of the start of the phase
void	start() Marks the start of a phase
void	stop() Marks the end of a phase

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleIterationPhaseLogEntry

public SimpleIterationPhaseLogEntry(RefactoringRule rule,
                                    java.lang.String name,
                                    java.lang.String description)

Constructor

Parameters:

rule - The rule that was applied in the iteration

name - The name of the log entry

description - The description of the log entry

Method Detail

start

public void start()

Marks the start of a phase

stop

public void stop()

Marks the end of a phase

getRule

public RefactoringRule getRule()

Getter for the refactoring rule

Specified by:

getRule in interface IterationLogEntry

Returns:

The refactoring rule that was applied

getName

public java.lang.String getName()

Getter for the name of the entry

Specified by:

getName in interface IterationLogEntry

Returns:

The name of the entry

getDescription

public java.lang.String getDescription()

Getter for the description of the entry

Specified by:

getDescription in interface IterationLogEntry

Returns:

The description of the entry

getTimeStamp

public java.time.Instant getTimeStamp()

Getter for the timestamp of the entry, which is the timestamp of the start of the phase

Specified by:

getTimeStamp in interface IterationLogEntry

Returns:

The timestamp of the entry, which is the timestamp of the start of the phase

getStartPhaseTimestamp

public java.time.Instant getStartPhaseTimestamp()

Getter for the timestamp of the start of the phase

Specified by:

getStartPhaseTimestamp in interface IterationPhaseLogEntry

Returns:

The timestamp of the start of the phase

getEndPhaseTimestamp

public java.time.Instant getEndPhaseTimestamp()

Getter for the timestamp of the end of the phase

Specified by:

getEndPhaseTimestamp in interface IterationPhaseLogEntry

Returns:

The timestamp of the end of the phase

getPhaseDuration

public java.time.Duration getPhaseDuration()

Getter for the elapsed time between the start and the end of the phase

Specified by:

getPhaseDuration in interface IterationPhaseLogEntry

Returns:

The elapsed time between the start and the end of the phase