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.iri;
019
020import dev.enola.common.context.TLC;
021
022/**
023 * NamespaceConverter converts "compact" <a
024 * href="https://en.m.wikipedia.org/wiki/CURIE">CURIE</a>-like IRIs (i.e. an IRI with a short
025 * schema, from a list of prefixes only valid in a local context instead of globally) to &amp; from
026 * "full" IRIs (which are globally unique).
027 *
028 * <p>Both methods of this interface may simply return back the argument, if no "match" was found.
029 *
030 * <p>This class does not actually use [square] brackets around the CURIE.
031 */
032public interface NamespaceConverter {
033
034    String toCURIE(Object iri);
035
036    IRI toIRI(String curie);
037
038    NamespaceConverter CTX =
039            new NamespaceConverter() {
040                @Override
041                public String toCURIE(Object iri) {
042                    return TLC.get(NamespaceConverter.class).toCURIE(iri);
043                }
044
045                @Override
046                public IRI toIRI(String curie) {
047                    return TLC.get(NamespaceConverter.class).toIRI(curie);
048                }
049            };
050}