OptionPushStreamContext (Gecko Util Pushstream)

java.lang.Object
- org.gecko.util.pushstreams.OptionPushStreamContext<T>

All Implemented Interfaces:

PushStreamConstants, PushStreamContext<T>
```
public class OptionPushStreamContext<T>
extends java.lang.Object
implements PushStreamContext<T>, PushStreamConstants
```
PushStreamContext that gets the information out of an property map

Since:

03.01.2019

Field Summary
- Fields inherited from interface org.gecko.util.pushstreams.PushStreamConstants
  PROP_ACK_CONSUMER, PROP_ACK_ERROR, PROP_ACK_FILTER, PROP_BUFFER_QUEUE, PROP_BUFFER_SIZE, PROP_EXECUTOR, PROP_NACK_CONSUMER, PROP_PARALLELISM, PROP_PUSHBACK_POLICY, PROP_PUSHBACK_POLICY_OPTION, PROP_PUSHBACK_POLICY_OPTION_BY_NAME, PROP_PUSHBACK_POLICY_TIME, PROP_QUEUE_POLICY, PROP_QUEUE_POLICY_BY_NAME, PROP_QUEUE_POLICY_OPTION, PROP_SCHEDULED_EXECUTOR, PROP_SES_BUFFER_QUEUE, PROP_SES_BUFFER_SIZE, PROP_SES_QUEUE_POLICY, PROP_SES_QUEUE_POLICY_BY_NAME, PROP_SES_QUEUE_POLICY_OPTION

Constructor Summary

Constructors
Constructor and Description

OptionPushStreamContext(java.util.Map<java.lang.String,java.lang.Object> options)
Creates a new instance.

Constructors
Constructor and Description
`OptionPushStreamContext(java.util.Map<java.lang.String,java.lang.Object> options)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.function.BiConsumer<java.lang.Throwable,T>`	`getAcknowledgeErrorFunction()` Returns the consumer for the acknowledge error function
`<any>`	`getAcknowledgeFilter()` Returns the acknowledge filter predicate
`<any>`	`getAcknowledgeFunction()` Returns the consumer for the acknowledge function
`java.util.concurrent.BlockingQueue<<any>>`	`getBufferQueue()` Returns a buffer queue to be used
`int`	`getBufferSize()` Returns the buffer size, that should be used in the `PushStream`.
`java.util.concurrent.ExecutorService`	`getExecutor()` Returns the executor service to be used to create the threads
`<any>`	`getNAcknowledgeFunction()` Returns the consumer for the negative acknowledge function
`int`	`getParallelism()` Returns the parallelism.
`<any>`	`getPushbackPolicy()` Returns the pushback policy
`<U extends java.util.concurrent.BlockingQueue<<any>>> <any>`	`getPushbackPolicyByName()` Returns the ready configured `PushbackPolicy`.
`PushbackPolicyOption`	`getPushbackPolicyOption()` Returns the pushback policy option
`java.lang.Long`	`getPushbackPolicyOptionTime()` Returns the used pushback policy option time
`<any>`	`getQueuePolicy()` Returns the queue policy
`<any>`	`getQueuePolicyByName()` Returns the queue policy by name
`QueuePolicyOption`	`getQueuePolicyOption()` Returns the used queue policy option
`java.util.concurrent.ScheduledExecutorService`	`getScheduler()` Returns the scheduled executor to be used

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

Methods inherited from interface org.gecko.util.pushstreams.PushStreamContext
getQueuePolicyByName

- Constructor Detail
  - OptionPushStreamContext
```
public OptionPushStreamContext(java.util.Map<java.lang.String,java.lang.Object> options)
```
    Creates a new instance.
- Method Detail
  - getBufferSize
```
public int getBufferSize()
```
    Description copied from interface: PushStreamContext
    
    Returns the buffer size, that should be used in the PushStream. Valid values are larger than 0
    
    Specified by:
    
    getBufferSize in interface PushStreamContext<T>
    
    Returns:
    
    the buffer size
  - getParallelism
```
public int getParallelism()
```
    Description copied from interface: PushStreamContext
    
    Returns the parallelism. Default is 1. Any values larger than 1 are set
    
    Specified by:
    
    getParallelism in interface PushStreamContext<T>
    
    Returns:
    
    the parallelism
  - getExecutor
```
public java.util.concurrent.ExecutorService getExecutor()
```
    Description copied from interface: PushStreamContext
    
    Returns the executor service to be used to create the threads
    
    Specified by:
    
    getExecutor in interface PushStreamContext<T>
    
    Returns:
    
    the executor service
  - getScheduler
```
public java.util.concurrent.ScheduledExecutorService getScheduler()
```
    Description copied from interface: PushStreamContext
    
    Returns the scheduled executor to be used
    
    Specified by:
    
    getScheduler in interface PushStreamContext<T>
    
    Returns:
    
    the scheduled executor to be used
  - getBufferQueue
```
public java.util.concurrent.BlockingQueue<<any>> getBufferQueue()
```
    Description copied from interface: PushStreamContext
    
    Returns a buffer queue to be used
    
    Specified by:
    
    getBufferQueue in interface PushStreamContext<T>
    
    Returns:
    
    a buffer queue to be used
  - getQueuePolicy
```
public <any> getQueuePolicy()
```
    Description copied from interface: PushStreamContext
    
    Returns the queue policy
    
    Specified by:
    
    getQueuePolicy in interface PushStreamContext<T>
    
    Returns:
    
    the queue policy
  - getQueuePolicyOption
```
public QueuePolicyOption getQueuePolicyOption()
```
    Description copied from interface: PushStreamContext
    
    Returns the used queue policy option
    
    Specified by:
    
    getQueuePolicyOption in interface PushStreamContext<T>
    
    Returns:
    
    the used queue policy option
  - getPushbackPolicy
```
public <any> getPushbackPolicy()
```
    Description copied from interface: PushStreamContext
    
    Returns the pushback policy
    
    Specified by:
    
    getPushbackPolicy in interface PushStreamContext<T>
    
    Returns:
    
    the pushback policy
  - getPushbackPolicyOption
```
public PushbackPolicyOption getPushbackPolicyOption()
```
    Description copied from interface: PushStreamContext
    
    Returns the pushback policy option
    
    Specified by:
    
    getPushbackPolicyOption in interface PushStreamContext<T>
    
    Returns:
    
    the pushback policy option
  - getPushbackPolicyByName
```
public <U extends java.util.concurrent.BlockingQueue<<any>>> <any> getPushbackPolicyByName()
```
    Description copied from interface: PushStreamContext
    
    Returns the ready configured PushbackPolicy. The name must be an enum of PushbackPolicyOption or GeckoPushbackPolicyOption. If none is found a IllegalArgumentException is thrown. This requires, that a pushback option time is configured as well. If not, this will throw a IllegalArgumentException
    
    Specified by:
    
    getPushbackPolicyByName in interface PushStreamContext<T>
    
    Returns:
    
    the ready configured PushbackPolicy
  - getPushbackPolicyOptionTime
```
public java.lang.Long getPushbackPolicyOptionTime()
```
    Description copied from interface: PushStreamContext
    
    Returns the used pushback policy option time
    
    Specified by:
    
    getPushbackPolicyOptionTime in interface PushStreamContext<T>
    
    Returns:
    
    the used pushback policy option time
  - getAcknowledgeFilter
```
public <any> getAcknowledgeFilter()
```
    Description copied from interface: PushStreamContext
    
    Returns the acknowledge filter predicate
    
    Specified by:
    
    getAcknowledgeFilter in interface PushStreamContext<T>
    
    Returns:
    
    the acknowledge filter predicate
  - getAcknowledgeFunction
```
public <any> getAcknowledgeFunction()
```
    Description copied from interface: PushStreamContext
    
    Returns the consumer for the acknowledge function
    
    Specified by:
    
    getAcknowledgeFunction in interface PushStreamContext<T>
    
    Returns:
    
    the consumer for the acknowledge function
  - getNAcknowledgeFunction
```
public <any> getNAcknowledgeFunction()
```
    Description copied from interface: PushStreamContext
    
    Returns the consumer for the negative acknowledge function
    
    Specified by:
    
    getNAcknowledgeFunction in interface PushStreamContext<T>
    
    Returns:
    
    the consumer for the negative acknowledge function
  - getAcknowledgeErrorFunction
```
public java.util.function.BiConsumer<java.lang.Throwable,T> getAcknowledgeErrorFunction()
```
    Description copied from interface: PushStreamContext
    
    Returns the consumer for the acknowledge error function
    
    Specified by:
    
    getAcknowledgeErrorFunction in interface PushStreamContext<T>
    
    Returns:
    
    the consumer for the acknowledge error function
  - getQueuePolicyByName
```
public <any> getQueuePolicyByName()
```
    Description copied from interface: PushStreamContext
    
    Returns the queue policy by name
    
    Specified by:
    
    getQueuePolicyByName in interface PushStreamContext<T>
    
    Returns:
    
    the queue policy

Class OptionPushStreamContext<T>

Field Summary

Fields inherited from interface org.gecko.util.pushstreams.PushStreamConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.gecko.util.pushstreams.PushStreamContext

Constructor Detail

OptionPushStreamContext

Method Detail

getBufferSize

getParallelism

getExecutor

getScheduler

getBufferQueue

getQueuePolicy

getQueuePolicyOption

getPushbackPolicy

getPushbackPolicyOption

getPushbackPolicyByName

getPushbackPolicyOptionTime

getAcknowledgeFilter

getAcknowledgeFunction

getNAcknowledgeFunction

getAcknowledgeErrorFunction

getQueuePolicyByName