Package io.fluentlenium.core.performance

Class DefaultPerformanceTimingMetrics

java.lang.Object

io.fluentlenium.core.performance.DefaultPerformanceTimingMetrics

All Implemented Interfaces:

PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

public class DefaultPerformanceTimingMetrics
                    extends Object
implements PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>
                

Default implementation of PerformanceTimingMetrics storing the metrics value as a Map.

It also provides an option to convert all values in the current object to an arbitrary TimeUnit. For that you can call in(TimeUnit) on the current object.

The values returned from this object are not epoch values as querying the corresponding Javascript attribute directly would return, but it rather handles navigationStart as zero and returns time values passed since that point in time.

Take into account that when there is a time difference like 1675ms, and it is converted to e.g. seconds, the conversion will return 1sec for that instead of rounding it up to 2sec.

If a query for a certain metric returns 0 it means it happened at the same moment (at least in epoch) than navigationStart.

A query for a certain metrics returns a negative value if the event has not been registered on the page, or it is not feasible/valid for the given page/page load/redirect.

See Also:

• DefaultPerformanceTiming

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultPerformanceTimingMetrics (Map<String, Object> timingMetrics)	Creates a new DefaultPerformanceTimingMetrics object from the argument epoch values.
protected	DefaultPerformanceTimingMetrics (Map<String, Object> timingMetrics, TimeUnit timeUnit)	Creates a new DefaultPerformanceTimingMetrics object from the argument metrics (in the given time unit).

Method Summary

Modifier and Type	Method	Description
Map<String, Object>	getAllMetrics()
long	getConnectEnd()
long	getConnectStart()
long	getDomainLookupEnd()
long	getDomainLookupStart()
long	getDomComplete()
long	getDomContentLoadedEventEnd()
long	getDomContentLoadedEventStart()
long	getDomInteractive()
long	getDomLoading()
long	getFetchStart()
long	getLoadEventEnd()
long	getLoadEventStart()
long	getNavigationStart()
long	getRedirectEnd()
long	getRedirectStart()
long	getRequestStart()
long	getResponseEnd()
long	getResponseStart()
Object	getSecureConnectionStart()	According to the official documentation of the secureConnectionStart attribute this attribute is optional and may be set as undefined.
TimeUnit	getSourceTimeUnit()
long	getUnloadEventEnd()
long	getUnloadEventStart()
DefaultPerformanceTimingMetrics	in (TimeUnit targetTimeUnit)	Returns a new metrics object having all metric values converted to the target TimeUnit.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultPerformanceTimingMetrics

public DefaultPerformanceTimingMetrics
                                            
                                            (Map<String,Object> timingMetrics)
                                        

Creates a new DefaultPerformanceTimingMetrics object from the argument epoch values.

It calculates and converts the epoch values into the differences/times passed since navigationStart.

Parameters:

timingMetrics - the timing metrics in epoch

DefaultPerformanceTimingMetrics

protected DefaultPerformanceTimingMetrics
                                            
                                            (Map<String,Object> timingMetrics,
 TimeUnit timeUnit)

Creates a new DefaultPerformanceTimingMetrics object from the argument metrics (in the given time unit).

Parameters:

timingMetrics - the metrics

timeUnit - the time unit of the metrics

Method Details

in

public DefaultPerformanceTimingMetrics in
                                            
                                            (TimeUnit targetTimeUnit)

Returns a new metrics object having all metric values converted to the target TimeUnit.

Values that can have other than long values are converted if they are long values, otherwise added to the new metrics object unchanged.

Specified by:

in in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

Parameters:

targetTimeUnit - the time unit to convert the metrics to

Returns:

the converted metrics object

getAllMetrics

public Map<String,Object> getAllMetrics()
                                        

getSourceTimeUnit

public TimeUnit getSourceTimeUnit()
                                        

getUnloadEventStart

public long getUnloadEventStart()
                                        

Specified by:

getUnloadEventStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getUnloadEventEnd

public long getUnloadEventEnd()
                                        

Specified by:

getUnloadEventEnd in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getRedirectStart

public long getRedirectStart()
                                        

Specified by:

getRedirectStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getRedirectEnd

public long getRedirectEnd()
                                        

Specified by:

getRedirectEnd in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getNavigationStart

public long getNavigationStart()
                                        

Specified by:

getNavigationStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getFetchStart

public long getFetchStart()
                                        

Specified by:

getFetchStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getDomainLookupStart

public long getDomainLookupStart()
                                        

Specified by:

getDomainLookupStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getDomainLookupEnd

public long getDomainLookupEnd()
                                        

Specified by:

getDomainLookupEnd in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getConnectStart

public long getConnectStart()
                                        

Specified by:

getConnectStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getConnectEnd

public long getConnectEnd()
                                        

Specified by:

getConnectEnd in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getSecureConnectionStart

public Object getSecureConnectionStart()
                                        

Description copied from interface: PerformanceTimingMetrics

According to the official documentation of the secureConnectionStart attribute this attribute is optional and may be set as undefined.

It is up to the user of this method to check whether it is present and convert it accordingly.

Specified by:

getSecureConnectionStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

Returns:

the metrics value

getRequestStart

public long getRequestStart()
                                        

Specified by:

getRequestStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getResponseStart

public long getResponseStart()
                                        

Specified by:

getResponseStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getResponseEnd

public long getResponseEnd()
                                        

Specified by:

getResponseEnd in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getDomLoading

public long getDomLoading()
                                        

Specified by:

getDomLoading in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getDomInteractive

public long getDomInteractive()
                                        

Specified by:

getDomInteractive in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getDomContentLoadedEventStart

public long getDomContentLoadedEventStart()
                                        

Specified by:

getDomContentLoadedEventStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getDomContentLoadedEventEnd

public long getDomContentLoadedEventEnd()
                                        

Specified by:

getDomContentLoadedEventEnd in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getDomComplete

public long getDomComplete()
                                        

Specified by:

getDomComplete in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getLoadEventStart

public long getLoadEventStart()
                                        

Specified by:

getLoadEventStart in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>

getLoadEventEnd

public long getLoadEventEnd()
                                        

Specified by:

getLoadEventEnd in interface PerformanceTimingMetrics<DefaultPerformanceTimingMetrics>