RxJavaPlugins (RxJava Javadoc 1.2.2)

java.lang.Object
- rx.plugins.RxJavaPlugins

```
public class RxJavaPlugins
extends java.lang.Object
```
Registry for plugin implementations that allows global override and handles the retrieval of correct implementation based on order of precedence:
1. plugin registered globally via register methods in this class
2. plugin registered and retrieved using System.getProperty(String) (see get methods for property names)
3. default implementation
In addition to the rxjava.plugin.[simple class name].implementation system properties, you can define two system property:
```
 rxjava.plugin.[index].class}
 rxjava.plugin.[index].impl}
 
```
Where the .class property contains the simple class name from above and the .impl contains the fully qualified name of the implementation class. The [index] can be any short string or number of your choosing. For example, you can now define a custom RxJavaErrorHandler via two system property:
```
 rxjava.plugin.1.class=RxJavaErrorHandler
 rxjava.plugin.1.impl=some.package.MyRxJavaErrorHandler
 
```
See Also:
RxJava Wiki: Plugins Use the {@link RxJavaHooks} features instead which let's you change individual handlers at runtime.

Method Summary

Methods
Modifier and Type	Method and Description
`RxJavaCompletableExecutionHook`	`getCompletableExecutionHook()` Retrieves the instance of `RxJavaCompletableExecutionHook` to use based on order of precedence as defined in `RxJavaPlugins` class header.
`RxJavaErrorHandler`	`getErrorHandler()` Retrieves an instance of `RxJavaErrorHandler` to use based on order of precedence as defined in `RxJavaPlugins` class header.
`static RxJavaPlugins`	`getInstance()` Deprecated. use the static methods of `RxJavaHooks`.
`RxJavaObservableExecutionHook`	`getObservableExecutionHook()` Retrieves the instance of `RxJavaObservableExecutionHook` to use based on order of precedence as defined in `RxJavaPlugins` class header.
`RxJavaSchedulersHook`	`getSchedulersHook()` Retrieves the instance of `RxJavaSchedulersHook` to use based on order of precedence as defined in the `RxJavaPlugins` class header.
`RxJavaSingleExecutionHook`	`getSingleExecutionHook()` Retrieves the instance of `RxJavaSingleExecutionHook` to use based on order of precedence as defined in `RxJavaPlugins` class header.
`void`	`registerCompletableExecutionHook(RxJavaCompletableExecutionHook impl)` Register an `RxJavaCompletableExecutionHook` implementation as a global override of any injected or default implementations.
`void`	`registerErrorHandler(RxJavaErrorHandler impl)` Registers an `RxJavaErrorHandler` implementation as a global override of any injected or default implementations.
`void`	`registerObservableExecutionHook(RxJavaObservableExecutionHook impl)` Register an `RxJavaObservableExecutionHook` implementation as a global override of any injected or default implementations.
`void`	`registerSchedulersHook(RxJavaSchedulersHook impl)` Registers an `RxJavaSchedulersHook` implementation as a global override of any injected or default implementations.
`void`	`registerSingleExecutionHook(RxJavaSingleExecutionHook impl)` Register an `RxJavaSingleExecutionHook` implementation as a global override of any injected or default implementations.
`void`	`reset()` Reset `RxJavaPlugins` instance

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

- Method Detail
  - getInstance
```
@Deprecated
public static RxJavaPlugins getInstance()
```
    Deprecated. use the static methods of RxJavaHooks.
    
    Retrieves the single RxJavaPlugins instance.
    
    Returns:
    the single RxJavaPlugins instance
  - reset
```
@Experimental
public void reset()
```
    Reset RxJavaPlugins instance
    This API is experimental. Resetting the plugins is dangerous during application runtime and also bad code could invoke it in the middle of an application life-cycle and really break applications if not used cautiously. For more detailed discussions: * @see Make RxJavaPlugins.reset() public
  - getErrorHandler
```
public RxJavaErrorHandler getErrorHandler()
```
    Retrieves an instance of RxJavaErrorHandler to use based on order of precedence as defined in RxJavaPlugins class header.
    Override the default by calling registerErrorHandler(RxJavaErrorHandler) or by setting the property rxjava.plugin.RxJavaErrorHandler.implementation with the full class name to load.
    
    Returns:
    RxJavaErrorHandler implementation to use
  - registerErrorHandler
```
public void registerErrorHandler(RxJavaErrorHandler impl)
```
    Registers an RxJavaErrorHandler implementation as a global override of any injected or default implementations.
    
    Parameters:
    impl - RxJavaErrorHandler implementation
    
    Throws:
    
    java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)
  - getObservableExecutionHook
```
public RxJavaObservableExecutionHook getObservableExecutionHook()
```
    Retrieves the instance of RxJavaObservableExecutionHook to use based on order of precedence as defined in RxJavaPlugins class header.
    Override the default by calling registerObservableExecutionHook(RxJavaObservableExecutionHook) or by setting the property rxjava.plugin.RxJavaObservableExecutionHook.implementation with the full class name to load.
    
    Returns:
    RxJavaObservableExecutionHook implementation to use
  - registerObservableExecutionHook
```
public void registerObservableExecutionHook(RxJavaObservableExecutionHook impl)
```
    Register an RxJavaObservableExecutionHook implementation as a global override of any injected or default implementations.
    
    Parameters:
    impl - RxJavaObservableExecutionHook implementation
    
    Throws:
    
    java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)
  - getSingleExecutionHook
```
public RxJavaSingleExecutionHook getSingleExecutionHook()
```
    Retrieves the instance of RxJavaSingleExecutionHook to use based on order of precedence as defined in RxJavaPlugins class header.
    Override the default by calling registerSingleExecutionHook(RxJavaSingleExecutionHook) or by setting the property rxjava.plugin.RxJavaSingleExecutionHook.implementation with the full class name to load.
    
    Returns:
    RxJavaSingleExecutionHook implementation to use
  - registerSingleExecutionHook
```
public void registerSingleExecutionHook(RxJavaSingleExecutionHook impl)
```
    Register an RxJavaSingleExecutionHook implementation as a global override of any injected or default implementations.
    
    Parameters:
    impl - RxJavaSingleExecutionHook implementation
    
    Throws:
    
    java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)
  - getCompletableExecutionHook
```
@Experimental
public RxJavaCompletableExecutionHook getCompletableExecutionHook()
```
    Retrieves the instance of RxJavaCompletableExecutionHook to use based on order of precedence as defined in RxJavaPlugins class header.
    Override the default by calling registerCompletableExecutionHook(RxJavaCompletableExecutionHook) or by setting the property rxjava.plugin.RxJavaCompletableExecutionHook.implementation with the full class name to load.
    
    Returns:
    RxJavaCompletableExecutionHook implementation to use
    Since:
    
    (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
  - registerCompletableExecutionHook
```
@Experimental
public void registerCompletableExecutionHook(RxJavaCompletableExecutionHook impl)
```
    Register an RxJavaCompletableExecutionHook implementation as a global override of any injected or default implementations.
    
    Parameters:
    impl - RxJavaCompletableExecutionHook implementation
    
    Throws:
    
    java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)
    Since:
    
    (if this graduates from Experimental/Beta to supported, replace this parenthetical with the release number)
  - getSchedulersHook
```
public RxJavaSchedulersHook getSchedulersHook()
```
    Retrieves the instance of RxJavaSchedulersHook to use based on order of precedence as defined in the RxJavaPlugins class header.
    Override the default by calling registerSchedulersHook(RxJavaSchedulersHook) or by setting the property rxjava.plugin.RxJavaSchedulersHook.implementation with the full class name to load.
    
    Returns:
    the RxJavaSchedulersHook implementation in use
  - registerSchedulersHook
```
public void registerSchedulersHook(RxJavaSchedulersHook impl)
```
    Registers an RxJavaSchedulersHook implementation as a global override of any injected or default implementations.
    
    Parameters:
    impl - RxJavaSchedulersHook implementation
    
    Throws:
    
    java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)

Class RxJavaPlugins

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

reset

getErrorHandler

registerErrorHandler

getObservableExecutionHook

registerObservableExecutionHook

getSingleExecutionHook

registerSingleExecutionHook

getCompletableExecutionHook

registerCompletableExecutionHook

getSchedulersHook

registerSchedulersHook