org.jboss.arquillian.ajocado.waiting.conditions.TextEquals Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graphene-selenium-impl Show documentation
Testing Ajax with flavour of sexy type-safe API
There is a newer version: 2.0.0.Alpha5
Show newest version
/**
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This 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 software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.arquillian.ajocado.waiting.conditions;

import static org.apache.commons.lang3.StringEscapeUtils.escapeEcmaScript;
import static org.jboss.arquillian.ajocado.javascript.JavaScript.js;

import org.jboss.arquillian.ajocado.framework.GrapheneSelenium;
import org.jboss.arquillian.ajocado.framework.GrapheneSeleniumContext;
import org.jboss.arquillian.ajocado.javascript.JavaScript;
import org.jboss.arquillian.ajocado.locator.element.ElementLocator;
import org.jboss.arquillian.ajocado.waiting.ajax.JavaScriptCondition;
import org.jboss.arquillian.ajocado.waiting.selenium.SeleniumCondition;
import org.jboss.arquillian.core.spi.Validate;

/**
 *
 * 
 * Implementation of Condition for waiting if element given by elementLocator has text equal to given text.
 * 
 *
 * 
 * Implements Condition and JavaScriptCondition used in SeleniumWaiting and AjaxWaiting.
 * 
 *
 * @author Lukas Fryc
 * @version $Revision$
 */
public class TextEquals implements SeleniumCondition, JavaScriptCondition {

    /**
     * Proxy to local selenium instance
     */
    private GrapheneSelenium selenium = GrapheneSeleniumContext.getProxy();

    /** The element locator. */
    private ElementLocator elementLocator;

    /** The text. */
    private String text;

    /**
     * Instantiates a new text equals.
     */
    protected TextEquals() {
    }

    /*
     * (non-Javadoc)
     *
     * @see org.jboss.arquillian.ajocado.waiting.Condition#isTrue()
     */
    @Override
    public boolean isTrue() {
        Validate.notNull(elementLocator, "elementLocator should not be null");
        Validate.notNull(text, "text should not be null");

        return selenium.getText(elementLocator).equals(text);
    }

    /*
     * (non-Javadoc)
     *
     * @see org.jboss.arquillian.ajocado.waiting.ajax.JavaScriptCondition#getJavaScriptCondition()
     */
    @Override
    public JavaScript getJavaScriptCondition() {
        String escapedLocator = escapeEcmaScript(this.elementLocator.inSeleniumRepresentation());
        String escapedText = escapeEcmaScript(this.text);
        return js("selenium.isElementPresent('{0}') && (selenium.getText('{0}') == '{1}')").parametrize(escapedLocator,
                escapedText);
    }

    /**
     * Factory method.
     *
     * @return single instance of TextEquals
     */
    public static TextEquals getInstance() {
        return new TextEquals();
    }

    /**
     * 
     * Returns the TextEquals instance with given elementLocator set.
     * 
     *
     * 
     * From this locator will be obtained the text.
     * 
     *
     * @param elementLocator the element locator
     * @return the TextEquals object with preset locator
     */
    public TextEquals locator(ElementLocator elementLocator) {
        Validate.notNull(elementLocator, "elementLocator should not be null");

        TextEquals copy = copy();
        copy.elementLocator = elementLocator;

        return copy;
    }

    /**
     * 
     * Returns the TextEquals instance with text set.
     * 
     *
     * 
     * For equality with this text the condition will wait.
     * 
     *
     * @param text it should wait for equality
     * @return the TextEquals object with preset text
     */
    public TextEquals text(String text) {
        Validate.notNull(text, "text should not be null");

        TextEquals copy = copy();
        copy.text = text;

        return copy;
    }

    /**
     * Returns the exact copy of this ElementPresent object.
     *
     * @return the copy of this TextEquals object
     */
    private TextEquals copy() {
        TextEquals copy = new TextEquals();
        copy.elementLocator = elementLocator;
        copy.text = text;
        return copy;
    }
}