com.thoughtworks.selenium.condition.Condition Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of selenium-leg-rc Show documentation
Selenium automates browsers. That's it! What you do with that power is entirely up to you.
There is a newer version: 4.5.0
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you 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 com.thoughtworks.selenium.condition;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

/**
 * Simple predicate class, which also knows how to wait for the condition to be true. Used by
 * Selenium tests.
 * 
 * Conditions have two basic properties:
 * 

 * a message (purely used for displaying purposes)
 * 
an implementation of
 * {@link Condition isTrue(com.google.testing.selenium.condition.ConditionRunner.Context)}
 * 
 */
public abstract class Condition {

  private final String message;

  public abstract boolean isTrue(ConditionRunner.Context runner);

  /**
   * Creates an instance of Condition with is canonical name as message
   */
  public Condition() {
    this.message = getClass().getCanonicalName();
  }

  /**
   * Creates an instance of Condition with the given {@code message} and {@code args}, which are in
   * the {@link String#format(String, Object...)} modeal.
   * @param message message
   * @param args args
   */
  public Condition(String message, Object[] args) {
    if (null == message) {
      throw new NullPointerException("Condition names must not be null");
    }
    // this.message = String.format(message, args);
    this.message = simulateStringDotFormatMethod(message, args);
  }

  private String simulateStringDotFormatMethod(String message, Object[] args) {
    int vers = Integer.parseInt(System.getProperty("java.class.version").substring(0, 2));
    if (vers >= 49) {
      try {
        Method format =
            String.class.getMethod("format", new Class[] {String.class, Object[].class});
        return (String) format.invoke(null, new Object[] {message, args});
      } catch (NoSuchMethodException e) {
      } catch (IllegalAccessException e) {
      } catch (InvocationTargetException e) {
        Throwable throwable = e.getCause();
        if (throwable instanceof RuntimeException) {
          throw (RuntimeException) throwable;
        }
      }
      throw new RuntimeException("String.format(..) can't be that hard to call");
    }
    String msg = "";
    msg = message;
    for (int i = 0; i < args.length; i++) {
      msg = msg + " " + args[i];
    }
    return msg;
  }

  // drop these for var-args in another year.
  public Condition(String message) {
    this(message, new Object[0]);
  }

  public Condition(String message, Object arg) {
    this(message, new Object[] {arg});
  }

  public Condition(String message, Object arg0, Object arg1) {
    this(message, new Object[] {arg0, arg1});
  }

  public Condition(String message, Object arg0, Object arg1, Object arg2) {
    this(message, new Object[] {arg0, arg1, arg2});
  }

  public Condition(String message, Object arg0, Object arg1, Object arg2, Object arg3) {
    this(message, new Object[] {arg0, arg1, arg2, arg3});
  }

  public Condition(String message, Object arg0, Object arg1, Object arg2, Object arg3, Object arg4) {
    this(message, new Object[] {arg0, arg1, arg2, arg3, arg4});
  }

  public String getMessage() {
    return toString();
  }

  @Override
  public String toString() {
    return "Condition \"" + this.message + "\"";
  }
}