Class Waiter

java.lang.Object
org.netbeans.jemmy.Waiter
All Implemented Interfaces:
Outputable, Timeoutable, Waitable
Direct Known Subclasses:
WindowWaiter
public class Waiter extends Object implements Waitable, Timeoutable, Outputable
Waits for something defined by Waitable interface to be happened.

Timeouts used:
Waiter.TimeDelta - time delta to check actionProduced result.
Waiter.WaitingTime - maximal waiting time
Waiter.AfterWaitingTime - time to sleep after waiting has been finished.
Author:
Alexandre Iline (alexandre.iline@sun.com)
See Also:

  • Constructor Details

    • Waiter

      public Waiter(Waitable w)
      Constructor.
      Parameters:
      w - Waitable object defining waiting criteria.

    • Waiter

      protected Waiter()
      Can be used from subclass.

  • Method Details

    • setTimeouts

      public void setTimeouts(Timeouts timeouts)
      Defines current timeouts.
      Specified by:
      setTimeouts in interface Timeoutable
      Parameters:
      timeouts - A collection of timeout assignments.
      See Also:

    • getTimeouts

      public Timeouts getTimeouts()
      Return current timeouts.
      Specified by:
      getTimeouts in interface Timeoutable
      Returns:
      the collection of current timeout assignments.
      See Also:

    • setOutput

      public void setOutput(TestOut out)
      Defines print output streams or writers.
      Specified by:
      setOutput in interface Outputable
      Parameters:
      out - Identify the streams or writers used for print output.
      See Also:

    • getOutput

      public TestOut getOutput()
      Returns print output streams or writers.
      Specified by:
      getOutput in interface Outputable
      Returns:
      an object that contains references to objects for printing to output and err streams.
      See Also:

    • waitAction

      public Object waitAction(Object waitableObject) throws InterruptedException
      Waits for not null result of actionProduced method of Waitable implementation passed into constructor.
      Parameters:
      waitableObject - Object to be passed into actionProduced method.
      Returns:
      non null result of action.
      Throws:
      TimeoutExpiredException
      InterruptedException

    • actionProduced

      public Object actionProduced(Object obj)
      Description copied from interface: Waitable
      Checks if wait criteria have been met.
      Specified by:
      actionProduced in interface Waitable
      Parameters:
      obj -
      Returns:
      null is criteria have not been met.
      See Also:

    • getDescription

      public String getDescription()
      Description copied from interface: Waitable
      Returns description.
      Specified by:
      getDescription in interface Waitable
      Returns:
      a description of the wait criteria.
      See Also:

    • getWaitingStartedMessage

      protected String getWaitingStartedMessage()
      Returns message to be printed before waiting start.
      Returns:
      a message.

    • getTimeoutExpiredMessage

      protected String getTimeoutExpiredMessage(long timeSpent)
      Returns message to be printed when waiting timeout has been expired.
      Parameters:
      timeSpent - time from waiting start (milliseconds)
      Returns:
      a message.

    • getActionProducedMessage

      protected String getActionProducedMessage(long timeSpent, Object result)
      Returns message to be printed when waiting has been successfully finished.
      Parameters:
      timeSpent - time from waiting start (milliseconds)
      result - result of Waitable.actionproduced method.
      Returns:
      a message.

    • getGoldenWaitingStartedMessage

      protected String getGoldenWaitingStartedMessage()
      Returns message to be printed int golden output before waiting start.
      Returns:
      a message.

    • getGoldenTimeoutExpiredMessage

      protected String getGoldenTimeoutExpiredMessage()
      Returns message to be printed int golden output when waiting timeout has been expired.
      Returns:
      a message.

    • getGoldenActionProducedMessage

      protected String getGoldenActionProducedMessage()
      Returns message to be printed int golden output when waiting has been successfully finished.
      Returns:
      a message.

    • timeFromStart

      protected long timeFromStart()
      Returns time from waiting start.
      Returns:
      Time spent for waiting already.