<?php

/*
 * This file is part of the Behat Testwork.
 * (c) Konstantin Kudryashov <ever.zet@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Behat\Testwork\Specification\Locator;

use Behat\Testwork\Specification\SpecificationFinder;
use Behat\Testwork\Specification\SpecificationIterator;
use Behat\Testwork\Suite\Suite;

/**
 * Provides a custom way to locate specification by provided suite and locator string.
 *
 * @see SpecificationFinder
 *
 * @author Konstantin Kudryashov <ever.zet@gmail.com>
 *
 * @template-covariant T
 */
interface SpecificationLocator
{
    /**
     * Returns array of strings representing examples of supported specification locators.
     *
     * @return string[]
     */
    public function getLocatorExamples();

    /**
     * Locates specifications and wraps them into iterator.
     *
     * @param string|null $locator
     *
     * @return SpecificationIterator<T>
     */
    public function locateSpecifications(Suite $suite, $locator);
}
