HeapData (Hazelcast Root 3.12.13 API)

java.lang.Object
- com.hazelcast.internal.serialization.impl.HeapData

All Implemented Interfaces:

Data

Direct Known Subclasses:

Packet
```
public class HeapData
extends Object
implements Data
```
A Data implementation where the content lives on the heap.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DATA_OFFSET`
`static int`	`HEAP_DATA_OVERHEAD`
`static int`	`PARTITION_HASH_OFFSET`
`protected byte[]`	`payload`
`static int`	`TYPE_OFFSET`

Constructor Summary

Constructors
Constructor and Description

HeapData()

HeapData(byte[] payload)

Constructors
Constructor and Description
`HeapData()`
`HeapData(byte[] payload)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copyTo(byte[] dest, int destPos)` Copies the payload contained in the Data to the destination buffer.
`int`	`dataSize()` Returns size of internal binary data in bytes
`boolean`	`equals(Object o)`
`int`	`getHeapCost()` Returns approximate heap cost of this Data object in bytes.
`int`	`getPartitionHash()` Returns partition hash calculated for serialized object.
`int`	`getType()` Returns serialization type of binary form.
`long`	`hash64()` Returns 64-bit hash code for this Data object.
`int`	`hashCode()`
`boolean`	`hasPartitionHash()` Returns true if Data has partition hash, false otherwise.
`boolean`	`isJson()` Returns true if this Data is created from a `HazelcastJsonValue` object, false otherwise
`boolean`	`isPortable()` Returns true if this Data is created from a `Portable` object, false otherwise.
`byte[]`	`toByteArray()` Returns byte array representation of internal binary format.
`String`	`toString()`
`int`	`totalSize()` Returns the total size of Data in bytes.

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

- Field Detail
  - PARTITION_HASH_OFFSET
```
public static final int PARTITION_HASH_OFFSET
```
    See Also:
    
    Constant Field Values
  - TYPE_OFFSET
```
public static final int TYPE_OFFSET
```
    See Also:
    
    Constant Field Values
  - DATA_OFFSET
```
public static final int DATA_OFFSET
```
    See Also:
    
    Constant Field Values
  - HEAP_DATA_OVERHEAD
```
public static final int HEAP_DATA_OVERHEAD
```
    See Also:
    
    Constant Field Values
  - payload
```
protected byte[] payload
```
- Constructor Detail
  - HeapData
```
public HeapData()
```
  - HeapData
```
public HeapData(byte[] payload)
```
- Method Detail
  - dataSize
```
public int dataSize()
```
    Description copied from interface: Data
    
    Returns size of internal binary data in bytes
    
    Specified by:
    
    dataSize in interface Data
    
    Returns:
    
    internal data size
  - totalSize
```
public int totalSize()
```
    Description copied from interface: Data
    
    Returns the total size of Data in bytes. The total size is the size of a byte array to contain the full content of this data object. For example in case of an HeapData object, the total size will be the length of the payload.
    
    Specified by:
    
    totalSize in interface Data
    
    Returns:
    
    total size
  - copyTo
```
public void copyTo(byte[] dest,
                   int destPos)
```
    Description copied from interface: Data
    
    Copies the payload contained in the Data to the destination buffer. The dest byte-buffer needs to be large enough to contain the payload. Otherwise an exception is thrown. The reason this method exists instead of relying on the Data.toByteArray() is the existence of the NativeMemoryData. With the NativeMemoryData it would lead to a temporary byte-array. This method prevents this temporary byte-array needing to be created.
    
    Specified by:
    
    copyTo in interface Data
    
    Parameters:
    
    dest - to byte-buffer to write to
    
    destPos - the position in the destination buffer.
  - getPartitionHash
```
public int getPartitionHash()
```
    Description copied from interface: Data
    
    Returns partition hash calculated for serialized object. Partition hash is used to determine partition of a Data and is calculated using PartitioningStrategy during serialization.
    If partition hash is not set then standard hashCode() is used.
    
    Specified by:
    
    getPartitionHash in interface Data
    
    Returns:
    
    partition hash
    
    See Also:
    
    PartitionAware, PartitioningStrategy, SerializationService.toData(Object, com.hazelcast.core.PartitioningStrategy)
  - hasPartitionHash
```
public boolean hasPartitionHash()
```
    Description copied from interface: Data
    
    Returns true if Data has partition hash, false otherwise.
    
    Specified by:
    
    hasPartitionHash in interface Data
    
    Returns:
    
    true if Data has partition hash, false otherwise.
  - toByteArray
```
public byte[] toByteArray()
```
    Description copied from interface: Data
    
    Returns byte array representation of internal binary format.
    
    Specified by:
    
    toByteArray in interface Data
    
    Returns:
    
    binary data
  - getType
```
public int getType()
```
    Description copied from interface: Data
    
    Returns serialization type of binary form. It's defined by Serializer.getTypeId()
    
    Specified by:
    
    getType in interface Data
    
    Returns:
    
    serializer type ID
  - getHeapCost
```
public int getHeapCost()
```
    Description copied from interface: Data
    
    Returns approximate heap cost of this Data object in bytes.
    
    Specified by:
    
    getHeapCost in interface Data
    
    Returns:
    
    approximate heap cost
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - hash64
```
public long hash64()
```
    Description copied from interface: Data
    
    Returns 64-bit hash code for this Data object.
    
    Specified by:
    
    hash64 in interface Data
    
    Returns:
    
    64-bit hash code
  - isPortable
```
public boolean isPortable()
```
    Description copied from interface: Data
    
    Returns true if this Data is created from a Portable object, false otherwise.
    
    Specified by:
    
    isPortable in interface Data
    
    Returns:
    
    true if source object is Portable, false otherwise.
  - isJson
```
public boolean isJson()
```
    Description copied from interface: Data
    
    Returns true if this Data is created from a HazelcastJsonValue object, false otherwise
    
    Specified by:
    
    isJson in interface Data
    
    Returns:
    
    true if source object is HazelcastJsonValue, false otherwise.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HeapData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARTITION_HASH_OFFSET

TYPE_OFFSET

DATA_OFFSET

HEAP_DATA_OVERHEAD

payload

Constructor Detail

HeapData

HeapData

Method Detail

dataSize

totalSize

copyTo

getPartitionHash

hasPartitionHash

toByteArray

getType

getHeapCost

equals

hashCode

hash64

isPortable

isJson

toString