Top Description Inners Fields Constructors Methods
com.oracle.bmc.waiter

public Class WaiterConfiguration

extends Object
Class Inheritance
Known Direct Subclasses
com.oracle.bmc.retrier.RetryConfiguration
Configuration used when invoking a waiter loop.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WaiterConfiguration.WaitContext

The context that should be maintained by the wait loop.

Field Summary

Modifier and TypeField and Description
private final DelayStrategy
delayStrategy

private final TerminationStrategy
terminationStrategy

Constructor Summary

AccessConstructor and Description
public
WaiterConfiguration(final TerminationStrategy terminationStrategy, final DelayStrategy delayStrategy)

Method Summary

Modifier and TypeMethod and Description
public DelayStrategy
getDelayStrategy()

public TerminationStrategy
getTerminationStrategy()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

delayStrategyback to summary
private final DelayStrategy delayStrategy
terminationStrategyback to summary
private final TerminationStrategy terminationStrategy

Constructor Detail

WaiterConfigurationback to summary
public WaiterConfiguration(final TerminationStrategy terminationStrategy, final DelayStrategy delayStrategy)
Annotations
@java.beans.ConstructorProperties

Method Detail

getDelayStrategyback to summary
public DelayStrategy getDelayStrategy()
getTerminationStrategyback to summary
public TerminationStrategy getTerminationStrategy()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
com.oracle.bmc.waiter back to summary

public Class WaiterConfiguration.WaitContext

extends Object
Class Inheritance
The context that should be maintained by the wait loop.

Field Summary

Modifier and TypeField and Description
private int
attemptsMade

The number of attempts that have been made so far.

private long
currentTime

The current time (ex, System.currentTimeMillis()).

private final long
startTime

The time the polling starting (ex, System.currentTimeMillis()).

Constructor Summary

AccessConstructor and Description
public
WaitContext(long startTime)

Method Summary

Modifier and TypeMethod and Description
public int
getAttemptsMade()

public long
getCurrentTime()

public long
getStartTime()

public void
incrementAttempts()

Increments the number of attempts made.

pack-priv void
setCurrentTime(long currentTime)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

attemptsMadeback to summary
private int attemptsMade

The number of attempts that have been made so far.

currentTimeback to summary
private long currentTime

The current time (ex, System.currentTimeMillis()). Exposed for tests.

startTimeback to summary
private final long startTime

The time the polling starting (ex, System.currentTimeMillis()).

Constructor Detail

WaitContextback to summary
public WaitContext(long startTime)

Method Detail

getAttemptsMadeback to summary
public int getAttemptsMade()
getCurrentTimeback to summary
public long getCurrentTime()
getStartTimeback to summary
public long getStartTime()
incrementAttemptsback to summary
public void incrementAttempts()

Increments the number of attempts made.

setCurrentTimeback to summary
pack-priv void setCurrentTime(long currentTime)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override