com.hedera.node.app.spi.ids.EntityNumGenerator Maven / Gradle / Ivy
/*
* 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.spi.ids;
/**
* Provides a way to generate entity numbers.
*/
public interface EntityNumGenerator {
/**
* Consumes and returns the next entity number, for use by handlers that create entities.
*
* If this method is called after a child transaction was dispatched, which is subsequently rolled back,
* the counter will be rolled back, too. Consequently, the provided number must not be used anymore in this case,
* because it will be reused.
*
* @return the next entity number
*/
long newEntityNum();
/**
* Peeks at the next entity number, for use by handlers that create entities.
*
*
If this method is called after a child transaction was dispatched, which is subsequently rolled back,
* the counter will be rolled back, too. Consequently, the provided number must not be used anymore in this case,
* because it will be reused.
*
* @return the next entity number
*/
long peekAtNewEntityNum();
}