com.hedera.node.app.service.consensus.ReadableTopicStore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of app-service-consensus Show documentation

Hedera Consensus Service API

There is a newer version: 0.57.3

Show newest version

/*
 * Copyright (C) 2023-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.consensus;

import com.hedera.hapi.node.base.TopicID;
import com.hedera.hapi.node.state.consensus.Topic;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

/**
 * Provides read-only methods for interacting with the underlying data storage mechanisms for
 * working with Topics.
 *
 * This class is not exported from the module. It is an internal implementation detail.
 */
public interface ReadableTopicStore {

    /**
     * Returns the topic needed. If the topic doesn't exist returns failureReason. If the
     * topic exists , the failure reason will be null.
     *
     * @param id topic id being looked up
     * @return topic's metadata
     */
    @Nullable
    Topic getTopic(@NonNull TopicID id);

    /**
     * Returns the number of topics in the state.
     * @return the number of topics in the state
     */
    long sizeOfState();
}