Package org.apache.qpid.protonj2.client

Class SourceOptions

java.lang.Object

org.apache.qpid.protonj2.client.TerminusOptions<SourceOptions>

org.apache.qpid.protonj2.client.SourceOptions

All Implemented Interfaces:

Cloneable

public final class SourceOptions
extends TerminusOptions<SourceOptions>
implements Cloneable

Options type that carries configuration for link Source types.

Field Summary

Fields

Modifier and Type	Field	Description
static final ClientDeliveryState	DEFAULT_RECEIVER_OUTCOME	The default AMQP Outcome that will be specified for all new Receiver instances.

Constructor Summary

Constructors

Constructor	Description
SourceOptions()

Method Summary

Modifier and Type	Method	Description
SourceOptions	addFilter(String name, Object descriptor, Object filter)	Adds the given named filter into the map of filters (one will be created if not already set).
SourceOptions	clone()
protected SourceOptions	copyInto(SourceOptions other)	Copy all options from this SourceOptions instance into the instance provided.
DeliveryState	defaultOutcome()
SourceOptions	defaultOutcome(DeliveryState defaultOutcome)
DistributionMode	distributionMode()
SourceOptions	distributionMode(DistributionMode distributionMode)
Map<String,Object>	filters()
SourceOptions	filters(Map<String,Object> filters)
DeliveryState.Type[]	outcomes()
SourceOptions	outcomes(DeliveryState.Type... outcomes)

Methods inherited from class org.apache.qpid.protonj2.client.TerminusOptions

capabilities, capabilities, copyInto, durabilityMode, durabilityMode, expiryPolicy, expiryPolicy, timeout, timeout

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_RECEIVER_OUTCOME

public static final ClientDeliveryState DEFAULT_RECEIVER_OUTCOME

The default AMQP Outcome that will be specified for all new Receiver instances.

Constructor Details

SourceOptions

public SourceOptions()

Method Details

clone

public SourceOptions clone()

Overrides:

clone in class Object

copyInto

protected SourceOptions copyInto(SourceOptions other)

Copy all options from this SourceOptions instance into the instance provided.

Parameters:

other - the target of this copy operation.

Returns:

this SourceOptions instance.

distributionMode

public DistributionMode distributionMode()

Returns:

the distributionMode

distributionMode

public SourceOptions distributionMode(DistributionMode distributionMode)

Parameters:

distributionMode - the distributionMode to set

Returns:

this SourceOptions instance.

filters

public Map<String,Object> filters()

Returns:

the filters

filters

public SourceOptions filters(Map<String,Object> filters)

Parameters:

filters - the filters to set

Returns:

this SourceOptions instance.

addFilter

public SourceOptions addFilter(String name,
 Object descriptor,
 Object filter)

Adds the given named filter into the map of filters (one will be created if not already set).

If a previous filters Map was assigned this new filter instance will be assigned into that existing map, it is not cleared or reallocated. The descriptor should either be an Symbol or UnsignedLong that aligns with the filters definition being used.

Parameters:

name - The name to use when adding the described filter to the filters Map.

descriptor - The descriptor used for the DescribedType that will carry the filter.

filter - The filter value to assign to the filter DescribedType.

Returns:

this SourceOptions instance.

defaultOutcome

public DeliveryState defaultOutcome()

Returns:

the configured default outcome as a DeliveryState instance.

defaultOutcome

public SourceOptions defaultOutcome(DeliveryState defaultOutcome)

Parameters:

defaultOutcome - The default outcome to assign to the created link source.

Returns:

this SourceOptions instance.

outcomes

public DeliveryState.Type[] outcomes()

Returns:

the currently configured supported outcomes to be used on the create link.

outcomes

public SourceOptions outcomes(DeliveryState.Type... outcomes)

Parameters:

outcomes - The supported outcomes for the link created Source.

Returns:

this SourceOptions instance.