TailableCursorRequest (Spring Data MongoDB 2.1.0.RELEASE API)

java.lang.Object
- org.springframework.data.mongodb.core.messaging.TailableCursorRequest<T>

All Implemented Interfaces:

SubscriptionRequest<org.bson.Document,T,SubscriptionRequest.RequestOptions>
```
public class TailableCursorRequest<T>
extends Object
implements SubscriptionRequest<org.bson.Document,T,SubscriptionRequest.RequestOptions>
```
SubscriptionRequest implementation to be used to listen to query results in a Capped Collection using a Tailable Cursor.
The most trivial use case is subscribing to all events of a specific collection.
```
 
     TailableCursorRequest request = new TailableCursorRequest<>(System.out::println, () -> "collection-name");
 
 
```
TailableCursorRequest.TailableCursorRequestBuilder offers a fluent API for creating TailableCursorRequest with TailableCursorRequest.TailableCursorRequestOptions in one go.
```
   
       TailableCursorRequest request = TailableCursorRequest.builder()
           .collection("collection-name")
           .publishTo(System.out::println)
           .build();
   
 
```
Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TailableCursorRequest.TailableCursorRequestBuilder<T>` Builder for creating `TailableCursorRequest`.
`static class`	`TailableCursorRequest.TailableCursorRequestOptions` `SubscriptionRequest.RequestOptions` implementation specific to a `TailableCursorRequest`.

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.messaging.SubscriptionRequest
SubscriptionRequest.RequestOptions

Constructor Summary

Constructors
Constructor and Description
`TailableCursorRequest(MessageListener<org.bson.Document,? super T> messageListener, SubscriptionRequest.RequestOptions options)` Create a new `TailableCursorRequest` with options, passing `messages` to the given `MessageListener`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TailableCursorRequest.TailableCursorRequestBuilder`	`builder()` Obtain a shiny new `TailableCursorRequest.TailableCursorRequestBuilder` and start defining options in this fancy fluent way.
`static <T> TailableCursorRequest.TailableCursorRequestBuilder<T>`	`builder(MessageListener<org.bson.Document,? super T> listener)` Obtain a shiny new `TailableCursorRequest.TailableCursorRequestBuilder` and start defining options in this fancy fluent way.
`MessageListener<org.bson.Document,? super T>`	`getMessageListener()` Obtain the `MessageListener` to publish `messages` to.
`TailableCursorRequest.TailableCursorRequestOptions`	`getRequestOptions()` Get the `SubscriptionRequest.RequestOptions` specifying the requests behaviour.

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

- Constructor Detail
  - TailableCursorRequest
```
public TailableCursorRequest(MessageListener<org.bson.Document,? super T> messageListener,
                             SubscriptionRequest.RequestOptions options)
```
    Create a new TailableCursorRequest with options, passing messages to the given MessageListener.
    
    Parameters:
    
    messageListener - must not be null.
    
    options - must not be null.
- Method Detail
  - getMessageListener
```
public MessageListener<org.bson.Document,? super T> getMessageListener()
```
    Description copied from interface: SubscriptionRequest
    
    Obtain the MessageListener to publish messages to.
    
    Specified by:
    
    getMessageListener in interface SubscriptionRequest<org.bson.Document,T,SubscriptionRequest.RequestOptions>
    
    Returns:
    
    never null.
  - getRequestOptions
```
public TailableCursorRequest.TailableCursorRequestOptions getRequestOptions()
```
    Description copied from interface: SubscriptionRequest
    
    Get the SubscriptionRequest.RequestOptions specifying the requests behaviour.
    
    Specified by:
    
    getRequestOptions in interface SubscriptionRequest<org.bson.Document,T,SubscriptionRequest.RequestOptions>
    
    Returns:
    
    never null.
  - builder
```
public static TailableCursorRequest.TailableCursorRequestBuilder builder()
```
    Obtain a shiny new TailableCursorRequest.TailableCursorRequestBuilder and start defining options in this fancy fluent way. Just don't forget to call build() when your're done.
    
    Returns:
    
    new instance of TailableCursorRequest.TailableCursorRequestBuilder.
  - builder
```
public static <T> TailableCursorRequest.TailableCursorRequestBuilder<T> builder(MessageListener<org.bson.Document,? super T> listener)
```
    Obtain a shiny new TailableCursorRequest.TailableCursorRequestBuilder and start defining options in this fancy fluent way. Just don't forget to call build() when your're done.
    
    Returns:
    
    new instance of TailableCursorRequest.TailableCursorRequestBuilder.

Class TailableCursorRequest<T>

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.messaging.SubscriptionRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TailableCursorRequest

Method Detail

getMessageListener

getRequestOptions

builder

builder