001/*
002 * Copyright 2022-2025 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.soklet.core;
018
019import javax.annotation.Nonnull;
020
021/**
022 * Contract for types that generate identifiers: sequential integers, UUIDs, etc.
023 *
024 * @author <a href="https://www.revetkn.com">Mark Allen</a>
025 */
026@FunctionalInterface
027public interface IdGenerator {
028        /**
029         * Vends an identifier, not necessarily unique.
030         *
031         * @return an identifier
032         */
033        @Nonnull
034        Object generateId();
035}