io.github.jamoamo.webjourney.api.web.IBrowserWindow Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of webjourney Show documentation

Java library for automating web interactions via the concept of a sequence of actions on the web, defined as a web journey. Define the Path and interactions and let it run.

The newest version!

/*
 * The MIT License
 *
 * Copyright 2023 James Amoore.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package io.github.jamoamo.webjourney.api.web;

/**
 * Interface for a browser window or tab.
 * 
 * @author James Amoore
 */
public interface IBrowserWindow extends IWebNavigator
{
	/**
	 * Retrieve the url of the current page.
	 * @return the url of the current page.
	 * @throws io.github.jamoamo.webjourney.api.web.XWebException if a browsing error occurs
	 */
	String getCurrentUrl() throws XWebException;
	
	/**
	 * Retrieves the current WebPage.
	 * @return the current page
	 * @throws io.github.jamoamo.webjourney.api.web.XWebException if a browsing error occurs
	 */
	IWebPage getCurrentPage() throws XWebException;
	
	/**
	 * Refreshes the current page.
	 * @return the current page
	 * @throws io.github.jamoamo.webjourney.api.web.XWebException if a browsing error occurs
	 */
	IWebPage refreshCurrentPage() throws XWebException;
	
	/**
	 * Close the window.
	 * @throws io.github.jamoamo.webjourney.api.web.XWebException if a browsing error occurs
	 */
	void close() throws XWebException;
	
	/**
	 * Return the name of this window.
	 * @return name 
	 * @throws io.github.jamoamo.webjourney.api.web.XWebException if a browsing error occurs
	 */
	String getName() throws XWebException;
}