/*
 * $Id$
 *
 * Copyright (C) 2003-2015 JNode.org
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; If not, write to the Free Software Foundation, Inc., 
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package org.jnode.driver;

/**
 * Interface used to search for a suitable driver for a given device.
 * <p/>
 * Each DeviceToDriverMapper must be registered in the DeviceManager
 * in order to be used while searching for a suitable driver.
 *
 * @author Ewout Prangsma (epr@users.sourceforge.net)
 */
public interface DeviceToDriverMapper {

    /**
     * Match devices in a custom predefined way by the mapper.
     */
    public static final int MATCH_DEVICE_PREDEFINED = -1;

    /**
     * Match on exact device and exact revision, best possible match.
     */
    public static final int MATCH_DEVICE_REVISION = 0;

    /**
     * Match on exact device, good match
     */
    public static final int MATCH_DEVICE = 1;

    /**
     * Match on device class
     */
    public static final int MATCH_DEVCLASS = 2;

    /**
     * Return a suitable driver for the given device or <code>null</code>.
     *
     * @param device
     * @return A suitable driver or <code>null</code> if no suitable driver is found.
     */
    public Driver findDriver(Device device);

    /**
     * Gets the matching level of this mapper.
     * The mappers are queried in order of match level. This will ensure
     * the best available driver for a device.
     * This method must return a constant value for the entire
     * lifetime of this mapper.
     *
     * @return One of the MATCH_xxx constants.
     * @see #MATCH_DEVICE_REVISION
     * @see #MATCH_DEVICE
     * @see #MATCH_DEVCLASS
     */
    public int getMatchLevel();
}