Package io.nem.symbol.catapult.builders

Class MetadataEntryBuilder

java.lang.Object

io.nem.symbol.catapult.builders.StateHeaderBuilder

io.nem.symbol.catapult.builders.MetadataEntryBuilder

All Implemented Interfaces:

Serializer

public class MetadataEntryBuilder
extends StateHeaderBuilder
implements Serializer

Binary layout of a metadata entry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataEntryBuilder(short version, AddressDto sourceAddress, AddressDto targetAddress, ScopedMetadataKeyDto scopedMetadataKey, long targetId, MetadataTypeDto metadataType, MetadataValueBuilder value)	Constructor.
protected	MetadataEntryBuilder(java.io.DataInputStream stream)	Constructor - Creates an object from stream.

Method Summary

Modifier and Type	Method	Description
static MetadataEntryBuilder	create(short version, AddressDto sourceAddress, AddressDto targetAddress, ScopedMetadataKeyDto scopedMetadataKey, long targetId, MetadataTypeDto metadataType, MetadataValueBuilder value)	Creates an instance of MetadataEntryBuilder.
MetadataTypeDto	getMetadataType()	Gets metadata type.
ScopedMetadataKeyDto	getScopedMetadataKey()	Gets metadata key scoped to source, target and type.
int	getSize()	Gets the size of the object.
AddressDto	getSourceAddress()	Gets metadata source address (provider).
AddressDto	getTargetAddress()	Gets metadata target address.
long	getTargetId()	Gets target id.
MetadataValueBuilder	getValue()	Gets value.
static MetadataEntryBuilder	loadFromBinary(java.io.DataInputStream stream)	Creates an instance of MetadataEntryBuilder from a stream.
byte[]	serialize()	Serializes an object to bytes.

Methods inherited from class io.nem.symbol.catapult.builders.StateHeaderBuilder

create, getVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataEntryBuilder

protected MetadataEntryBuilder(java.io.DataInputStream stream)

Constructor - Creates an object from stream.

Parameters:

stream - Byte stream to use to serialize the object.

MetadataEntryBuilder

protected MetadataEntryBuilder(short version,
                               AddressDto sourceAddress,
                               AddressDto targetAddress,
                               ScopedMetadataKeyDto scopedMetadataKey,
                               long targetId,
                               MetadataTypeDto metadataType,
                               MetadataValueBuilder value)

Constructor.

Parameters:

version - Serialization version.

sourceAddress - Metadata source address (provider).

targetAddress - Metadata target address.

scopedMetadataKey - Metadata key scoped to source, target and type.

targetId - Target id.

metadataType - Metadata type.

value - Value.

Method Detail

loadFromBinary

public static MetadataEntryBuilder loadFromBinary(java.io.DataInputStream stream)

Creates an instance of MetadataEntryBuilder from a stream.

Parameters:

stream - Byte stream to use to serialize the object.

Returns:

Instance of MetadataEntryBuilder.

create

public static MetadataEntryBuilder create(short version,
                                          AddressDto sourceAddress,
                                          AddressDto targetAddress,
                                          ScopedMetadataKeyDto scopedMetadataKey,
                                          long targetId,
                                          MetadataTypeDto metadataType,
                                          MetadataValueBuilder value)

Creates an instance of MetadataEntryBuilder.

Parameters:

version - Serialization version.

sourceAddress - Metadata source address (provider).

targetAddress - Metadata target address.

scopedMetadataKey - Metadata key scoped to source, target and type.

targetId - Target id.

metadataType - Metadata type.

value - Value.

Returns:

Instance of MetadataEntryBuilder.

getSourceAddress

public AddressDto getSourceAddress()

Gets metadata source address (provider).

Returns:

Metadata source address (provider).

getTargetAddress

public AddressDto getTargetAddress()

Gets metadata target address.

Returns:

Metadata target address.

getScopedMetadataKey

public ScopedMetadataKeyDto getScopedMetadataKey()

Gets metadata key scoped to source, target and type.

Returns:

Metadata key scoped to source, target and type.

getTargetId

public long getTargetId()

Gets target id.

Returns:

Target id.

getMetadataType

public MetadataTypeDto getMetadataType()

Gets metadata type.

Returns:

Metadata type.

getValue

public MetadataValueBuilder getValue()

Gets value.

Returns:

Value.

getSize

public int getSize()

Gets the size of the object.

Specified by:

getSize in interface Serializer

Overrides:

getSize in class StateHeaderBuilder

Returns:

Size in bytes.

serialize

public byte[] serialize()

Serializes an object to bytes.

Specified by:

serialize in interface Serializer

Overrides:

serialize in class StateHeaderBuilder

Returns:

Serialized bytes.