org.finra.jtaf.ewd.widget.WidgetException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jtaf-extwebdriver Show documentation

ExtWebDriver is an enhancement to the WebDriver API, with features such as widget library, session management and extended functions

There is a newer version: 1.5.6

Show newest version

/*
 * (C) Copyright 2013 Java Test Automation Framework Contributors.
 *
 * 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.finra.jtaf.ewd.widget;

import org.openqa.selenium.By;

/**
 * Thrown by many {@link IElement Widget} interface methods to indicate a
 * general {@link Exception}.
 * 
 */
public class WidgetException extends Exception {

    private static final long serialVersionUID = 157818658900692467L;

    /**
     * Constructs a {@code WidgetException} with the specified detail message
     * and the locator of the element being used when the {@code Exception} was
     * thrown.
     * 
     * @param message
     *            the detail message
     * @param locator
     *            the element locator being used when the {@code Exception} was
     *            thrown
     */
    public WidgetException(String message, String locator) {
        super(message + ": at " + locator);
    }

    
    /**
     * Constructs a {@code WidgetException} with the specified detail message
     * and the locator of the element being used when the {@code Exception} was
     * thrown.
     * 
     * @param message
     *            the detail message
     * @param locator
     *            the element locator being used when the {@code Exception} was
     *            thrown
     */
    public WidgetException(String message, By locator) {
        super(message + ": at " + locator);
    }
    
    /**
     * Constructs a {@code WidgetException} with the specified detail message,
     * the element locator being used when the {@code Exception} was thrown, and
     * the {@code Exception} serving as the underlying cause for this
     * {@code WidgetException} being thrown.
     * 
     * @param message
     *            the detail message
     * @param locator
     *            the element locator being used when the {@code Exception} was
     *            thrown
     * @param cause
     *            the underlying cause for this {@code Exception} being thrown
     */
    public WidgetException(String message, String locator, Exception cause) {
        super(message + ": at " + locator, cause);
    }

    /**
     * Constructs a {@code WidgetException} with the specified detail message,
     * the element locator being used when the {@code Exception} was thrown, and
     * the {@code Exception} serving as the underlying cause for this
     * {@code WidgetException} being thrown.
     * 
     * @param message
     *            the detail message
     * @param locator
     *            the element locator being used when the {@code Exception} was
     *            thrown
     * @param cause
     *            the underlying cause for this {@code Exception} being thrown
     */
    public WidgetException(String message, By locator, Exception cause) {
        super(message + ": at " + locator, cause);
    }
}