Package com.yourkit.api.controller.v2

Class AllocationProfilingSettings

java.lang.Object

com.yourkit.api.controller.v2.AllocationProfilingSettings

public class AllocationProfilingSettings
extends Object

Constructor Summary

Constructors

Constructor	Description
AllocationProfilingSettings()

Method Summary

Modifier and Type	Method	Description
Integer	getHeapSamplingInterval()	Get heap sampling interval applied in the AllocationProfilingMode.HEAP_SAMPLING mode.
AllocationProfilingMode	getMode()
Integer	getRecordEach()
Integer	getSizeLimit()
AllocationProfilingSettings	setHeapSamplingInterval(Integer interval)	Set the heap sampling interval applied in the AllocationProfilingMode.HEAP_SAMPLING mode.
AllocationProfilingSettings	setMode(AllocationProfilingMode mode)
AllocationProfilingSettings	setRecordEach(Integer each)	The value is applied in the AllocationProfilingMode.EXACT_STACKS mode.
AllocationProfilingSettings	setSizeLimit(Integer limit)	The value is applied in the AllocationProfilingMode.EXACT_STACKS mode.

Methods inherited from class java.lang.Object

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

Constructor Details

AllocationProfilingSettings

public AllocationProfilingSettings()

Method Details

getMode

@Nullable
public AllocationProfilingMode getMode()

setMode

@NotNull
public AllocationProfilingSettings setMode(@Nullable
 AllocationProfilingMode mode)

Parameters:

mode - NULL means default value.

getSizeLimit

@Nullable
public Integer getSizeLimit()

setSizeLimit

@NotNull
public AllocationProfilingSettings setSizeLimit(@Nullable
 Integer limit)

The value is applied in the AllocationProfilingMode.EXACT_STACKS mode. In other modes the value, if set, has no effect and is ignored.

Parameters:

limit - NULL means default value.

getRecordEach

@Nullable
public Integer getRecordEach()

setRecordEach

@NotNull
public AllocationProfilingSettings setRecordEach(@Nullable
 Integer each)

The value is applied in the AllocationProfilingMode.EXACT_STACKS mode. In other modes the value, if set, has no effect and is ignored.

Parameters:

each - NULL means default value.

getHeapSamplingInterval

@Nullable
public Integer getHeapSamplingInterval()

Get heap sampling interval applied in the AllocationProfilingMode.HEAP_SAMPLING mode. In other modes the value, if set, has no effect and is ignored.

If the value has not been set, NULL is returned which means the default value.

Returns:

heap sampling interval in bytes.

setHeapSamplingInterval

@NotNull
public AllocationProfilingSettings setHeapSamplingInterval(@Nullable
 Integer interval)

Set the heap sampling interval applied in the AllocationProfilingMode.HEAP_SAMPLING mode. In other modes the value, if set, has no effect and is ignored.

Parameters:

interval - heap sampling interval in bytes, must be 0 or greater; NULL means the default value. If the value is 0, heap sampling will record all object allocations.

Throws:

IllegalArgumentException - if the specified interval is a negative number.