LocalMemoryStatsImpl (Hazelcast Root 3.12.12 API)

java.lang.Object
- com.hazelcast.monitor.impl.LocalMemoryStatsImpl

All Implemented Interfaces:

JsonSerializable, MemoryStats, LocalInstanceStats, LocalMemoryStats
```
public class LocalMemoryStatsImpl
extends Object
implements LocalMemoryStats
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_COMMITTED_HEAP`
`static String`	`JSON_COMMITTED_NATIVE_MEMORY`
`static String`	`JSON_CREATION_TIME`
`static String`	`JSON_FREE_NATIVE_MEMORY`
`static String`	`JSON_FREE_PHYSICAL`
`static String`	`JSON_GC_STATS`
`static String`	`JSON_MAX_HEAP`
`static String`	`JSON_MAX_NATIVE_MEMORY`
`static String`	`JSON_TOTAL_PHYSICAL`
`static String`	`JSON_USED_HEAP`
`static String`	`JSON_USED_NATIVE_MEMORY`

Fields inherited from interface com.hazelcast.monitor.LocalInstanceStats
STAT_NOT_AVAILABLE

Constructor Summary

Constructors
Constructor and Description

LocalMemoryStatsImpl()

LocalMemoryStatsImpl(MemoryStats memoryStats)

Constructors
Constructor and Description
`LocalMemoryStatsImpl()`
`LocalMemoryStatsImpl(MemoryStats memoryStats)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fromJson(JsonObject json)` Extracts the state from the given `json` object and mutates the state of this object.
`long`	`getCommittedHeap()` Returns the amount of memory in bytes that is committed for the Java virtual machine to use.
`long`	`getCommittedNative()` Returns the amount of native memory in bytes that is committed for current HazelcastInstance to use.
`long`	`getCreationTime()` Returns the creation time of this distributed object instance on this member.
`long`	`getFreeHeap()` Returns the amount of free memory in the JVM in bytes.
`long`	`getFreeNative()` Returns the amount of free native memory in current HazelcastInstance in bytes.
`long`	`getFreePhysical()` Returns free physical memory available in OS.
`LocalGCStats`	`getGCStats()` Returns the garbage collector statistics for the JVM
`long`	`getMaxHeap()` Returns the maximum amount of memory that the JVM will attempt to use in bytes.
`long`	`getMaxMetadata()` Returns the amount of native memory reserved for metadata.
`long`	`getMaxNative()` Returns the maximum amount of native memory that current HazelcastInstance will attempt to use in bytes.
`long`	`getTotalPhysical()` Returns total physical memory available in OS.
`long`	`getUsedHeap()` Returns the amount of used memory in the JVM in bytes.
`long`	`getUsedMetadata()`
`long`	`getUsedNative()` Returns the amount of used native memory in current HazelcastInstance in bytes.
`void`	`setCommittedHeap(long committedHeap)`
`void`	`setCommittedNativeMemory(long committed)`
`void`	`setFreeNativeMemory(long freeNativeMemory)`
`void`	`setFreePhysical(long freePhysical)`
`void`	`setGcStats(LocalGCStats gcStats)`
`void`	`setMaxHeap(long maxHeap)`
`void`	`setMaxMetadata(long maxMetadata)`
`void`	`setMaxNativeMemory(long maxNativeMemory)`
`void`	`setTotalPhysical(long totalPhysical)`
`void`	`setUsedHeap(long usedHeap)`
`void`	`setUsedMetadata(long usedMetadata)`
`void`	`setUsedNativeMemory(long used)`
`JsonObject`	`toJson()` Serializes state represented by this object into a `JsonObject`.
`String`	`toString()`

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

- Field Detail
  - JSON_CREATION_TIME
```
public static final String JSON_CREATION_TIME
```
    See Also:
    
    Constant Field Values
  - JSON_TOTAL_PHYSICAL
```
public static final String JSON_TOTAL_PHYSICAL
```
    See Also:
    
    Constant Field Values
  - JSON_FREE_PHYSICAL
```
public static final String JSON_FREE_PHYSICAL
```
    See Also:
    
    Constant Field Values
  - JSON_MAX_NATIVE_MEMORY
```
public static final String JSON_MAX_NATIVE_MEMORY
```
    See Also:
    
    Constant Field Values
  - JSON_COMMITTED_NATIVE_MEMORY
```
public static final String JSON_COMMITTED_NATIVE_MEMORY
```
    See Also:
    
    Constant Field Values
  - JSON_USED_NATIVE_MEMORY
```
public static final String JSON_USED_NATIVE_MEMORY
```
    See Also:
    
    Constant Field Values
  - JSON_FREE_NATIVE_MEMORY
```
public static final String JSON_FREE_NATIVE_MEMORY
```
    See Also:
    
    Constant Field Values
  - JSON_MAX_HEAP
```
public static final String JSON_MAX_HEAP
```
    See Also:
    
    Constant Field Values
  - JSON_COMMITTED_HEAP
```
public static final String JSON_COMMITTED_HEAP
```
    See Also:
    
    Constant Field Values
  - JSON_USED_HEAP
```
public static final String JSON_USED_HEAP
```
    See Also:
    
    Constant Field Values
  - JSON_GC_STATS
```
public static final String JSON_GC_STATS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LocalMemoryStatsImpl
```
public LocalMemoryStatsImpl()
```
  - LocalMemoryStatsImpl
```
public LocalMemoryStatsImpl(MemoryStats memoryStats)
```
- Method Detail
  - getTotalPhysical
```
public long getTotalPhysical()
```
    Description copied from interface: MemoryStats
    
    Returns total physical memory available in OS.
    
    Specified by:
    
    getTotalPhysical in interface MemoryStats
    
    Returns:
    
    total physical memory in bytes.
  - setTotalPhysical
```
public void setTotalPhysical(long totalPhysical)
```
  - getFreePhysical
```
public long getFreePhysical()
```
    Description copied from interface: MemoryStats
    
    Returns free physical memory available in OS.
    Some operating systems have cached memory regions in which they store hot cached resources like files. Cached memory is used for allocations when required. So although this cached region is assumed as free, operating systems generally report this region as used not free.
    
    Specified by:
    
    getFreePhysical in interface MemoryStats
    
    Returns:
    
    free physical memory in bytes.
  - setFreePhysical
```
public void setFreePhysical(long freePhysical)
```
  - getMaxNative
```
public long getMaxNative()
```
    Description copied from interface: MemoryStats
    
    Returns the maximum amount of native memory that current HazelcastInstance will attempt to use in bytes.
    
    Specified by:
    
    getMaxNative in interface MemoryStats
    
    Returns:
    
    the maximum amount of native memory in bytes.
  - setMaxNativeMemory
```
public void setMaxNativeMemory(long maxNativeMemory)
```
  - getCommittedNative
```
public long getCommittedNative()
```
    Description copied from interface: MemoryStats
    
    Returns the amount of native memory in bytes that is committed for current HazelcastInstance to use.
    
    Specified by:
    
    getCommittedNative in interface MemoryStats
    
    Returns:
    
    the amount of committed native memory in bytes.
  - setCommittedNativeMemory
```
public void setCommittedNativeMemory(long committed)
```
  - getUsedNative
```
public long getUsedNative()
```
    Description copied from interface: MemoryStats
    
    Returns the amount of used native memory in current HazelcastInstance in bytes.
    
    Specified by:
    
    getUsedNative in interface MemoryStats
    
    Returns:
    
    the amount of used native memory in bytes
  - setUsedNativeMemory
```
public void setUsedNativeMemory(long used)
```
  - getFreeNative
```
public long getFreeNative()
```
    Description copied from interface: MemoryStats
    
    Returns the amount of free native memory in current HazelcastInstance in bytes.
    
    Specified by:
    
    getFreeNative in interface MemoryStats
    
    Returns:
    
    the amount of free native memory in bytes
  - setFreeNativeMemory
```
public void setFreeNativeMemory(long freeNativeMemory)
```
  - getMaxMetadata
```
public long getMaxMetadata()
```
    Description copied from interface: MemoryStats
    
    Returns the amount of native memory reserved for metadata. This memory is separate and not accounted for by the ...NativeMemory statistics.
    
    Specified by:
    
    getMaxMetadata in interface MemoryStats
  - setMaxMetadata
```
public void setMaxMetadata(long maxMetadata)
```
  - getUsedMetadata
```
public long getUsedMetadata()
```
    Specified by:
    
    getUsedMetadata in interface MemoryStats
    
    Returns:
    
    amount of used metadata memory
  - setUsedMetadata
```
public void setUsedMetadata(long usedMetadata)
```
  - getMaxHeap
```
public long getMaxHeap()
```
    Description copied from interface: MemoryStats
    
    Returns the maximum amount of memory that the JVM will attempt to use in bytes.
    
    Specified by:
    
    getMaxHeap in interface MemoryStats
    
    Returns:
    
    the maximum amount of memory in bytes.
    
    See Also:
    
    Runtime.maxMemory()
  - getCommittedHeap
```
public long getCommittedHeap()
```
    Description copied from interface: MemoryStats
    
    Returns the amount of memory in bytes that is committed for the Java virtual machine to use.
    
    Specified by:
    
    getCommittedHeap in interface MemoryStats
    
    Returns:
    
    the amount of committed memory in bytes.
    
    See Also:
    
    Runtime.totalMemory(), MemoryUsage.getCommitted()
  - getUsedHeap
```
public long getUsedHeap()
```
    Description copied from interface: MemoryStats
    
    Returns the amount of used memory in the JVM in bytes.
    
    Specified by:
    
    getUsedHeap in interface MemoryStats
    
    Returns:
    
    the amount of used memory in bytes
    
    See Also:
    
    MemoryUsage.getUsed()
  - setMaxHeap
```
public void setMaxHeap(long maxHeap)
```
  - setCommittedHeap
```
public void setCommittedHeap(long committedHeap)
```
  - setUsedHeap
```
public void setUsedHeap(long usedHeap)
```
  - getFreeHeap
```
public long getFreeHeap()
```
    Description copied from interface: MemoryStats
    
    Returns the amount of free memory in the JVM in bytes.
    
    Specified by:
    
    getFreeHeap in interface MemoryStats
    
    Returns:
    
    the amount of free memory in bytes
    
    See Also:
    
    Runtime.freeMemory()
  - getGCStats
```
public LocalGCStats getGCStats()
```
    Description copied from interface: MemoryStats
    
    Returns the garbage collector statistics for the JVM
    
    Specified by:
    
    getGCStats in interface MemoryStats
    
    Specified by:
    
    getGCStats in interface LocalMemoryStats
    
    Returns:
    
    GC statistics
  - setGcStats
```
public void setGcStats(LocalGCStats gcStats)
```
  - getCreationTime
```
public long getCreationTime()
```
    Description copied from interface: LocalInstanceStats
    
    Returns the creation time of this distributed object instance on this member.
    
    Specified by:
    
    getCreationTime in interface LocalInstanceStats
  - toJson
```
public JsonObject toJson()
```
    Description copied from interface: JsonSerializable
    
    Serializes state represented by this object into a JsonObject.
    
    Specified by:
    
    toJson in interface JsonSerializable
    
    Returns:
    
    the JSON representation of this object
  - fromJson
```
public void fromJson(JsonObject json)
```
    Description copied from interface: JsonSerializable
    
    Extracts the state from the given json object and mutates the state of this object.
    
    Specified by:
    
    fromJson in interface JsonSerializable
    
    Parameters:
    
    json - the JSON object carrying state for this object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class LocalMemoryStatsImpl

Field Summary

Fields inherited from interface com.hazelcast.monitor.LocalInstanceStats

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_CREATION_TIME

JSON_TOTAL_PHYSICAL

JSON_FREE_PHYSICAL

JSON_MAX_NATIVE_MEMORY

JSON_COMMITTED_NATIVE_MEMORY

JSON_USED_NATIVE_MEMORY

JSON_FREE_NATIVE_MEMORY

JSON_MAX_HEAP

JSON_COMMITTED_HEAP

JSON_USED_HEAP

JSON_GC_STATS

Constructor Detail

LocalMemoryStatsImpl

LocalMemoryStatsImpl

Method Detail

getTotalPhysical

setTotalPhysical

getFreePhysical

setFreePhysical

getMaxNative

setMaxNativeMemory

getCommittedNative

setCommittedNativeMemory

getUsedNative

setUsedNativeMemory

getFreeNative

setFreeNativeMemory

getMaxMetadata

setMaxMetadata

getUsedMetadata

setUsedMetadata

getMaxHeap

getCommittedHeap

getUsedHeap

setMaxHeap

setCommittedHeap

setUsedHeap

getFreeHeap

getGCStats

setGcStats

getCreationTime

toJson

fromJson

toString