com.hedera.node.app.service.token.ReadableAirdropStore Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2024 Hedera Hashgraph, LLC
 *
 * 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 com.hedera.node.app.service.token;

import com.hedera.hapi.node.base.PendingAirdropId;
import com.hedera.hapi.node.state.token.AccountPendingAirdrop;
import edu.umd.cs.findbugs.annotations.NonNull;

/**
 * Provides read-only methods for interacting with the underlying data storage mechanisms for
 * pending Airdrop states.
 */
public interface ReadableAirdropStore {
    /**
     * Fetches an {@link AccountPendingAirdrop} object from state for given {@link PendingAirdropId}.
     * If the airdrop  could not be fetched because the given airdrop doesn't exist, returns {@code null}.
     *
     * @param airdropId given airdrop id
     * @return {@link AccountPendingAirdrop} object if successfully fetched or {@code null} if the airdrop doesn't exist
     */
    AccountPendingAirdrop get(@NonNull PendingAirdropId airdropId);

    /**
     * Returns whether a given PendingAirdropId exists in state.
     *
     * @param airdropId - the id of the airdrop
     * @return true if the airdrop exists, false otherwise
     */
    boolean exists(@NonNull PendingAirdropId airdropId);

    /**
     * Returns the number of entities in the pending airdrops state.
     * @return the size of the pending airdrops state
     */
    long sizeOfState();

    /**
     * Warms the system by preloading a token into memory
     *
     * The default implementation is empty because preloading data into memory is only used for some implementations.
     *
     * @param airdropId the token id
     */
    default void warm(@NonNull final PendingAirdropId airdropId) {}
}