io.nats.client

Class SubscribeOptions.Builder<B,SO>

java.lang.Object

io.nats.client.SubscribeOptions.Builder<B,SO>

Direct Known Subclasses:

PullSubscribeOptions.Builder, PushSubscribeOptions.Builder

Enclosing class:

SubscribeOptions

protected abstract static class SubscribeOptions.Builder<B,SO>
extends java.lang.Object

PushSubscribeOptions can be created using a Builder. The builder supports chaining and will create a default set of options if no methods are calls.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bind
protected ConsumerConfiguration	cc
protected java.lang.String	durable
protected boolean	fastBind
protected long	messageAlarmTime
protected java.lang.String	name
protected boolean	ordered
protected java.lang.String	stream

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
B	bind(boolean bind) Specify binding to an existing consumer via name.
abstract SO	build() Builds the subscribe options.
B	configuration(ConsumerConfiguration configuration) The consumer configuration.
B	durable(java.lang.String durable) Sets the durable name for the consumer.
protected abstract B	getThis()
B	messageAlarmTime(long messageAlarmTime) Set the total amount of time to not receive any messages or heartbeats before calling the ErrorListener heartbeatAlarm
B	name(java.lang.String name) Sets the name of the consumer.
B	stream(java.lang.String stream) Specify the stream to attach to.

Methods inherited from class java.lang.Object

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

Field Detail

stream

protected java.lang.String stream

bind

protected boolean bind

fastBind

protected boolean fastBind

durable

protected java.lang.String durable

name

protected java.lang.String name

cc

protected ConsumerConfiguration cc

messageAlarmTime

protected long messageAlarmTime

ordered

protected boolean ordered

Constructor Detail

Builder

protected Builder()

Method Detail

getThis

protected abstract B getThis()

stream

public B stream(java.lang.String stream)

Specify the stream to attach to. If not supplied the stream will be looked up by subject. Null or empty clears the field.

Parameters:

stream - the name of the stream

Returns:

the builder

bind

public B bind(boolean bind)

Specify binding to an existing consumer via name. The client validates regular (non-fast) binds to ensure that provided consumer configuration is consistent with the server version and that consumer type (push versus pull) matches the subscription type.

Parameters:

bind - whether to bind or not

Returns:

the builder

durable

public B durable(java.lang.String durable)

Sets the durable name for the consumer. Null or empty clears the field.

Parameters:

durable - the durable name

Returns:

the builder

name

public B name(java.lang.String name)

Sets the name of the consumer. Null or empty clears the field.

Parameters:

name - name of the consumer.

Returns:

the builder

configuration

public B configuration(ConsumerConfiguration configuration)

The consumer configuration. The configuration durable name will be replaced if you supply a consumer name in the builder. The configuration deliver subject will be replaced if you supply a name in the builder.

Parameters:

configuration - the consumer configuration.

Returns:

the builder

messageAlarmTime

public B messageAlarmTime(long messageAlarmTime)

Set the total amount of time to not receive any messages or heartbeats before calling the ErrorListener heartbeatAlarm

Parameters:

messageAlarmTime - the time

Returns:

the builder

build

public abstract SO build()

Builds the subscribe options.

Returns:

subscribe options