<?php

/*
 * This file is part of Chevere.
 *
 * (c) Rodolfo Berrios <rodolfo@chevere.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Chevere\Parameter\Interfaces;

/**
 * Describes the component in charge of defining a parameter of type union.
 */
interface UnionParameterInterface extends ParameterInterface, ParametersAccessInterface
{
    /**
     * Asserts the given `$value` is valid.
     */
    public function __invoke(mixed $value): mixed;

    /**
     * Return an instance with added optional parameters.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified parameters.
     */
    public function withAdded(ParameterInterface ...$parameter): self;

    public function assertCompatible(self $parameter): void;
}