Package com.google.common.util.concurrent

Class FakeTimeLimiter

java.lang.Object
com.google.common.util.concurrent.FakeTimeLimiter
All Implemented Interfaces:
TimeLimiter
@Beta @Deprecated(since="2022-12-01") public final class FakeTimeLimiter extends Object implements TimeLimiter
Deprecated.
The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
A TimeLimiter implementation which actually does not attempt to limit time at all. This may be desirable to use in some unit tests. More importantly, attempting to debug a call which is time-limited would be extremely annoying, so this gives you a time-limiter you can easily swap in for your real time-limiter while you're debugging.
Since:
1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    FakeTimeLimiter()
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> T
    callWithTimeout(Callable<T> callable, long timeoutDuration, TimeUnit timeoutUnit, boolean amInterruptible)
    Deprecated.
    Invokes a specified Callable, timing out after the specified time limit.
    <T> T
    newProxy(T target, Class<T> interfaceType, long timeoutDuration, TimeUnit timeoutUnit)
    Deprecated.
    Returns an instance of interfaceType that delegates all method calls to the target object, enforcing the specified time limit on each call.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • FakeTimeLimiter

      public FakeTimeLimiter()
      Deprecated.

  • Method Details

    • newProxy

      public <T> T newProxy(T target, Class<T> interfaceType, long timeoutDuration, TimeUnit timeoutUnit)
      Deprecated.
      Description copied from interface: TimeLimiter
      Returns an instance of interfaceType that delegates all method calls to the target object, enforcing the specified time limit on each call. This time-limited delegation is also performed for calls to Object.equals(java.lang.Object), Object.hashCode(), and Object.toString().

      If the target method call finishes before the limit is reached, the return value or exception is propagated to the caller exactly as-is. If, on the other hand, the time limit is reached, the proxy will attempt to abort the call to the target, and will throw an UncheckedTimeoutException to the caller.

      It is important to note that the primary purpose of the proxy object is to return control to the caller when the timeout elapses; aborting the target method call is of secondary concern. The particular nature and strength of the guarantees made by the proxy is implementation-dependent. However, it is important that each of the methods on the target object behaves appropriately when its thread is interrupted.

      Specified by:
      newProxy in interface TimeLimiter
      Parameters:
      target - the object to proxy
      interfaceType - the interface you wish the returned proxy to implement
      timeoutDuration - with timeoutUnit, the maximum length of time that callers are willing to wait on each method call to the proxy
      timeoutUnit - with timeoutDuration, the maximum length of time that callers are willing to wait on each method call to the proxy
      Returns:
      a time-limiting proxy

    • callWithTimeout

      public <T> T callWithTimeout(Callable<T> callable, long timeoutDuration, TimeUnit timeoutUnit, boolean amInterruptible) throws Exception
      Deprecated.
      Description copied from interface: TimeLimiter
      Invokes a specified Callable, timing out after the specified time limit. If the target method call finished before the limit is reached, the return value or exception is propagated to the caller exactly as-is. If, on the other hand, the time limit is reached, we attempt to abort the call to the target, and throw an UncheckedTimeoutException to the caller.

      Warning: The future of this method is in doubt. It may be nuked, or changed significantly.

      Specified by:
      callWithTimeout in interface TimeLimiter
      Parameters:
      callable - the Callable to execute
      timeoutDuration - with timeoutUnit, the maximum length of time to wait
      timeoutUnit - with timeoutDuration, the maximum length of time to wait
      amInterruptible - whether to respond to thread interruption by aborting the operation and throwing InterruptedException; if false, the operation is allowed to complete or time out, and the current thread's interrupt status is re-asserted.
      Returns:
      the result returned by the Callable
      Throws:
      Exception