AsyncSubject (reactive4java 0.98.0 API)

java.lang.Object
- hu.akarnokd.reactive4java.util.AsyncSubject<T>

Type Parameters:

T - the element type

All Implemented Interfaces:

BaseObserver, Observable<T>, Observer<T>, Subject<T,T>
```
public class AsyncSubject<T>
extends java.lang.Object
implements Subject<T,T>
```
Represents the result (last value or exception) of an asynchronous operation delivered through observation.

Since:

0.97

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`done` Indicator that the source finished.
`protected java.lang.Throwable`	`error` The exception produced.
`protected boolean`	`hasValue` Indication that a value was produced.
`protected java.util.concurrent.locks.Lock`	`lock` The lock.
`protected java.util.Map<java.io.Closeable,Observer<? super T>>`	`observers` The map of registered observers.
`protected T`	`value` The last value produced.

Constructor Summary

Constructors
Constructor and Description
`AsyncSubject()` Creates an AsyncSubject with a fair reentrant lock.
`AsyncSubject(java.util.concurrent.locks.Lock lock)` Creates an AsyncSubject with the supplied lock.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`error(java.lang.Throwable ex)` An exception is received.
`void`	`finish()` No more values to expect.
`T`	`get()` Returns the result of the asynchronous operation, throws a RuntimeException if the operation had errors, or throws NoSuchElementException if no result was produced, waiting indefinitely if necessary.
`T`	`get(long time, java.util.concurrent.TimeUnit unit)` Returns the result of the asynchronous operation, throws its exception, throws NoSuchElementException if no result was produced or throws TimeoutException in case of timeout, waiting at most the specified time.
`Option<T>`	`getOption()` Returns the results of the asynchronous operation in the form of an option, blocking and waiting indefinitely if necessary.
`Option<T>`	`getOption(long time, java.util.concurrent.TimeUnit unit)` Returns the results of the asynchronous operation in the form of an option, waiting at most the supplied amount of time, returning null if timeout occurred.
`boolean`	`isDone()`
`void`	`next(T value)` The next value is received.
`java.io.Closeable`	`register(Observer<? super T> observer)` Registers an observer for the notification of Ts.
`protected void`	`unregister(java.io.Closeable c)` Remove the registration of the observable identified by the closeable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - lock
```
@Nonnull
protected final java.util.concurrent.locks.Lock lock
```
    The lock.
  - hasValue
```
protected boolean hasValue
```
    Indication that a value was produced.
  - value
```
@Nullable
protected T value
```
    The last value produced.
  - error
```
@Nullable
protected java.lang.Throwable error
```
    The exception produced.
  - done
```
protected boolean done
```
    Indicator that the source finished.
  - observers
```
@Nonnull
protected java.util.Map<java.io.Closeable,Observer<? super T>> observers
```
    The map of registered observers.
- Constructor Detail
  - AsyncSubject
```
public AsyncSubject()
```
    Creates an AsyncSubject with a fair reentrant lock.
  - AsyncSubject
```
public AsyncSubject(java.util.concurrent.locks.Lock lock)
```
    Creates an AsyncSubject with the supplied lock.
    
    Parameters:
    
    lock - the lock to use
- Method Detail
  - error
```
public void error(@Nonnull
                  java.lang.Throwable ex)
```
    Description copied from interface: BaseObserver
    
    An exception is received.
    
    Specified by:
    
    error in interface BaseObserver
    
    Parameters:
    
    ex - the exception
  - finish
```
public void finish()
```
    Description copied from interface: BaseObserver
    
    No more values to expect.
    
    Specified by:
    
    finish in interface BaseObserver
  - next
```
public void next(T value)
```
    Description copied from interface: Observer
    
    The next value is received.
    
    Specified by:
    
    next in interface Observer<T>
    
    Parameters:
    
    value - the next value
  - register
```
@Nonnull
public java.io.Closeable register(@Nonnull
                                            Observer<? super T> observer)
```
    Description copied from interface: Observable
    
    Registers an observer for the notification of Ts.
    
    Specified by:
    
    register in interface Observable<T>
    
    Parameters:
    
    observer - the observer of Ts or any supertype of it
    
    Returns:
    
    the way of deregister the observer from this provider
  - unregister
```
protected void unregister(@Nonnull
                          java.io.Closeable c)
```
    Remove the registration of the observable identified by the closeable.
    
    Parameters:
    
    c - the registration token to remove
  - isDone
```
public boolean isDone()
```
    Returns:
    
    true if the asynchronous operation is complete
  - getOption
```
@Nonnull
public Option<T> getOption()
                              throws java.lang.InterruptedException
```
    Returns the results of the asynchronous operation in the form of an option, blocking and waiting indefinitely if necessary.
    
    Returns:
    
    the option value
    
    Throws:
    
    java.lang.InterruptedException - in case the wait was interrupted
  - getOption
```
@Nullable
public Option<T> getOption(long time,
                                      @Nonnull
                                      java.util.concurrent.TimeUnit unit)
                               throws java.lang.InterruptedException
```
    Returns the results of the asynchronous operation in the form of an option, waiting at most the supplied amount of time, returning null if timeout occurred.
    
    Parameters:
    
    time - the time value
    
    unit - the time unit
    
    Returns:
    
    the option value if the operation completed within time or null if timeout happened.
    
    Throws:
    
    java.lang.InterruptedException - in case the wait was interrupted
  - get
```
public T get()
      throws java.lang.InterruptedException
```
    Returns the result of the asynchronous operation, throws a RuntimeException if the operation had errors, or throws NoSuchElementException if no result was produced, waiting indefinitely if necessary.
    
    Returns:
    
    the result
    
    Throws:
    
    java.lang.InterruptedException - in case the wait was interrupted
  - get
```
public T get(long time,
             @Nonnull
             java.util.concurrent.TimeUnit unit)
      throws java.lang.InterruptedException,
             java.util.concurrent.TimeoutException
```
    Returns the result of the asynchronous operation, throws its exception, throws NoSuchElementException if no result was produced or throws TimeoutException in case of timeout, waiting at most the specified time.
    
    Parameters:
    
    time - the time to wait
    
    unit - the time unit
    
    Returns:
    
    the result
    
    Throws:
    
    java.lang.InterruptedException - in case the wait was interrupted
    
    java.util.concurrent.TimeoutException - in case the wait timed out

Class AsyncSubject<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lock

hasValue

value

error

done

observers

Constructor Detail

AsyncSubject

AsyncSubject

Method Detail

error

finish

next

register

unregister

isDone

getOption

getOption

get

get