001/*
002 * SPDX-License-Identifier: Apache-2.0
003 *
004 * Copyright 2024-2026 The Enola <https://enola.dev> Authors
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 *     https://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package dev.enola.data.id;
019
020/**
021 * 🆔 annotated classes uniquely 🪪 identify 🫆 objects.
022 *
023 * <p>{@link IdConverter} converts such IDs from and to String.
024 *
025 * <p>This is a "convenience marker interface". It is recommended to be added to new classes, but
026 * it's technically NOT strictly required; as e.g. an {@link java.net.URI} is also such an ID (and
027 * {@link IdConverters#URI} is its converter) or an {@link java.util.UUID} - despite either of them
028 * not actually really being annotated with this.
029 */
030public @interface ID {
031
032    // TODO Class<IdConverter<?>> converter();
033}