// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.GWT.client.dev.ui.inspection;

import org.litesoft.core.typeutils.*;

import com.google.gwt.dom.client.*;

/**
 * Crawls the DOM looking for a UI "object" which matches the parameters
 * specified by {@link SelectionSpec}.
 */
public abstract class Finder
{
    private final SelectionSpec mSelectionSpec;

    public Finder(SelectionSpec pSelectionSpec)
    {
        Objects.assertNotNull( "pSelectionSpec", pSelectionSpec );
        mSelectionSpec = pSelectionSpec;
    }

    public SelectionSpecId getSelectorId()
    {
        return mSelectionSpec.getId();
    }

    protected SelectionSpec getSelectionSpec()
    {
        return mSelectionSpec;
    }

    public abstract Object find(Element pRoot);

    @Override
    public String toString()
    {
        return getSelectorId().toString();
    }
}