Module com.microsoft.gctoolkit.api

Package com.microsoft.gctoolkit.event

Class GCEvent

java.lang.Object

com.microsoft.gctoolkit.event.jvm.JVMEvent

com.microsoft.gctoolkit.event.GCEvent

Direct Known Subclasses:

FullZGCCycle, G1GCEvent, GenerationalGCEvent, MajorZGCCycle, MinorZGCCycle, ShenandoahCycle

public abstract class GCEvent
extends JVMEvent

A GCEvent is something that happens in the GC sub system that is captured in the log, e.g. a Full GC

A GCEvent has meta data which it expects to be overridden, e.g. whether or not it was a young collection

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GCEvent(DateTimeStamp timeStamp, double duration)
protected	GCEvent(DateTimeStamp timeStamp, GarbageCollectionTypes gcType, double duration)
protected	GCEvent(DateTimeStamp timeStamp, GarbageCollectionTypes gcType, GCCause cause, double duration)
protected	GCEvent(DateTimeStamp timeStamp, GCCause cause, double duration)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
GarbageCollectionTypes	getGarbageCollectionType()
GCCause	getGCCause()
int	hashCode()
void	setGCCause(GCCause cause)

Methods inherited from class com.microsoft.gctoolkit.event.jvm.JVMEvent

getDateTimeStamp, getDuration, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GCEvent

protected GCEvent(DateTimeStamp timeStamp,
                  GarbageCollectionTypes gcType,
                  GCCause cause,
                  double duration)

Parameters:

timeStamp - for event

gcType - for event

cause - of event

duration - of event

GCEvent

protected GCEvent(DateTimeStamp timeStamp,
                  double duration)

Parameters:

timeStamp - for event

duration - of event

GCEvent

protected GCEvent(DateTimeStamp timeStamp,
                  GCCause cause,
                  double duration)

Parameters:

timeStamp - for event

cause - that triggered the event

duration - of event

GCEvent

protected GCEvent(DateTimeStamp timeStamp,
                  GarbageCollectionTypes gcType,
                  double duration)

Parameters:

timeStamp - for event

gcType - of the event

duration - of the event

Method Detail

setGCCause

public void setGCCause(GCCause cause)

Parameters:

cause - of the event

getGCCause

public GCCause getGCCause()

Returns:

the cause of the event.

getGarbageCollectionType

public GarbageCollectionTypes getGarbageCollectionType()

Returns:

the type of collection this event represents

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

hashCode

equals

public boolean equals(Object o)

Overrides:

equals in class Object

Parameters:

o - the object to compare to.

Returns:

true is this equals o.