BrowserCapabilities.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, Red Hat Middleware LLC, and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * Licensed 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 org.jboss.arquillian.drone.webdriver.spi;

import java.util.Map;
import org.jboss.arquillian.drone.spi.Sortable;

/**
 * A mapping between browser representation in Drone and WebDriver capabilities
 *
 * @author <a href="mailto:kpiwko@redhat.com">Karel Piwko</a>
 */
public interface BrowserCapabilities extends Sortable {

    /**
     * Returns class name of appropriate Selenium browser
     */
    String getImplementationClassName();

    /**
     * Returns a map of Selenium capabilities of the browser
     */
    Map<String, ?> getRawCapabilities();

    /**
     * Returns a name of browser used to match the BrowserCapabilities object
     */
    String getReadableName();
}