//··························································
// Copyright (c) 2023-2026. Jonathan Bédard ~ JóôòKiwi
//
// This project is free to use.
// All the right is reserved to the author of this project.
// My projects:
//  - https://github.com/joooKiwi/type
//  - https://github.com/joooKiwi/lazy
//  - https://github.com/joooKiwi/collection
//  - https://github.com/joooKiwi/enumeration
//··························································

import type {Nullable, NullOr} from "@joookiwi/type"

import type {Enumerable}                 from "../Enumerable"
import type {EnumerableConstructor}      from "../EnumerableConstructor"
import type {ExceptionWithNullableCause} from "./declaration/ExceptionWithNullableCause"
import type {ExceptionWithValue}         from "./declaration/ExceptionWithValue"

/**
 * An exception to tell that the {@link value value received} was not one of
 * the {@link expectedEnumerableConstructors enumerable instances (constructors) expected}
 *
 * @see https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/ClassCastException.html Java ClassCastException
 * @see https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-class-cast-exception Kotlin ClassCastException
 * @see https://learn.microsoft.com/dotnet/api/system.invalidcastexception C# InvalidCastException
 */
export class InvalidEnumerableException<const ENUMERABLE extends Enumerable,
    const EXPECTED_ENUMERABLE_CONSTRUCTORS extends readonly EnumerableConstructor<any, any>[],
    const CAUSE extends Error = never, >
    extends TypeError
    implements ExceptionWithValue<ENUMERABLE>,
               ExceptionWithNullableCause<CAUSE> {

    public override readonly name = this.constructor.name
    readonly #value: ENUMERABLE
    readonly #expectedEnumerableConstructors: EXPECTED_ENUMERABLE_CONSTRUCTORS
    readonly #cause: NullOr<CAUSE>

    public constructor(message: string, value: ENUMERABLE, expectedEnumerableConstructors: EXPECTED_ENUMERABLE_CONSTRUCTORS, cause?: Nullable<CAUSE>,) {
        super(message,)
        this.#value = value
        this.#expectedEnumerableConstructors = expectedEnumerableConstructors
        this.#cause = cause ?? null
    }

    /** The {@link Enumerable} value that was invalid */
    public get value(): ENUMERABLE {
        return this.#value
    }

    /** The expected {@link EnumerableConstructor enumerable constructors} that were assumed to be one of them */
    public get expectedEnumerableConstructors(): EXPECTED_ENUMERABLE_CONSTRUCTORS {
        return this.#expectedEnumerableConstructors
    }

    public override get cause(): NullOr<CAUSE> {
        return this.#cause
    }

}