io.reactivesprint.rx

Class Command<I,R>

java.lang.Object

io.reactivesprint.rx.Command<I,R>

All Implemented Interfaces:

ICommand<I,R>

public final class Command<I,R>
extends java.lang.Object
implements ICommand<I,R>

Created by Ahmad Baraka on 5/30/15. Represents a Command or Action that will do some work when executed with I and returns R.

See Also:

apply(Object)

Constructor Summary

Constructors

Constructor and Description
Command(rx.functions.Func1<I,rx.Observable<R>> createObservable) Creates a Command.
Command(IProperty<java.lang.Boolean> enabled, rx.functions.Func1<I,rx.Observable<R>> createObservable) Creates a Command.

Method Summary

Methods

Modifier and Type	Method and Description
rx.Observable<R>	apply() Invokes ICommand.apply(Object) with null.
rx.Observable<R>	apply(I input) Applies the receiver returning an Observable which when subscribed, will execute the command with input and forwards the results.
protected void	finalize()
rx.Observable<java.lang.Throwable>	getErrors() An Observable of all errors that occur in the receiver.
rx.Observable<rx.Notification<R>>	getNotifications() An Observable of all Notification that occur in the receiver.
rx.Observable<R>	getValues() An Observable of Values generated from applications of the receiver.
IProperty<java.lang.Boolean>	isEnabled() Whether or not the receiver is enabled.
IProperty<java.lang.Boolean>	isExecuting() Whether or not the receiver is executing.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(rx.functions.Func1<I,rx.Observable<R>> createObservable)

Creates a Command.

Parameters:

createObservable - Function used to create an Observable each time apply(Object) is invoked.

Command

public Command(IProperty<java.lang.Boolean> enabled,
       rx.functions.Func1<I,rx.Observable<R>> createObservable)

Creates a Command.

Parameters:

enabled - Property whether or not this Command should be enabled.

createObservable - Function used to create an Observable each time apply(Object) is invoked.

Method Detail

apply

public rx.Observable<R> apply()

Description copied from interface: ICommand

Invokes ICommand.apply(Object) with null.

Specified by:

apply in interface ICommand<I,R>

apply

public rx.Observable<R> apply(I input)

Applies the receiver returning an Observable which when subscribed, will execute the command with input and forwards the results.

If Command is executing or not enabled, an Observable with error CommandNotEnabledException is returned.

Note: In case the Observable emits an error, Implementing Error handler is not required. aka. OnErrorNotImplementedException will be ignored since errors are forwarded on getErrors()

Specified by:

apply in interface ICommand<I,R>

getNotifications

public rx.Observable<rx.Notification<R>> getNotifications()

An Observable of all Notification that occur in the receiver.

Specified by:

getNotifications in interface ICommand<I,R>

getValues

public rx.Observable<R> getValues()

An Observable of Values generated from applications of the receiver.

Specified by:

getValues in interface ICommand<I,R>

isEnabled

public IProperty<java.lang.Boolean> isEnabled()

Whether or not the receiver is enabled.

Specified by:

isEnabled in interface ICommand<I,R>

isExecuting

public IProperty<java.lang.Boolean> isExecuting()

Whether or not the receiver is executing.

Specified by:

isExecuting in interface ICommand<I,R>

getErrors

public rx.Observable<java.lang.Throwable> getErrors()

An Observable of all errors that occur in the receiver.

Specified by:

getErrors in interface ICommand<I,R>

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable