/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package geb.navigator.factory

import geb.navigator.Navigator
import org.openqa.selenium.WebElement
import geb.Browser

/**
 * Creates Navigator instances from zero or more WebElement instances.
 *
 * Designed to be the extension point for injecting a custom navigator implementation.
 *
 * @see geb.Configuration#getInnerNavigatorFactory()
 * @see DefaultInnerNavigatorFactory
 */
interface InnerNavigatorFactory {

    /**
     * Create a Navigator instance for the given web elements.
     *
     * The elements list may be of zero length.
     *
     * @param browser The browser to attach the navigators too.
     * @param elements Zero or more content elements to wrap as a navigator
     * @return A navigator instance, for the given elements
     */
    Navigator createNavigator(Browser browser, Iterable<WebElement> elements)

}
