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.common.convert;
019
020/**
021 * Converts an object of type I to a new object of type O.
022 *
023 * <p>The "context" of the conversion, if any, must be part of I.
024 *
025 * <p>For #efficiency, consider whether this or a {@link ConverterInto} is more suitable.
026 *
027 * <p>Converter implementations "have" to convert, and should never return null; if they may or may
028 * not convert depending on I, then implement an {@link OptionalConverter} instead of throwing a
029 * ConversionException.
030 *
031 * <p>{@link BiConverter} is a bi-directional alternative to this.
032 *
033 * @param <I> the input type
034 * @param <O> the output type
035 */
036@FunctionalInterface
037public interface Converter<I, O> {
038
039    O convert(I input) throws ConversionException;
040}