Package io.fluentlenium.core.performance

Class HtmlUnitPerformanceTimingMetrics

java.lang.Object

io.fluentlenium.core.performance.HtmlUnitPerformanceTimingMetrics

All Implemented Interfaces:

PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

public class HtmlUnitPerformanceTimingMetrics
                    extends Object
implements PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>
                

HtmlUnit specific implementation of PerformanceTimingMetrics.

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.

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.

Though the HtmlUnit PerformanceTiming class is a mock implementation of the PerformanceTiming API, the lack of this adapter might cause issues.

Before retrieving performance timing metrics from HtmlUnit, please check the aforementioned class whether it is still a mock object or meanwhile it has been implemented properly to return real values.

Constructor Summary

Constructors

Constructor	Description
HtmlUnitPerformanceTimingMetrics (com.gargoylesoftware.htmlunit.javascript.host.performance.PerformanceTiming timing)	Creates a new HtmlUnitPerformanceTimingMetrics object delegating calls to the argument PerformanceTiming.
HtmlUnitPerformanceTimingMetrics (com.gargoylesoftware.htmlunit.javascript.host.performance.PerformanceTiming timing, TimeUnit timeUnit)	Creates a new HtmlUnitPerformanceTimingMetrics object delegating calls to the argument PerformanceTiming.

Method Summary

Modifier and Type	Method	Description
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.
long	getUnloadEventEnd()
long	getUnloadEventStart()
HtmlUnitPerformanceTimingMetrics	in (TimeUnit targetTimeUnit)	Creates a new metrics object instance that returns the metrics values in the given TimeUnit.

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlUnitPerformanceTimingMetrics

public HtmlUnitPerformanceTimingMetrics
                                            
                                            (com.gargoylesoftware.htmlunit.javascript.host.performance.PerformanceTiming timing)
                                        

Creates a new HtmlUnitPerformanceTimingMetrics object delegating calls to the argument PerformanceTiming.

Sets the time unit of these metrics to TimeUnit.MILLISECONDS.

Parameters:

timing - the HtmlUnit performance timing object

HtmlUnitPerformanceTimingMetrics

public HtmlUnitPerformanceTimingMetrics
                                            
                                            (com.gargoylesoftware.htmlunit.javascript.host.performance.PerformanceTiming timing,
 TimeUnit timeUnit)

Creates a new HtmlUnitPerformanceTimingMetrics object delegating calls to the argument PerformanceTiming.

Sets the time unit of these metrics to the given time unit.

Parameters:

timing - the HtmlUnit performance timing object

timeUnit - the time unit to convert the metrics to

Method Details

in

public HtmlUnitPerformanceTimingMetrics in
                                            
                                            (TimeUnit targetTimeUnit)

Description copied from interface: PerformanceTimingMetrics

Creates a new metrics object instance that returns the metrics values in the given TimeUnit.

When implementing this method take into account that there may be metric values that don't always return a long value but may be undefined, or something else, like the secureConnectionStart attribute.

Specified by:

in in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

Parameters:

targetTimeUnit - the time unit to return the metrics in

Returns:

the metrics in the given time unit

getUnloadEventStart

public long getUnloadEventStart()
                                        

Specified by:

getUnloadEventStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getUnloadEventEnd

public long getUnloadEventEnd()
                                        

Specified by:

getUnloadEventEnd in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getRedirectStart

public long getRedirectStart()
                                        

Specified by:

getRedirectStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getRedirectEnd

public long getRedirectEnd()
                                        

Specified by:

getRedirectEnd in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getNavigationStart

public long getNavigationStart()
                                        

Specified by:

getNavigationStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getFetchStart

public long getFetchStart()
                                        

Specified by:

getFetchStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getDomainLookupStart

public long getDomainLookupStart()
                                        

Specified by:

getDomainLookupStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getDomainLookupEnd

public long getDomainLookupEnd()
                                        

Specified by:

getDomainLookupEnd in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getConnectStart

public long getConnectStart()
                                        

Specified by:

getConnectStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getConnectEnd

public long getConnectEnd()
                                        

Specified by:

getConnectEnd in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

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<HtmlUnitPerformanceTimingMetrics>

Returns:

the metrics value

getRequestStart

public long getRequestStart()
                                        

Specified by:

getRequestStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getResponseStart

public long getResponseStart()
                                        

Specified by:

getResponseStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getResponseEnd

public long getResponseEnd()
                                        

Specified by:

getResponseEnd in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getDomLoading

public long getDomLoading()
                                        

Specified by:

getDomLoading in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getDomInteractive

public long getDomInteractive()
                                        

Specified by:

getDomInteractive in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getDomContentLoadedEventStart

public long getDomContentLoadedEventStart()
                                        

Specified by:

getDomContentLoadedEventStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getDomContentLoadedEventEnd

public long getDomContentLoadedEventEnd()
                                        

Specified by:

getDomContentLoadedEventEnd in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getDomComplete

public long getDomComplete()
                                        

Specified by:

getDomComplete in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getLoadEventStart

public long getLoadEventStart()
                                        

Specified by:

getLoadEventStart in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>

getLoadEventEnd

public long getLoadEventEnd()
                                        

Specified by:

getLoadEventEnd in interface PerformanceTimingMetrics<HtmlUnitPerformanceTimingMetrics>