com.qa.automation.android.view.ViewUtils Maven / Gradle / Ivy

Go to download
package com.qa.automation.android.view;

import android.view.View;
import android.widget.TextView;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;


/**
 * The type View utils.
 */
public class ViewUtils {
    /**
     * Removes invisible Views.
     *
     * @param       the type parameter
     * @param viewList an Iterable with Views that is being checked for invisible Views
     * @return a filtered Iterable with no invisible Views
     */

    public static  ArrayList removeInvisibleViews(Iterable viewList) {
        ArrayList tmpViewList = new ArrayList();
        for (T view : viewList) {
            if (view != null && view.isShown()) {
                tmpViewList.add(view);
            }
        }
        return tmpViewList;
    }

    /**
     * Filters Views based on the given class type.
     *
     * @param              the type parameter
     * @param classToFilterBy the class to filter
     * @param viewList        the Iterable to filter from
     * @return an ArrayList with filtered views
     */
    public static  ArrayList filterViews(Class classToFilterBy, Iterable viewList) {
        ArrayList filteredViews = new ArrayList();
        for (Object view : viewList) {
            if (view != null && classToFilterBy.isAssignableFrom(view.getClass())) {
                filteredViews.add(classToFilterBy.cast(view));
            }
        }
        viewList = null;
        return filteredViews;
    }

    /**
     * Filters all Views not within the given set.
     *
     * @param classSet contains all classes that are ok to pass the filter
     * @param viewList the Iterable to filter form
     * @return an ArrayList with filtered views
     */
    public static ArrayList filterViewsToSet(Class classSet[], Iterable viewList) {
        ArrayList filteredViews = new ArrayList();
        for (View view : viewList) {
            if (view == null)
                continue;
            for (Class filter : classSet) {
                if (filter.isAssignableFrom(view.getClass())) {
                    filteredViews.add(view);
                    break;
                }
            }
        }
        return filteredViews;
    }

    /**
     * Orders Views by their location on-screen.
     *
     * @param views The views to sort
     * @see ViewLocationComparator
     */
    public static void sortViewsByLocationOnScreen(List views) {
        Collections.sort(views, new ViewLocationComparator());
    }

    /**
     * Orders Views by their location on-screen.
     *
     * @param views      The views to sort
     * @param yAxisFirst Whether the y-axis should be compared before the x-axis
     * @see ViewLocationComparator
     */
    public static void sortViewsByLocationOnScreen(List views, boolean yAxisFirst) {
        Collections.sort(views, new ViewLocationComparator(yAxisFirst));
    }

    /**
     * Checks if a View matches a certain string and returns the amount of total matches.
     *
     * @param regex           the regex to match
     * @param view            the view to check
     * @param uniqueTextViews set of views that have matched
     * @return number of total matches
     */
    public static int getNumberOfMatches(String regex, TextView view, Set uniqueTextViews) {
        if (view == null) {
            return uniqueTextViews.size();
        }

        Pattern pattern = null;
        try {
            pattern = Pattern.compile(regex);
        } catch (PatternSyntaxException e) {
            pattern = Pattern.compile(regex, Pattern.LITERAL);
        }

        Matcher matcher = pattern.matcher(view.getText().toString());

        if (matcher.find()) {
            uniqueTextViews.add(view);
        }

        if (view.getError() != null) {
            matcher = pattern.matcher(view.getError().toString());
            if (matcher.find()) {
                uniqueTextViews.add(view);
            }
        }
        if (view.getText().toString().equals("") && view.getHint() != null) {
            matcher = pattern.matcher(view.getHint().toString());
            if (matcher.find()) {
                uniqueTextViews.add(view);
            }
        }
        return uniqueTextViews.size();
    }

    /**
     * Filters a collection of Views and returns a list that contains only Views
     * with text that matches a specified regular expression.
     *
     * @param    the type parameter
     * @param views The collection of views to scan
     * @param regex The text pattern to search for
     * @return A list of views whose text matches the given regex
     */
    public static  List filterViewsByText(Iterable views, String regex) {
        return filterViewsByText(views, Pattern.compile(regex));
    }

    /**
     * Filters a collection of Views and returns a list that contains only Views
     * with text that matches a specified regular expression.
     *
     * @param    the type parameter
     * @param views The collection of views to scan
     * @param regex The text pattern to search for
     * @return A list of views whose text matches the given regex
     */
    public static  List filterViewsByText(Iterable views, Pattern regex) {
        final ArrayList filteredViews = new ArrayList();
        for (T view : views) {
            if (view != null && regex.matcher(view.getText()).matches()) {
                filteredViews.add(view);
            }
        }
        return filteredViews;
    }
}