Package org.symbol.sdk.symbol.descriptors

Class AccountMetadataTransactionV1Descriptor

java.lang.Object

org.symbol.sdk.symbol.descriptors.AccountMetadataTransactionV1Descriptor

All Implemented Interfaces:

SymbolTransactionDescriptor, SymbolTypedDescriptor, TypedDescriptor

---

public final class AccountMetadataTransactionV1Descriptor extends Object implements SymbolTransactionDescriptor

AccountMetadataTransactionV1Descriptor

Type safe descriptor used to generate a descriptor map for AccountMetadataTransactionV1Descriptor. Associate a key-value state ([metadata](/concepts/metadata.html)) to an **account** (V1, latest). \note This transaction must **always** be wrapped in an AggregateTransaction so that a cosignature from `target_address` can be provided. Without this cosignature the transaction is invalid. Compare to MosaicMetadataTransaction and NamespaceMetadataTransaction.

• Constructor Summary

  Constructors

  Constructor

  Description

  AccountMetadataTransactionV1Descriptor(String targetAddress, long scopedMetadataKey, int valueSizeDelta)

  Creates a descriptor for AccountMetadataTransactionV1 from string-form values.

  AccountMetadataTransactionV1Descriptor(Address targetAddress, long scopedMetadataKey, int valueSizeDelta)

  Creates a descriptor for AccountMetadataTransactionV1.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  Map<String,Object>

  toMap()

  Builds a representation of this descriptor that can be passed to a factory function.

  AccountMetadataTransactionV1Descriptor

  value(byte[] value)

  Sets the value field.

  AccountMetadataTransactionV1Descriptor

  value(String value)

  Sets the value field.

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • AccountMetadataTransactionV1Descriptor

    public AccountMetadataTransactionV1Descriptor(Address targetAddress, long scopedMetadataKey, int valueSizeDelta)

    Creates a descriptor for AccountMetadataTransactionV1.

    Parameters:

    targetAddress - Account whose metadata should be modified.

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

    valueSizeDelta - Change in value size in bytes, compared to previous size.

  • AccountMetadataTransactionV1Descriptor

    public AccountMetadataTransactionV1Descriptor(String targetAddress, long scopedMetadataKey, int valueSizeDelta)

    Creates a descriptor for AccountMetadataTransactionV1 from string-form values.

    Parameters:

    targetAddress - Account whose metadata should be modified.

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

    valueSizeDelta - Change in value size in bytes, compared to previous size.

• Method Details

  • value

    public AccountMetadataTransactionV1Descriptor value(byte[] value)

    AccountMetadataTransactionV1Descriptor.value

    Sets the value field.

    Parameters:

    value - Difference between existing value and new value. \note When there is no existing value, this array is directly used and `value_size_delta`==`value_size`. \note When there is an existing value, the new value is the byte-wise XOR of the previous value and this array.

    Returns:

    This descriptor for chaining.

  • value

    public AccountMetadataTransactionV1Descriptor value(String value)

    AccountMetadataTransactionV1Descriptor.value

    Sets the value field.

    Parameters:

    value - Difference between existing value and new value. \note When there is no existing value, this array is directly used and `value_size_delta`==`value_size`. \note When there is an existing value, the new value is the byte-wise XOR of the previous value and this array.

    Returns:

    This descriptor for chaining.

  • toMap

    public Map<String,Object> toMap()

    AccountMetadataTransactionV1Descriptor.toMap

    Builds a representation of this descriptor that can be passed to a factory function.

    Specified by:

    toMap in interface TypedDescriptor

    Returns:

    Descriptor map that can be passed to a transaction factory.