SerializationUtils (symbol-sdk-java 1.0.1 API)

java.lang.Object
- io.nem.symbol.sdk.infrastructure.SerializationUtils

```
public class SerializationUtils
extends java.lang.Object
```
Utility class used to serialize/deserialize catbuffer values.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`byteToUnsignedInt(byte value)` It converts a signed byte to a positive integer.
`static byte[]`	`concat(byte[] commonBytes, byte[] transactionBytes)` It concats the 2 byte arrays patching the int size at the beginning of the first byte array setting up the sum of both lengths.
`static java.nio.ByteBuffer`	`fromAddressToByteBuffer(Address resolvedAddress)` It serializes an resolved `Address` into a `ByteBuffer`
`static java.nio.ByteBuffer`	`fromUnresolvedAddressToByteBuffer(UnresolvedAddress unresolvedAddress, NetworkType networkType)` It serializes a `UnresolvedAddress` to an hex catbuffer understand.
`static java.util.EnumSet<io.nem.symbol.catapult.builders.MosaicFlagsDto>`	`getMosaicFlagsEnumSet(MosaicFlags flags)` Get the mosaic flags.
`static long`	`intToUnsignedLong(int value)` It converts a signed int to a positive long.
`static int`	`shortToUnsignedInt(short value)` It converts a signed short to a positive integer.
`static Address`	`toAddress(io.nem.symbol.catapult.builders.AddressDto dto)` It creates a `Address` from an `AddressDto`.
`static io.nem.symbol.catapult.builders.AddressDto`	`toAddressDto(Address resolvedAddress)` It serializes an resolved `Address` into a `ByteBuffer`
`static io.nem.symbol.catapult.builders.AmountDto`	`toAmount(java.math.BigInteger amount)` Converts an amount to a catbuffer `AmountDto`
`static java.nio.ByteBuffer`	`toByteBuffer(PublicAccount publicAccount)` It serializes the public key of a public account.
`static java.io.DataInputStream`	`toDataInput(byte[] payload)` It creates a `DataInputStream` from a binary payload.
`static io.nem.symbol.catapult.builders.FinalizationEpochDto`	`toFinalizationEpochDto(long finalizationEpoch)`
`static io.nem.symbol.catapult.builders.Hash256Dto`	`toHash256Dto(java.lang.String hash)` It creates a catbuffer Hash256Dto from a String hash.
`static java.lang.String`	`toHexString(java.nio.ByteBuffer buffer)` It extracts the hex string from the `ByteBuffer`
`static java.lang.String`	`toHexString(io.nem.symbol.catapult.builders.Hash256Dto dto)` It extracts the hex string from the `Hash256Dto`
`static io.nem.symbol.catapult.builders.KeyDto`	`toKeyDto(PublicKey publicKey)` It creates a catbuffer KeyDto from a `PublicKey`.
`static Mosaic`	`toMosaic(io.nem.symbol.catapult.builders.UnresolvedMosaicBuilder builder)` It creates a Mosaic from an `UnresolvedMosaicBuilder`.
`static java.util.List<io.nem.symbol.catapult.builders.MosaicBuilder>`	`toMosaicBuilders(java.util.List<ResolvedMosaic> mosaics)` Converts resolved mosaic list to mosaic builder list to serialize
`static MosaicId`	`toMosaicId(io.nem.symbol.catapult.builders.MosaicIdDto dto)` It creates a `MosaicId` from an `MosaicIdDto`.
`static io.nem.symbol.catapult.builders.MosaicIdDto`	`toMosaicIdDto(MosaicId mosaicId)` Converts an a model `MosaicId` into an `MosaicIdDto` from catbuffer.
`static NamespaceId`	`toNamespaceId(io.nem.symbol.catapult.builders.NamespaceIdDto dto)` It creates a `NamespaceId` from an `NamespaceIdDto`.
`static PublicAccount`	`toPublicAccount(io.nem.symbol.catapult.builders.KeyDto keyDto, NetworkType networkType)` It creates a PublicAccount from a `KeyDto`.
`static PublicKey`	`toPublicKey(io.nem.symbol.catapult.builders.KeyDto dto)` It creates a catbuffer `PublicKey` from a `KeyDto`.
`static io.nem.symbol.catapult.builders.SignatureDto`	`toSignatureDto(java.lang.String signature)` It serializes the string signature into a SignatureDto catbuffer understands
`static java.lang.String`	`toString(java.nio.ByteBuffer buffer)` It extracts an UTF-8 string from the `ByteBuffer`
`static UnresolvedAddress`	`toUnresolvedAddress(io.nem.symbol.catapult.builders.UnresolvedAddressDto dto)` It creates a `UnresolvedAddress` from an `UnresolvedAddressDto`.
`static io.nem.symbol.catapult.builders.UnresolvedAddressDto`	`toUnresolvedAddress(UnresolvedAddress unresolvedAddress, NetworkType networkType)` It creates a `UnresolvedAddressDto` from an `UnresolvedAddress`.
`static UnresolvedMosaicId`	`toUnresolvedMosaicId(io.nem.symbol.catapult.builders.UnresolvedMosaicIdDto dto)` It creates a `UnresolvedMosaicId` from an `UnresolvedMosaicIdDto`.
`static io.nem.symbol.catapult.builders.UnresolvedMosaicIdDto`	`toUnresolvedMosaicIdDto(UnresolvedMosaicId mosaicId)` Converts an a model `UnresolvedMosaicId` into an `UnresolvedMosaicIdDto` from catbuffer.
`static java.math.BigInteger`	`toUnsignedBigInteger(io.nem.symbol.catapult.builders.AmountDto amountDto)` It converts an AmountDto into a positive `BigInteger`.
`static java.math.BigInteger`	`toUnsignedBigInteger(long value)` It converts a signed long to a positive integer.
`static long`	`toUnsignedLong(java.math.BigInteger number)` Converts and valida a big integer value to "unsigned long".
`static VotingKey`	`toVotingKey(io.nem.symbol.catapult.builders.VotingKeyDto votingKeyDto)` It creates a `VotingKey` from the DTO
`static io.nem.symbol.catapult.builders.VotingKeyDto`	`toVotingKeyDto(java.lang.String key)` It creates a catbuffer VotingKeyDto from a `VotingKey`.
`static io.nem.symbol.catapult.builders.VotingKeyDto`	`toVotingKeyDto(VotingKey key)` It creates a catbuffer VotingKeyDto from a `VotingKey`.

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

- Method Detail
  - toPublicAccount
```
public static PublicAccount toPublicAccount(io.nem.symbol.catapult.builders.KeyDto keyDto,
                                            NetworkType networkType)
```
    It creates a PublicAccount from a KeyDto.
    
    Parameters:
    
    keyDto - catbuffer KeyDto.
    
    networkType - the network type
    
    Returns:
    
    the model PublicAccount
  - toMosaic
```
public static Mosaic toMosaic(io.nem.symbol.catapult.builders.UnresolvedMosaicBuilder builder)
```
    It creates a Mosaic from an UnresolvedMosaicBuilder.
    
    Parameters:
    
    builder - the catbuffer UnresolvedMosaicBuilder.
    
    Returns:
    
    the model Mosaic
  - toUnresolvedMosaicId
```
public static UnresolvedMosaicId toUnresolvedMosaicId(io.nem.symbol.catapult.builders.UnresolvedMosaicIdDto dto)
```
    It creates a UnresolvedMosaicId from an UnresolvedMosaicIdDto.
    
    Parameters:
    
    dto - the catbuffer UnresolvedMosaicIdDto.
    
    Returns:
    
    the model UnresolvedMosaicId
  - toMosaicId
```
public static MosaicId toMosaicId(io.nem.symbol.catapult.builders.MosaicIdDto dto)
```
    It creates a MosaicId from an MosaicIdDto.
    
    Parameters:
    
    dto - the catbuffer MosaicIdDto.
    
    Returns:
    
    the model MosaicId
  - toNamespaceId
```
public static NamespaceId toNamespaceId(io.nem.symbol.catapult.builders.NamespaceIdDto dto)
```
    It creates a NamespaceId from an NamespaceIdDto.
    
    Parameters:
    
    dto - the catbuffer NamespaceIdDto.
    
    Returns:
    
    the model NamespaceId
  - fromUnresolvedAddressToByteBuffer
```
public static java.nio.ByteBuffer fromUnresolvedAddressToByteBuffer(UnresolvedAddress unresolvedAddress,
                                                                    NetworkType networkType)
```
    It serializes a UnresolvedAddress to an hex catbuffer understand.
    
    Parameters:
    
    unresolvedAddress - the Address or NamespaceId to be serialized.
    
    networkType - the network type to customize the NamespaceId serialization
    
    Returns:
    
    the serialized UnresolvedAddress as ByteBuffer.
  - fromAddressToByteBuffer
```
public static java.nio.ByteBuffer fromAddressToByteBuffer(Address resolvedAddress)
```
    It serializes an resolved Address into a ByteBuffer
    
    Parameters:
    
    resolvedAddress - the resolved address
    
    Returns:
    
    the serialized ByteBuffer
  - toAddressDto
```
public static io.nem.symbol.catapult.builders.AddressDto toAddressDto(Address resolvedAddress)
```
    It serializes an resolved Address into a ByteBuffer
    
    Parameters:
    
    resolvedAddress - the resolved address
    
    Returns:
    
    the serialized ByteBuffer
  - toAddress
```
public static Address toAddress(io.nem.symbol.catapult.builders.AddressDto dto)
```
    It creates a Address from an AddressDto.
    
    Parameters:
    
    dto - the catbuffer AddressDto.
    
    Returns:
    
    the model Address
  - toUnresolvedAddress
```
public static io.nem.symbol.catapult.builders.UnresolvedAddressDto toUnresolvedAddress(UnresolvedAddress unresolvedAddress,
                                                                                       NetworkType networkType)
```
    It creates a UnresolvedAddressDto from an UnresolvedAddress.
    
    Parameters:
    
    unresolvedAddress - the catbuffer UnresolvedAddressDto.
    
    networkType - the network type serialized in the payload.
    
    Returns:
    
    the dto UnresolvedAddressDto
  - toUnresolvedAddress
```
public static UnresolvedAddress toUnresolvedAddress(io.nem.symbol.catapult.builders.UnresolvedAddressDto dto)
```
    It creates a UnresolvedAddress from an UnresolvedAddressDto.
    
    Parameters:
    
    dto - the catbuffer UnresolvedAddressDto.
    
    Returns:
    
    the model UnresolvedAddress
  - byteToUnsignedInt
```
public static int byteToUnsignedInt(byte value)
```
    It converts a signed byte to a positive integer.
    
    Parameters:
    
    value - the byte, it can be a overflowed negative byte.
    
    Returns:
    
    the positive integer.
  - shortToUnsignedInt
```
public static int shortToUnsignedInt(short value)
```
    It converts a signed short to a positive integer.
    
    Parameters:
    
    value - the short, it can be a overflowed negative short.
    
    Returns:
    
    the positive integer.
  - intToUnsignedLong
```
public static long intToUnsignedLong(int value)
```
    It converts a signed int to a positive long.
    
    Parameters:
    
    value - the int, it can be a overflowed negative int.
    
    Returns:
    
    the positive long.
  - toDataInput
```
public static java.io.DataInputStream toDataInput(byte[] payload)
```
    It creates a DataInputStream from a binary payload.
    
    Parameters:
    
    payload - the payload
    
    Returns:
    
    the DataInputStream catbuffer uses.
  - toUnsignedBigInteger
```
public static java.math.BigInteger toUnsignedBigInteger(io.nem.symbol.catapult.builders.AmountDto amountDto)
```
    It converts an AmountDto into a positive BigInteger.
    
    Parameters:
    
    amountDto - the catbuffer AmountDto
    
    Returns:
    
    the positive BigInteger.
  - toUnsignedBigInteger
```
public static java.math.BigInteger toUnsignedBigInteger(long value)
```
    It converts a signed long to a positive integer.
    
    Parameters:
    
    value - the short, it can be a overflowed negative long.
    
    Returns:
    
    the positive integer.
  - toHexString
```
public static java.lang.String toHexString(io.nem.symbol.catapult.builders.Hash256Dto dto)
```
    It extracts the hex string from the Hash256Dto
    
    Parameters:
    
    dto - the Hash256Dto
    
    Returns:
    
    the hex string.
  - toUnsignedLong
```
public static long toUnsignedLong(java.math.BigInteger number)
```
    Converts and valida a big integer value to "unsigned long".
    
    Parameters:
    
    number - The input string.
    
    Returns:
    
    the long.
  - toHexString
```
public static java.lang.String toHexString(java.nio.ByteBuffer buffer)
```
    It extracts the hex string from the ByteBuffer
    
    Parameters:
    
    buffer - the ByteBuffer
    
    Returns:
    
    the hex string.
  - toString
```
public static java.lang.String toString(java.nio.ByteBuffer buffer)
```
    It extracts an UTF-8 string from the ByteBuffer
    
    Parameters:
    
    buffer - the ByteBuffer
    
    Returns:
    
    the UTF-8 string.
  - concat
```
public static byte[] concat(byte[] commonBytes,
                            byte[] transactionBytes)
```
    It concats the 2 byte arrays patching the int size at the beginning of the first byte array setting up the sum of both lengths.
    
    Parameters:
    
    commonBytes - the common transaction byte array
    
    transactionBytes - the specific transaction byte array.
    
    Returns:
    
    the concated byte array.
  - toByteBuffer
```
public static java.nio.ByteBuffer toByteBuffer(PublicAccount publicAccount)
```
    It serializes the public key of a public account.
    
    Parameters:
    
    publicAccount - to be serialized.
    
    Returns:
    
    the public account
  - toSignatureDto
```
public static io.nem.symbol.catapult.builders.SignatureDto toSignatureDto(java.lang.String signature)
```
    It serializes the string signature into a SignatureDto catbuffer understands
    
    Parameters:
    
    signature - the signature string
    
    Returns:
    
    SignatureDto.
  - toKeyDto
```
public static io.nem.symbol.catapult.builders.KeyDto toKeyDto(PublicKey publicKey)
```
    It creates a catbuffer KeyDto from a PublicKey.
    
    Parameters:
    
    publicKey - the public key.
    
    Returns:
    
    the keyDto
  - toPublicKey
```
public static PublicKey toPublicKey(io.nem.symbol.catapult.builders.KeyDto dto)
```
    It creates a catbuffer PublicKey from a KeyDto.
    
    Parameters:
    
    dto - the public key.
    
    Returns:
    
    the PublicKey
  - toVotingKey
```
public static VotingKey toVotingKey(io.nem.symbol.catapult.builders.VotingKeyDto votingKeyDto)
```
    It creates a VotingKey from the DTO
    
    Parameters:
    
    votingKeyDto - the dto
    
    Returns:
    
    the VotingKey
  - toVotingKeyDto
```
public static io.nem.symbol.catapult.builders.VotingKeyDto toVotingKeyDto(VotingKey key)
```
    It creates a catbuffer VotingKeyDto from a VotingKey.
    
    Parameters:
    
    key - the voting key.
    
    Returns:
    
    the VotingKeyDto
  - toVotingKeyDto
```
public static io.nem.symbol.catapult.builders.VotingKeyDto toVotingKeyDto(java.lang.String key)
```
    It creates a catbuffer VotingKeyDto from a VotingKey.
    
    Parameters:
    
    key - the voting key.
    
    Returns:
    
    the VotingKeyDto
  - toHash256Dto
```
public static io.nem.symbol.catapult.builders.Hash256Dto toHash256Dto(java.lang.String hash)
```
    It creates a catbuffer Hash256Dto from a String hash.
    
    Parameters:
    
    hash - the hash
    
    Returns:
    
    the Hash256Dto
  - toUnresolvedMosaicIdDto
```
public static io.nem.symbol.catapult.builders.UnresolvedMosaicIdDto toUnresolvedMosaicIdDto(UnresolvedMosaicId mosaicId)
```
    Converts an a model UnresolvedMosaicId into an UnresolvedMosaicIdDto from catbuffer.
    
    Parameters:
    
    mosaicId - the model
    
    Returns:
    
    the dto
  - toMosaicIdDto
```
public static io.nem.symbol.catapult.builders.MosaicIdDto toMosaicIdDto(MosaicId mosaicId)
```
    Converts an a model MosaicId into an MosaicIdDto from catbuffer.
    
    Parameters:
    
    mosaicId - the model
    
    Returns:
    
    the dto
  - toFinalizationEpochDto
```
public static io.nem.symbol.catapult.builders.FinalizationEpochDto toFinalizationEpochDto(long finalizationEpoch)
```
    Parameters:
    
    finalizationEpoch - the unit 32 long finalization epoch
    
    Returns:
    
    a new FinalizationEpochDto from the unit 32.
  - toMosaicBuilders
```
public static java.util.List<io.nem.symbol.catapult.builders.MosaicBuilder> toMosaicBuilders(java.util.List<ResolvedMosaic> mosaics)
```
    Converts resolved mosaic list to mosaic builder list to serialize
    
    Parameters:
    
    mosaics - the mosaics
    
    Returns:
    
    the list of catbuffers.
  - toAmount
```
public static io.nem.symbol.catapult.builders.AmountDto toAmount(java.math.BigInteger amount)
```
    Converts an amount to a catbuffer AmountDto
    
    Parameters:
    
    amount - the big int amount
    
    Returns:
    
    the dto.
  - getMosaicFlagsEnumSet
```
public static java.util.EnumSet<io.nem.symbol.catapult.builders.MosaicFlagsDto> getMosaicFlagsEnumSet(MosaicFlags flags)
```
    Get the mosaic flags.
    
    Returns:
    
    Mosaic flags

Class SerializationUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toPublicAccount

toMosaic

toUnresolvedMosaicId

toMosaicId

toNamespaceId

fromUnresolvedAddressToByteBuffer

fromAddressToByteBuffer

toAddressDto

toAddress

toUnresolvedAddress

toUnresolvedAddress

byteToUnsignedInt

shortToUnsignedInt

intToUnsignedLong

toDataInput

toUnsignedBigInteger

toUnsignedBigInteger

toHexString

toUnsignedLong

toHexString

toString

concat

toByteBuffer

toSignatureDto

toKeyDto

toPublicKey

toVotingKey

toVotingKeyDto

toVotingKeyDto

toHash256Dto

toUnresolvedMosaicIdDto

toMosaicIdDto

toFinalizationEpochDto

toMosaicBuilders

toAmount

getMosaicFlagsEnumSet