All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.nem.sdk.model.metadata.MetadataEntry Maven / Gradle / Ivy

The newest version!
/*
 * Copyright 2019 NEM
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.nem.sdk.model.metadata;

import io.nem.core.utils.MapperUtils;
import java.math.BigInteger;
import java.util.Optional;

/**
 * A mosaic describes an instance of a mosaic definition. Mosaics can be transferred by means of a
 * transfer transaction.
 */
public class MetadataEntry {

    /**
     * The composite hash
     */
    private final String compositeHash;
    /**
     * The metadata sender's public key
     */
    private final String senderPublicKey;

    /**
     * The metadata target public key
     */
    private final String targetPublicKey;

    /**
     * The key scoped to source, target and type
     */
    private final BigInteger scopedMetadataKey;

    /**
     * The metadata type
     */
    private final MetadataType metadataType;

    /**
     * The metadata value
     */
    private final String value;

    /**
     * The target {@link io.nem.sdk.model.mosaic.MosaicId} (when metadata type is MOSAIC)
     *
     * or
     *
     * {@link io.nem.sdk.model.namespace.NamespaceId} (when metadata type is NAMESPACE)
     */
    private final Optional targetId;

    @SuppressWarnings("squid:S00107")
    public MetadataEntry(String compositeHash, String senderPublicKey, String targetPublicKey,
        BigInteger scopedMetadataKey, MetadataType metadataType,
        String value, Optional targetId) {
        this.compositeHash = compositeHash;
        this.senderPublicKey = senderPublicKey;
        this.targetPublicKey = targetPublicKey;
        this.scopedMetadataKey = scopedMetadataKey;
        this.metadataType = metadataType;
        this.value = value;
        this.targetId = resolveTargetId(targetId, metadataType);
    }

    private Optional resolveTargetId(Optional targetId,
        MetadataType metadataType) {
        if (!targetId.isPresent() && metadataType == MetadataType.ACCOUNT) {
            return Optional.empty();
        }
        if (metadataType == MetadataType.NAMESPACE) {
            return targetId.map(MapperUtils::toNamespaceId);
        }
        if (metadataType == MetadataType.MOSAIC) {
            return targetId.map(MapperUtils::toMosaicId);
        }
        return Optional.empty();
    }

    public String getCompositeHash() {
        return compositeHash;
    }

    public String getSenderPublicKey() {
        return senderPublicKey;
    }

    public String getTargetPublicKey() {
        return targetPublicKey;
    }

    public BigInteger getScopedMetadataKey() {
        return scopedMetadataKey;
    }

    public MetadataType getMetadataType() {
        return metadataType;
    }

    public String getValue() {
        return value;
    }

    public Optional getTargetId() {
        return targetId;
    }

}