DefaultAllocatorMetric (SNF4J 1.10.0 API)

java.lang.Object
- org.snf4j.core.allocator.DefaultAllocatorMetric

All Implemented Interfaces:

IDefaultAllocatorMetricCollector

Direct Known Subclasses:

AllocatorMetric
```
public class DefaultAllocatorMetric
extends Object
implements IDefaultAllocatorMetricCollector
```
Metric for the DefaultAllocator.

Author:

SNF4J.ORG

Constructor Summary

Constructors
Constructor and Description

DefaultAllocatorMetric()

Constructors
Constructor and Description
`DefaultAllocatorMetric()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`allocated(int capacity)` Called when a true allocation (not taken from a cache or a pool) was performed by the associated allocator.
`void`	`allocating(int capacity)` Called when an allocation was performed by the associated allocator.
`void`	`ensure()` Called when allocation was performed as a result of calling the `ensure` method in the associated allocator.
`void`	`ensureSome()` Called when allocation was performed as a result of calling the `ensureSome` method in the associated allocator.
`void`	`extend()` Called when allocation was performed as a result of calling the `extend` method in the associated allocator.
`long`	`getAllocatedCount()` Gets the total number of true allocations that have been performed by the associated allocator.
`long`	`getAllocatingCount()` Gets the total number of allocations that have been performed by the associated allocator.
`long`	`getEnsureCount()` Gets the total number of re-allocations that have been performed by the `ensure` method in the associated allocator.
`long`	`getEnsureSomeCount()` Gets the total number of re-allocations that have been performed by the `ensureSome` method in the associated allocator.
`long`	`getExtendCount()` Gets the total number of re-allocations that have been performed by the `extend` method in the associated allocator.
`int`	`getMaxCapacity()` Gets the capacity of the biggest buffer allocated by the associated allocator.
`long`	`getReduceCount()` Gets the total number of re-allocations that have been performed by the `reduce` method in the associated allocator.
`long`	`getReleasedCount()` Gets the total number of buffers that have been released by the associated allocator.
`long`	`getReleasingCount()` Gets the total number of buffers that have been requested for releasing by the associated allocator.
`void`	`reduce()` Called when allocation was performed as a result of calling the `reduce` method in the associated allocator.
`void`	`released(int capacity)` Called when a buffer was released by the associated allocator.
`void`	`releasing(int capacity)` Called when a buffer was requested for releasing by the associated allocator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultAllocatorMetric
```
public DefaultAllocatorMetric()
```
- Method Detail
  - allocating
```
public void allocating(int capacity)
```
    Description copied from interface: IDefaultAllocatorMetricCollector
    
    Called when an allocation was performed by the associated allocator. This method is called no matter the buffer was truly allocated or taken for example from a cache implemented by the associated allocator.
    
    Specified by:
    
    allocating in interface IDefaultAllocatorMetricCollector
    
    Parameters:
    
    capacity - requested capacity of the buffer to be allocated
  - allocated
```
public void allocated(int capacity)
```
    Description copied from interface: IDefaultAllocatorMetricCollector
    
    Called when a true allocation (not taken from a cache or a pool) was performed by the associated allocator.
    
    Specified by:
    
    allocated in interface IDefaultAllocatorMetricCollector
    
    Parameters:
    
    capacity - capacity of the allocated buffer
  - released
```
public void released(int capacity)
```
    Description copied from interface: IDefaultAllocatorMetricCollector
    
    Called when a buffer was released by the associated allocator.
    
    Specified by:
    
    released in interface IDefaultAllocatorMetricCollector
    
    Parameters:
    
    capacity - capacity of the released buffer
  - releasing
```
public void releasing(int capacity)
```
    Description copied from interface: IDefaultAllocatorMetricCollector
    
    Called when a buffer was requested for releasing by the associated allocator.
    
    Specified by:
    
    releasing in interface IDefaultAllocatorMetricCollector
    
    Parameters:
    
    capacity - capacity of the releasing buffer
  - ensureSome
```
public void ensureSome()
```
    Description copied from interface: IDefaultAllocatorMetricCollector
    
    Called when allocation was performed as a result of calling the ensureSome method in the associated allocator.
    
    Specified by:
    
    ensureSome in interface IDefaultAllocatorMetricCollector
  - ensure
```
public void ensure()
```
    Description copied from interface: IDefaultAllocatorMetricCollector
    
    Called when allocation was performed as a result of calling the ensure method in the associated allocator.
    
    Specified by:
    
    ensure in interface IDefaultAllocatorMetricCollector
  - reduce
```
public void reduce()
```
    Description copied from interface: IDefaultAllocatorMetricCollector
    
    Called when allocation was performed as a result of calling the reduce method in the associated allocator.
    
    Specified by:
    
    reduce in interface IDefaultAllocatorMetricCollector
  - extend
```
public void extend()
```
    Description copied from interface: IDefaultAllocatorMetricCollector
    
    Called when allocation was performed as a result of calling the extend method in the associated allocator.
    
    Specified by:
    
    extend in interface IDefaultAllocatorMetricCollector
  - getAllocatingCount
```
public long getAllocatingCount()
```
    Gets the total number of allocations that have been performed by the associated allocator.
    
    Returns:
    
    the total number of allocations
  - getAllocatedCount
```
public long getAllocatedCount()
```
    Gets the total number of true allocations that have been performed by the associated allocator.
    
    Returns:
    
    the total number of real allocations
  - getReleasingCount
```
public long getReleasingCount()
```
    Gets the total number of buffers that have been requested for releasing by the associated allocator.
    
    Returns:
    
    the total number of released buffers
  - getReleasedCount
```
public long getReleasedCount()
```
    Gets the total number of buffers that have been released by the associated allocator.
    
    Returns:
    
    the total number of released buffers
  - getEnsureSomeCount
```
public long getEnsureSomeCount()
```
    Gets the total number of re-allocations that have been performed by the ensureSome method in the associated allocator.
    
    Returns:
    
    the total number of re-allocations
  - getEnsureCount
```
public long getEnsureCount()
```
    Gets the total number of re-allocations that have been performed by the ensure method in the associated allocator.
    
    Returns:
    
    the total number of re-allocations
  - getReduceCount
```
public long getReduceCount()
```
    Gets the total number of re-allocations that have been performed by the reduce method in the associated allocator.
    
    Returns:
    
    the total number of re-allocations
  - getExtendCount
```
public long getExtendCount()
```
    Gets the total number of re-allocations that have been performed by the extend method in the associated allocator.
    
    Returns:
    
    the total number of re-allocations
  - getMaxCapacity
```
public int getMaxCapacity()
```
    Gets the capacity of the biggest buffer allocated by the associated allocator.
    
    Returns:
    
    the max capacity

Class DefaultAllocatorMetric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultAllocatorMetric

Method Detail

allocating

allocated

released

releasing

ensureSome

ensure

reduce

extend

getAllocatingCount

getAllocatedCount

getReleasingCount

getReleasedCount

getEnsureSomeCount

getEnsureCount

getReduceCount

getExtendCount

getMaxCapacity