io.fabric8.api

Class DynamicReference<T>

java.lang.Object

io.fabric8.api.DynamicReference<T>

All Implemented Interfaces:

java.util.concurrent.Callable<T>

public final class DynamicReference<T>
extends java.lang.Object
implements java.util.concurrent.Callable<T>

An object that is intended to hold a reference to a dynamic object (e.g. OSGi services). The DynamicReference will return the object if available or wait for it for a configurable amount of time. Usually solutions like SCR tackle the dynamic nature of references, but nothing prevents the user of obtaining a reference to a deactivated component with unbound references.

Constructor Summary

Constructors

Constructor and Description
DynamicReference()
DynamicReference(java.lang.String name)
DynamicReference(java.lang.String name, long timeout, java.util.concurrent.TimeUnit unit)

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(T value) Binds the reference.
T	call()
T	get() Get the reference or wait until it becomes available.
T	getIfPresent() Returns the value if present.
void	unbind(T value) Unbinds the reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicReference

public DynamicReference()

DynamicReference

public DynamicReference(java.lang.String name)

DynamicReference

public DynamicReference(java.lang.String name,
                long timeout,
                java.util.concurrent.TimeUnit unit)

Method Detail

call

public T call()
       throws java.lang.Exception

Specified by:

call in interface java.util.concurrent.Callable<T>

Throws:

java.lang.Exception

get

public T get()

Get the reference or wait until it becomes available.

Returns:

Returns the reference or throws a DynamicReferenceException.

getIfPresent

public T getIfPresent()

Returns the value if present.

Returns:

The value or Null.

bind

public void bind(T value)

Binds the reference.

unbind

public void unbind(T value)

Unbinds the reference.