com.prosysopc.ua.pubsub

Interface PubSubConf

All Known Subinterfaces:

PubSubBrokerConnectionConf<T,S>, PubSubBrokerTransportSettingsConf, PubSubConnectionConf<T,S>, PubSubDataSetConf, PubSubDataSetReaderConf, PubSubDataSetWriterConf, PubSubGroupConf, PubSubJsonDataSetReaderConf, PubSubJsonDataSetWriterConf, PubSubJsonReaderGroupConf<T>, PubSubJsonWriterGroupConf<T>, PubSubNamedConf, PubSubReaderGroupConf<T>, PubSubUadpDataSetReaderConf, PubSubUadpDataSetWriterConf, PubSubUadpReaderGroupConf<T>, PubSubUadpWriterGroupConf<T>, PubSubWriterGroupConf<T>

All Known Implementing Classes:

PubSubBrokerAuthConf, PubSubDataSetMetaDataConf, PubSubEventDataSetConf, PubSubFieldMetaDataConf, PubSubFieldTargetConf, PubSubMqttJsonConnectionConf, PubSubMqttJsonDataSetReaderConf, PubSubMqttJsonDataSetWriterConf, PubSubMqttJsonReaderGroupConf, PubSubMqttJsonWriterGroupConf, PubSubMqttProviderConf, PubSubMqttUadpConnectionConf, PubSubMqttUadpDataSetReaderConf, PubSubMqttUadpDataSetWriterConf, PubSubMqttUadpReaderGroupConf, PubSubMqttUadpWriterGroupConf, PubSubPublishedVariableConf, PubSubSecurityConf, PubSubSystemConf, PubSubTargetVariablesConf, PubSubUdpUadpConnectionConf, PubSubUdpUadpDataSetReaderConf, PubSubUdpUadpDataSetWriterConf, PubSubUdpUadpReaderGroupConf, PubSubUdpUadpWriterGroupConf, PubSubVariableDataSetConf

public interface PubSubConf

Super-interface for all PubSub configuration interfaces and objects. IMPORTANT! This interface should be considered as sealed, i.e. only implementations within the SDK are supported. All implementations are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PubSubConf.Builder<T extends PubSubConf.Builder<T>> Super interface for all Builders of all PubSubConfs.
static class	PubSubConf.MapKind<T> Different kinds of Maps the configuration can be converted into.

Method Summary

Modifier and Type	Method and Description
default <T> T	get(PubSubConfFieldSpecification<T> field) Returns the value of the given field.
default Object	get(String fieldName) Returns the value of the given field.
PubSubConfSpecification	specification() Returns the specification of this object.
PubSubConf.Builder<?>	toBuilder() Returns a Builder initialised with fields of this object.
default <T> T	toMap(PubSubConf.MapKind<T> kind) Converts this configuration to a Map based on given PubSubConf.MapKind PubSubConf.MapKind.MapOptions.

Method Detail

get

default <T> T get(PubSubConfFieldSpecification<T> field)

Returns the value of the given field. Throws ClassCastException if this object doesn't have the field.

get

default Object get(String fieldName)

Returns the value of the given field. Throws IllegalArgumentException if the specification() doesn't have field with the given name.

specification

PubSubConfSpecification specification()

Returns the specification of this object. Can be used to dynamically display the fields of the PubSubConf object.

toBuilder

PubSubConf.Builder<?> toBuilder()

Returns a Builder initialised with fields of this object. The PubSubConf.Builder.build() method shall return the same class instances as this object is.

toMap

default <T> T toMap(PubSubConf.MapKind<T> kind)

Converts this configuration to a Map based on given PubSubConf.MapKind PubSubConf.MapKind.MapOptions.