com.redhat.darcy.ui.api.Locator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of darcy-ui Show documentation

Framework for writing page objects to automate interaction with graphical user interfaces.

The newest version!

/*
 Copyright 2014 Red Hat, Inc. and/or its affiliates.

 This file is part of darcy-ui.

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program 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 General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see .
 */

package com.redhat.darcy.ui.api;

import com.redhat.darcy.ui.api.elements.Findable;

import java.util.List;

/**
 * A locator is a strategy for finding an instance (or List of instances) that implement some class,
 * given some {@link com.redhat.darcy.ui.api.Context}.
 */
public interface Locator {
    /**
     * Returns a list of all the elements found by this locator, of the given type, in the given
     * context.
     *
     * @param type
     * @param context
     * @return
     */
     List findAll(Class type, Context context);
    
    /**
     * Returns one element found by this locator, of the given type, in the given context.
     *
     * @param type
     * @param context
     * @return
     */
     T find(Class type, Context context);
}