Module neovim.notifications

Package com.ensarsarajcic.neovim.java.notifications

Class NeovimStreamNotificationHandler

java.lang.Object

com.ensarsarajcic.neovim.java.notifications.NeovimStreamNotificationHandler

All Implemented Interfaces:

NeovimNotificationHandler

public final class NeovimStreamNotificationHandler
extends Object
implements NeovimNotificationHandler

Implementation of NeovimNotificationHandler based on ReactiveRpcStreamer

Utilizes NotificationCreatorCollector for generating actual objects from raw data and ReactiveRpcStreamer for reading incoming notifications. Output should provide properly generated notifications of the right type which can be casted to access notification specific data.

Example:

     
     NeovimNotificationHandler notificationHandler = new NeovimNotificationHandler(streamer);

     notification.uiEvents().subscribe(uiEventSubscriber);
     notification.bufferEvents().subscribe(bufferEventSubscriber);
     
 

Constructor Summary

Constructors

Constructor	Description
NeovimStreamNotificationHandler(ReactiveRpcStreamer reactiveRpcStreamer)	Creates a new NeovimStreamNotificationHandler reading notifications from ReactiveRpcStreamer passed in the constructor.

Method Summary

Modifier and Type	Method	Description
Flow.Publisher<BufferEvent>	bufferEvents()	Passes down a publisher of BufferEvent objects received BufferEvent is a special type of notification that is received when attached to a buffer in Neovim It will never complete
Flow.Publisher<GlobalEvent>	globalEvents()	Passes down a publisher of GlobalEvent objects received GlobalEvent is a superclass of all general nvim notifications It will never complete
Flow.Publisher<NeovimRedrawEvent>	uiEvents()	Passes down a publisher of NeovimRedrawEvent objects received NeovimRedrawEvent is a special type of notification that is received when attached to Neovim It will never complete

Methods inherited from class java.lang.Object

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

Constructor Details

NeovimStreamNotificationHandler

public NeovimStreamNotificationHandler(ReactiveRpcStreamer reactiveRpcStreamer)

Creates a new NeovimStreamNotificationHandler reading notifications from ReactiveRpcStreamer passed in the constructor. It may not be null.

Parameters:

reactiveRpcStreamer - streamer to be used to read notifications

Throws:

NullPointerException - if reactiveRpcStreamer is null

Method Details

uiEvents

public Flow.Publisher<NeovimRedrawEvent> uiEvents()

Description copied from interface: NeovimNotificationHandler

Passes down a publisher of NeovimRedrawEvent objects received NeovimRedrawEvent is a special type of notification that is received when attached to Neovim It will never complete

Specified by:

uiEvents in interface NeovimNotificationHandler

Returns:

Flow.Publisher passing down ui events as they come

bufferEvents

public Flow.Publisher<BufferEvent> bufferEvents()

Description copied from interface: NeovimNotificationHandler

Passes down a publisher of BufferEvent objects received BufferEvent is a special type of notification that is received when attached to a buffer in Neovim It will never complete

Specified by:

bufferEvents in interface NeovimNotificationHandler

Returns:

Flow.Publisher passing down buffer events as they come

globalEvents

public Flow.Publisher<GlobalEvent> globalEvents()

Description copied from interface: NeovimNotificationHandler

Passes down a publisher of GlobalEvent objects received GlobalEvent is a superclass of all general nvim notifications It will never complete

Specified by:

globalEvents in interface NeovimNotificationHandler

Returns:

Flow.Publisher passing down global events as they come