TestWindowFindByOpenSequence.java

/*******************************************************************************
 * ATE, Automation Test Engine
 *
 * Copyright 2015, Montreal PROT, or individual contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Montreal PROT.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package org.bigtester.ate.model.page.elementfind;

import org.bigtester.ate.annotation.ATELogLevel;
import org.bigtester.ate.annotation.TestObjectFinderLoggable;
import org.bigtester.ate.model.page.atewebdriver.IMyWebDriver;
import org.openqa.selenium.NoSuchElementException;

// TODO: Auto-generated Javadoc
/**
 * This class TestWindowFindByTitle defines ....
 * @author Peidong Hu
 *
 */
public class TestWindowFindByOpenSequence extends BaseTestWindowFinderImpl implements ITestWindowFinder, ITestObjectFinderImpl{

	/** The title. */
	final private int openSequence;
	
	/**
	 * Instantiates a new test window find by title.
	 *
	 * @param title the title
	 */
	
	public TestWindowFindByOpenSequence(int openSequence) {
		super();
		this.openSequence = openSequence;
	}
	/**
	 * @return the title
	 */
	public int getOpenSequence() {
		return openSequence;
	}
	/**
	 * {@inheritDoc}
	 */
	@Override
	@TestObjectFinderLoggable (level=ATELogLevel.INFO)
	public String doFind(IMyWebDriver myWebDriver) throws NoSuchElementException {
		String retVal = myWebDriver.getMultiWindowsHandler().obtainWindowHandle(openSequence);
		if (null == retVal) {
			throw new NoSuchElementException("Window in open sequence of " + openSequence);
		}  
		return retVal;
	}
	/**
	* {@inheritDoc}
	*/
	@Override
	public String getFindingParametersLoggingValue() {
		return "openSequence=" + openSequence;
	}
}