A B C D E F G H I K L M N O P R S T U V W Z
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ADD - org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction.UpdateType
- ADD_DATA - org.openmuc.jeebus.spine.api.DataUpdateType
-
A full write adds a new data entry.
- AddableFeature - Interface in org.openmuc.jeebus.spine.utils.features
- addAddressMapping(String, String) - Method in interface org.openmuc.jeebus.spine.api.ConnectionHandler
-
Associates the SPINE device address with the address used in the communication protocol.
- addBindingListener(BindingListener) - Method in interface org.openmuc.jeebus.spine.api.Feature
- addCharacteristicListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- addConnectionStateListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- addData(DATA) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Adds given data and notifies subscribers.
- addData(List<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Adds given data and notifies subscribers.
- addDataList(ReadListFeatureFunction<DATA, ?, ?, ?, ?>, List<DATA>, DataUpdateTransaction.AfterUpdateListCall) - Method in class org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction
-
Add a list of data objects that should be added to the feature function for this transaction.
- addDescriptionListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- addDevice(String) - Method in class org.openmuc.jeebus.spine.spi.Communication
-
Notifies device listeners of this device and starts the detailed discovery process if enabled
- addDeviceListener(DeviceListener) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Adds a listener which will get notified when the communication protocol detects a new device.
- addDeviceListener(DeviceListener) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Adds the given
DeviceListener
to the device. - added(DATA, int) - Static method in class org.openmuc.jeebus.spine.spi.function.DataUpdate
- addEntity() - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Creates a new EntityBuilder instance.
- addEntity() - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
-
Creates a new EntityBuilder instance.
- addEntity(Entity) - Method in interface org.openmuc.jeebus.spine.api.EntityParent
-
Adds an entity with all its sub-entities and features to this device/entity at runtime.
- addEventListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- addFeature() - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
-
Creates a new FeatureBuilder instance.
- addFeature(Feature) - Method in interface org.openmuc.jeebus.spine.api.Entity
-
Adds a feature to this entity at runtime.
- addFeature(Feature) - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
- addFeature(AddableFeature) - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
- addFunction(FeatureFunction) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Adds the passed SPINE function to the feature.
- addFunction(FeatureFunction) - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
- addHeartBeatDataFunction(long) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- AdditionalSelectorCondition<DATA,SELECTOR> - Interface in org.openmuc.jeebus.spine.spi
-
This functional interface is to be used by
AdditionalSelectorConditions.register(java.lang.Class<DATA>, java.lang.Class<SELECTOR>, org.openmuc.jeebus.spine.spi.AdditionalSelectorCondition<DATA, SELECTOR>)
if an additional condition is needed to check if data matches a selector. - AdditionalSelectorConditions - Class in org.openmuc.jeebus.spine.spi
-
Registry class for
AdditionalSelectorCondition
. - addKeyValueConstraintsListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationFeature
- addKeyValueDescriptionListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationFeature
- addKeyValueListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationFeature
- addLimitConstraintsDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- addLimitDescriptionFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- addLimitListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- addMeasurementConstraintsListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- addMeasurementDescriptionListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- addMeasurementListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- addMeasurementSeriesListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- addMeasurementThresholdRelationListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- addNodeDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- addParameterDescriptionListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- addPermittedValueSetListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- addServiceDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- addSingleData(ReadListFeatureFunction<DATA, ?, ?, ?, ?>, DATA, DataUpdateTransaction.AfterUpdateSingleCall) - Method in class org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction
-
Add a single data object to the given function for this transaction.
- addSingleData(ReadSingleFeatureFunction<DATA, ?, ?>, DATA) - Method in class org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction
- addStateDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- addStateListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- addUseCase(UseCase) - Method in interface org.openmuc.jeebus.spine.api.Device
-
Add a use case to this device.
- addUseCase(UseCase) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Adds the passed SPINE use case to this device.
- addUseCase(UseCase) - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
- addUseCaseListener(UseCaseListener, String, String, Map<Long, PresenceIndication>, Set<FeatureFunctionRequirement>) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Register a new UseCaseListener that is called when a remote device supports the given use case as the given actor.
- aDeviceConfigurationKeyValueDataType() - Static method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDataTypeBuilder
- allowedReadCmdOptions - Variable in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- allowedReadListCmdOptions - Variable in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- aLoadControlLimitDataType() - Static method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
- appendClassName(StringBuilder, Object) - Method in class org.openmuc.jeebus.spine.impl.parser.CustomToStringStrategy
- appendField(ObjectLocator, Object, String, StringBuilder, Object, boolean) - Method in class org.openmuc.jeebus.spine.impl.parser.CustomToStringStrategy
- apply() - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
-
Builds this feature and adds it to the parent entity.
- applyAndGetStaticAddress() - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
-
Convenience method for calling
EntityBuilder.applyToDevice()
and getting the address of the newEntity
. - applyToDevice() - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
-
Builds this entity and adds it to the parent device.
- applyToEntity() - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
-
Builds this entity and adds it to the parent entity.
- asEntry() - Method in class org.openmuc.jeebus.spine.utils.datatypes.Pair
B
- BINDING_NECESSARY - org.openmuc.jeebus.spine.api.Error
- bindingAllowed(NodeManagementBindingRequestCallType.BindingRequest) - Method in interface org.openmuc.jeebus.spine.spi.FeaturePermission
- BindingListener - Interface in org.openmuc.jeebus.spine.spi
-
A listener interface meant to be registered at a
Feature
. - bindingRequired() - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- build() - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Builds the SPINE device and connects it to the communication network.
- build() - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
-
Builds the SPINE entity.
- build() - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
-
Builds the SPINE feature.
- build() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDataTypeBuilder
- build() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
- buildFeature() - Method in interface org.openmuc.jeebus.spine.utils.features.AddableFeature
- buildFeature() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationFeature
- buildFeature() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- buildFeature() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- buildFeature() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- buildFeature() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- buildListDataType(List<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.ListFeatureFunctionTypeInfo
-
Builds and returns the
ListFeatureFunctionTypeInfo
type object for a givenListFeatureFunctionTypeInfo
type list. - buildWithoutConnecting() - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Builds the SPINE device, but does not connect it to the communication network.
- but() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDataTypeBuilder
- but() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
C
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueConstraintsListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDescriptionListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.HeartbeatDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.ServiceDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.StateDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.CharacteristicListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.DescriptionListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ParameterDescriptionListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.PermittedValueSetListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.StateListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.EventListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitConstraintsDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitDescriptionFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.NodeDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.StateListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementConstraintsListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementDescriptionListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementSeriesListDataFunction
- call(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementThresholdRelationListDataFunction
- CharacteristicListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.electricalconnection
- checkAndSetDataOutOfRange(MeasurementDataType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementListDataFunction
-
Checks if data is out of range and sets value state to out of range is so.
- checkAndSetDataOutOfRange(MeasurementSeriesDataType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementSeriesListDataFunction
-
Checks if data is out of range and sets value state to out of range is so.
- close() - Method in interface org.openmuc.jeebus.spine.api.Shutdownable
-
Cleanly and promptly shut down this object, as well as all child objects and objects depending on this one.
- close() - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- close() - Method in interface org.openmuc.jeebus.spine.spi.SpineConnection
- close() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.HeartbeatDataFunction
- closeConnection(String) - Method in interface org.openmuc.jeebus.spine.api.ConnectionHandler
- COMMAND_NOT_SUPPORTED - org.openmuc.jeebus.spine.api.Error
- COMMAND_REJECTED - org.openmuc.jeebus.spine.api.Error
- Communication - Class in org.openmuc.jeebus.spine.spi
- Communication() - Constructor for class org.openmuc.jeebus.spine.spi.Communication
- connect() - Method in class org.openmuc.jeebus.spine.spi.Communication
-
Connects to the network, i.e.
- ConnectionHandler - Interface in org.openmuc.jeebus.spine.api
- consumeRight(Consumer<R>) - Method in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
Eliminator method: apply a consumer to one value and return the other.
- createInterfaceGroup() - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Creates a new interface group which communication addresses can be assigned to.
- createNewDataWithTaggedElements(T, Object) - Static method in class org.openmuc.jeebus.spine.utils.SpineObjects
-
This method copies the given data object but only sets elements (attributes) that are tagged by the given elements.
- CustomToStringStrategy - Class in org.openmuc.jeebus.spine.impl.parser
- CustomToStringStrategy() - Constructor for class org.openmuc.jeebus.spine.impl.parser.CustomToStringStrategy
D
- data - Variable in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- dataCopy(T) - Static method in class org.openmuc.jeebus.spine.utils.SpineObjects
-
Create a deep copy of the given data and return it.
- dataEquals(Object, Object) - Static method in class org.openmuc.jeebus.spine.utils.SpineObjects
-
Checks if data a equals data b.
- DataFeatureFunctionTypeInfo<DATA,ELEMENTS> - Class in org.openmuc.jeebus.spine.spi.function
-
Immutable wrapper class to hold the run-time type information used by the generic feature functions.
- DataFeatureFunctionTypeInfo(Class<DATA>, Class<ELEMENTS>) - Constructor for class org.openmuc.jeebus.spine.spi.function.DataFeatureFunctionTypeInfo
- DataIdDescription<DATA> - Class in org.openmuc.jeebus.spine.impl
- DataIdDescription(Class<DATA>, List<String>) - Constructor for class org.openmuc.jeebus.spine.impl.DataIdDescription
-
Defines the names of the attributes that uniquely identify data objects from a Feature Function data list (SPINE protocol spec 5.3.4.6) and stores the
PropertyDescriptor
s for each attribute. - DataIdDescription(Class<DATA>, List<String>, List<String>) - Constructor for class org.openmuc.jeebus.spine.impl.DataIdDescription
-
Defines the names of the attributes that uniquely identify data objects from a Feature Function data list (SPINE protocol spec 5.3.4.6) and optional sub identifiers that may be used to sub identify a FeatureFunction and stores the
PropertyDescriptor
s for each attribute. - DataIdDescription.IdValidationStatus - Enum in org.openmuc.jeebus.spine.impl
- dataList - Variable in class org.openmuc.jeebus.spine.spi.function.DataListHolder
- dataListHolder - Variable in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- DataListHolder<DATA,SELECTOR> - Class in org.openmuc.jeebus.spine.spi.function
-
Holder class that encapsulates access to the list of DATA objects used for
ReadListFeatureFunction
andReadAndWriteListFeatureFunction
. - DataListHolder(ListFeatureFunctionTypeInfo<DATA, ?, SELECTOR, ?>) - Constructor for class org.openmuc.jeebus.spine.spi.function.DataListHolder
- dataLock - Variable in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- dataMatchesAnySelector(DATA, List<SELECTOR>, ListFeatureFunctionTypeInfo<DATA, ?, SELECTOR, ?>) - Static method in class org.openmuc.jeebus.spine.utils.Selectors
-
This method checks if the given data object matches any of the given selectors.
- dataMatchesForIdDescription(DATA, DATA) - Method in class org.openmuc.jeebus.spine.impl.DataIdDescription
-
Checks if the ids of writable match the ids of update.
- DataUpdate<DATA> - Class in org.openmuc.jeebus.spine.spi.function
-
Data class that holds the parameters to
ReadAndWriteListFeatureFunction.writeData(Object, DataUpdateType, Integer)
. - DataUpdate(DATA, DataUpdateType, Integer) - Constructor for class org.openmuc.jeebus.spine.spi.function.DataUpdate
- DataUpdateTransaction - Class in org.openmuc.jeebus.spine.spi.function
- DataUpdateTransaction() - Constructor for class org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction
-
Create an instance of this class to add data for multiple feature functions with validation happening for the state after all data is added.
- DataUpdateTransaction.AfterUpdateListCall - Interface in org.openmuc.jeebus.spine.spi.function
- DataUpdateTransaction.AfterUpdateSingleCall - Interface in org.openmuc.jeebus.spine.spi.function
- DataUpdateTransaction.UpdateType - Enum in org.openmuc.jeebus.spine.spi.function
- DataUpdateType - Enum in org.openmuc.jeebus.spine.api
-
The type for which a listener is called.
- DataValidation<DATA> - Interface in org.openmuc.jeebus.spine.api.validation
- DataValidationException - Exception in org.openmuc.jeebus.spine.api
- DataValidationException(String) - Constructor for exception org.openmuc.jeebus.spine.api.DataValidationException
- DataValidationException(String, Throwable) - Constructor for exception org.openmuc.jeebus.spine.api.DataValidationException
- dateTimeToRelativeMilliseconds(String) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- deepCopyList(List<T>) - Static method in class org.openmuc.jeebus.spine.utils.SpineObjects
- DELETE - org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction.UpdateType
- DELETE_BY_SELECTOR - org.openmuc.jeebus.spine.api.options.WriteListCmdOption
- DELETE_DATA - org.openmuc.jeebus.spine.api.DataUpdateType
-
A delete write command with SELECTORS (without ELEMENTS) that fully deleted a list entry.
- DELETE_ELEMENTS - org.openmuc.jeebus.spine.api.options.WriteListCmdOption
- DELETE_ELEMENTS - org.openmuc.jeebus.spine.api.options.WriteSingleCmdOption
- DELETE_ELEMENTS_BY_SELECTOR - org.openmuc.jeebus.spine.api.options.WriteListCmdOption
- deleteConstraints() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- deleted(DATA, int) - Static method in class org.openmuc.jeebus.spine.spi.function.DataUpdate
- deleteData() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- deleteDataEntriesBySelector(List<SELECTOR>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
-
Deletes data entries for selectors and notifies subscribers that data entries were deleted.
- deleteDescription() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- deleteElements(Object, Object) - Static method in class org.openmuc.jeebus.spine.utils.SpineObjects
-
Deletes the elements that are defined by the given elements in the given data object.
- deleteEntity(int) - Method in interface org.openmuc.jeebus.spine.api.EntityParent
- deleteFeature(int) - Method in interface org.openmuc.jeebus.spine.api.Entity
- DescriptionListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.electricalconnection
- DESTINATION_UNKNOWN - org.openmuc.jeebus.spine.api.Error
- DESTINATION_UNREACHABLE - org.openmuc.jeebus.spine.api.Error
- device - Variable in class org.openmuc.jeebus.spine.spi.Communication
- Device - Interface in org.openmuc.jeebus.spine.api
- DeviceBuilder - Class in org.openmuc.jeebus.spine.impl
- DeviceBuilder() - Constructor for class org.openmuc.jeebus.spine.impl.DeviceBuilder
- DeviceConfigurationFeature - Class in org.openmuc.jeebus.spine.utils.features.deviceconfiguration
- DeviceConfigurationFeature() - Constructor for class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationFeature
- DeviceConfigurationUtilities - Class in org.openmuc.jeebus.spine.utils.features.deviceconfiguration
- DeviceConfigurationUtilities() - Constructor for class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationUtilities
- deviceDetected(String) - Method in interface org.openmuc.jeebus.spine.api.Device
-
Starts the detailed discovery process if enabled
- deviceDetected(String) - Method in interface org.openmuc.jeebus.spine.spi.DeviceListener
- DeviceDiagnosisFeature - Class in org.openmuc.jeebus.spine.utils.features.devicediagnosis
- DeviceDiagnosisFeature() - Constructor for class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- deviceDiscovered(NodeManagementDetailedDiscoveryDataType) - Method in interface org.openmuc.jeebus.spine.spi.DeviceListener
- DeviceListener - Interface in org.openmuc.jeebus.spine.spi
- disconnect() - Method in class org.openmuc.jeebus.spine.spi.Communication
-
Disconnects from the network, i.e.
- Discovery - Class in org.openmuc.jeebus.spine.impl
- Discovery(String, NodeManagementImpl) - Constructor for class org.openmuc.jeebus.spine.impl.Discovery
- durationToRelativeMilliseconds(String) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
E
- ElectricalConnectionFeature - Class in org.openmuc.jeebus.spine.utils.features.electricalconnection
- ElectricalConnectionFeature() - Constructor for class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- enablePrettyPrint() - Static method in class org.openmuc.jeebus.spine.impl.parser.MessageParser
- Entity - Interface in org.openmuc.jeebus.spine.api
- EntityBuilder - Class in org.openmuc.jeebus.spine.impl
- EntityBuilder() - Constructor for class org.openmuc.jeebus.spine.impl.EntityBuilder
- EntityParent - Interface in org.openmuc.jeebus.spine.api
- equals(Object) - Method in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
Standard
equals()
method for POD objects. - Error - Enum in org.openmuc.jeebus.spine.api
- errorForIllegalSelectors(List<Class<?>>, String) - Static method in class org.openmuc.jeebus.spine.utils.Selectors
-
Generate a SpineException for illegal filter selectors.
- EventListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.loadcontrol
- extractEntityAddress(EntityAddressType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
F
- feature - Variable in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- feature - Variable in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeatureFunction
- Feature - Interface in org.openmuc.jeebus.spine.api
- FEATURE_NOT_ADDED_MESSAGE - Static variable in class org.openmuc.jeebus.spine.spi.function.ListFeatureFunctionNotifier
- FeatureBuilder - Class in org.openmuc.jeebus.spine.impl
- FeatureBuilder() - Constructor for class org.openmuc.jeebus.spine.impl.FeatureBuilder
- FeatureFunction - Class in org.openmuc.jeebus.spine.spi.function
- FeatureFunction(String) - Constructor for class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- FeatureFunctionRequirement - Class in org.openmuc.jeebus.spine.api
-
This class maps features and functions to the Use Case scenarios that require their presence.
- FeatureFunctionRequirement(FeatureTypeEnumType, Map<FunctionEnumType, Map<Long, PresenceIndication>>) - Constructor for class org.openmuc.jeebus.spine.api.FeatureFunctionRequirement
- FeaturePermission - Interface in org.openmuc.jeebus.spine.spi
- Filters - Class in org.openmuc.jeebus.spine.utils
-
Utility class for working with
FilterType
s. - findSerializationPropertyOrder(AnnotatedClass) - Method in class org.openmuc.jeebus.spine.impl.parser.MergingJakartaXmlBindAnnotationIntrospector
- FORMATTER - Static variable in class org.openmuc.jeebus.spine.utils.SpineUtilities
- fromJson(byte[]) - Static method in class org.openmuc.jeebus.spine.impl.parser.MessageParser
- FULL_READ - org.openmuc.jeebus.spine.api.options.ReadListCmdOption
- FULL_READ - org.openmuc.jeebus.spine.api.options.ReadSingleCmdOption
- FULL_WRITE - org.openmuc.jeebus.spine.api.options.WriteListCmdOption
- FULL_WRITE - org.openmuc.jeebus.spine.api.options.WriteSingleCmdOption
G
- GENERAL_ERROR - org.openmuc.jeebus.spine.api.Error
- getAbsoluteRequirements(Map<Long, PresenceIndication>) - Method in class org.openmuc.jeebus.spine.api.FeatureFunctionRequirement
- getAcknowledgment() - Method in exception org.openmuc.jeebus.spine.api.SpineException
- getActor() - Method in interface org.openmuc.jeebus.spine.spi.UseCase
- getAddress() - Method in interface org.openmuc.jeebus.spine.api.Device
- getAddress() - Method in interface org.openmuc.jeebus.spine.api.Entity
-
Returns the complete address of this entity, its parent entities and device.
- getAddress() - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Returns the address of this feature relative to the parent device.
- getAddress() - Method in interface org.openmuc.jeebus.spine.spi.UseCase
- getAddressCopy(FeatureAddressType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- getAllIdPropertyDescriptors() - Method in class org.openmuc.jeebus.spine.impl.DataIdDescription
- getAllowedReadCmdOptions() - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- getAllowedReadCmdOptions() - Method in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- getAllowedWriteCmdOptions() - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
- getBuilder() - Static method in interface org.openmuc.jeebus.spine.api.Device
- getBuilder() - Static method in interface org.openmuc.jeebus.spine.api.Entity
-
The returned builder builds a SPINE entity which can be added to an existing SPINE device at runtime with
EntityParent.addEntity(Entity)
. - getBuilder() - Static method in interface org.openmuc.jeebus.spine.api.Feature
-
The returned builder builds a SPINE feature which can be added to an existing SPINE entity at runtime with
Entity.addFeature(Feature)
. - getCalculatedScaledValue(ScaledNumberType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
-
Returns the actual value of a ScaledNumberType object as Double.
- getCharacteristicListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- getCmd() - Method in interface org.openmuc.jeebus.spine.api.RequestResult
-
Returns the cmd part of the datagram the request was answered with.
- getCommunicationAddress() - Method in class org.openmuc.jeebus.spine.api.UseCasePartner
- getCommunicationAddress() - Method in interface org.openmuc.jeebus.spine.spi.SpineConnection
- getCommunicationAddress(String) - Method in interface org.openmuc.jeebus.spine.api.ConnectionHandler
-
Returns the mapped communication address for the given SPINE device address.
- getCommunicationMode() - Method in interface org.openmuc.jeebus.spine.api.Device
- getCompleteFeatureAddress(FeatureTypeEnumType) - Method in class org.openmuc.jeebus.spine.api.UseCasePartner
- getConnectionHandler() - Method in interface org.openmuc.jeebus.spine.api.Device
- getConnectionStateListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- getConstraintsCopy() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- getConstraintsIdx() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- getData() - Method in class org.openmuc.jeebus.spine.spi.function.DataUpdate
- getDataCopies(List<Integer>) - Method in class org.openmuc.jeebus.spine.spi.function.DataListHolder
- getDataCopies(List<Integer>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- getDataCopiesFor(Predicate<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.DataListHolder
-
Returns a list of data copies for data that matches given condition
- getDataCopiesFor(Predicate<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Returns a list of data copies for data that matches given condition
- getDataCopy() - Method in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
-
Returns a data copy of the current data.
- getDataCopy() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- getDataCopy(int) - Method in class org.openmuc.jeebus.spine.spi.function.DataListHolder
-
Get a copy of the list entry at a specified index.
- getDataCopy(int) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- getDataCopyForFirst(Predicate<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.DataListHolder
-
Returns a copy of the first found data for the given condition.
- getDataCopyForFirst(Predicate<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Returns a copy of the first found data for the given condition.
- getDatagram() - Method in interface org.openmuc.jeebus.spine.api.RequestResult
-
Returns the complete datagram the request was answered with.
- getDatagram(HeaderType) - Method in class org.openmuc.jeebus.spine.api.SpineAcknowledgment
- getDataIdx() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- getDataListForTaggedElements(ELEMENTS, List<DATA>) - Static method in class org.openmuc.jeebus.spine.utils.SpineObjects
-
This method filters the given data object list so that it returns a list of data objects that only hold attributes tagged by the given elements.
- getDataListPropertyDescriptorForCmdType(Class<DATA_LIST>) - Static method in class org.openmuc.jeebus.spine.utils.SpineObjects
-
Returns the property descriptor for a given object type for the
CmdType
class. - getDataType() - Method in class org.openmuc.jeebus.spine.impl.DataIdDescription
- getDataType() - Method in class org.openmuc.jeebus.spine.spi.function.DataFeatureFunctionTypeInfo
- getDeleteCmdControl() - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- getDeleteFilter(CmdType) - Static method in class org.openmuc.jeebus.spine.utils.Filters
-
Get the Delete Filter of a given command.
- getDescription() - Method in interface org.openmuc.jeebus.spine.api.Device
- getDescription() - Method in interface org.openmuc.jeebus.spine.api.Entity
- getDescription() - Method in interface org.openmuc.jeebus.spine.api.Feature
- getDescriptionCopy() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- getDescriptionIdx() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- getDescriptionListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- getDevice() - Method in interface org.openmuc.jeebus.spine.api.EntityParent
- getDevice() - Method in interface org.openmuc.jeebus.spine.api.Feature
- getDeviceAddress(String) - Method in interface org.openmuc.jeebus.spine.api.ConnectionHandler
- getDeviceInfo() - Method in class org.openmuc.jeebus.spine.api.UseCasePartner
- getElementsObject(FilterType, Class<ELEMENTS>) - Static method in class org.openmuc.jeebus.spine.utils.Filters
-
Finds the elements object of the given type for a given
FilterType
. - getElementsType() - Method in class org.openmuc.jeebus.spine.spi.function.DataFeatureFunctionTypeInfo
- getEntities() - Method in interface org.openmuc.jeebus.spine.api.EntityParent
- getEntity(int) - Method in interface org.openmuc.jeebus.spine.api.EntityParent
- getEntityInfo() - Method in class org.openmuc.jeebus.spine.api.UseCasePartner
- getError() - Method in exception org.openmuc.jeebus.spine.api.SpineException
- getEventListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- getFeature() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- getFeature(int) - Method in interface org.openmuc.jeebus.spine.api.Entity
- getFeature(FeatureAddressType) - Method in interface org.openmuc.jeebus.spine.api.Device
-
Returns the feature with the address given or throws a SpineException if the requested feature does not exist.
- getFeatureInfos() - Method in class org.openmuc.jeebus.spine.api.UseCasePartner
-
This may contain incomplete addresses.
- getFeatures() - Method in interface org.openmuc.jeebus.spine.api.Entity
- getFullCopy() - Method in class org.openmuc.jeebus.spine.spi.function.DataListHolder
- getFullDeviceInformationRequest(String) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Executes a detailed discovery on the remote device.
- getFullUseCaseInformationRequest(String, String) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Reads supported UseCases of a remote device
- getFunctionName() - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- getFunctionName(CmdType) - Static method in class org.openmuc.jeebus.spine.impl.parser.MessageParser
- getFunctionProperty() - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- getHeartbeatDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- getId() - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
- getIdAttributePropertyDescriptors() - Method in class org.openmuc.jeebus.spine.impl.DataIdDescription
- getIdx() - Method in class org.openmuc.jeebus.spine.spi.function.DataUpdate
- getInstance() - Static method in class org.openmuc.jeebus.spine.impl.parser.CustomToStringStrategy
- getKeyId() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- getKeyValueConstraintsListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationFeature
- getKeyValueDescriptionListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationFeature
- getKeyValueListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationFeature
- getLabel() - Method in interface org.openmuc.jeebus.spine.api.Device
- getLabel() - Method in interface org.openmuc.jeebus.spine.api.Entity
- getLabel() - Method in interface org.openmuc.jeebus.spine.api.Feature
- getLastAddedEntityAddress() - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
- getLastAddedFeatureId() - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
- getLeft() - Method in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
Getter for
Pair.leftVal
- getLimitConstraintsDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- getLimitDescriptionFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- getLimitListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- getMeasurementConstraintsListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- getMeasurementDescriptionListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- getMeasurementListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- getMeasurementSeriesListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- getMeasurementThresholdRelationListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- getName() - Method in interface org.openmuc.jeebus.spine.spi.UseCase
- getNodeDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- getNodeManagement() - Method in interface org.openmuc.jeebus.spine.api.Device
-
Returns the node management feature instance associated to this device.
- getNodeManagementSubscriptionRequest(String, String, SpineSubscription) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
- getNoneIdentifiableDataDescription(Class<D>) - Static method in class org.openmuc.jeebus.spine.impl.DataIdDescription
- getNowTimestamp() - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
-
Use this method to get the current timestamp in UTC.
- getOptionalSubIdAttributePropertyDescriptors() - Method in class org.openmuc.jeebus.spine.impl.DataIdDescription
- getParameterDescriptionListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- getParent() - Method in interface org.openmuc.jeebus.spine.api.EntityParent
- getPartialCmdControl() - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- getPartialWriteFilter(CmdType) - Static method in class org.openmuc.jeebus.spine.utils.Filters
-
Get the Partial Write Filter of a given command.
- getPermittedValueSetListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ElectricalConnectionFeature
- getReadListCmdOption(List<SELECTOR>, ELEMENTS) - Static method in class org.openmuc.jeebus.spine.utils.Selectors
- getRelativeRequirements() - Method in class org.openmuc.jeebus.spine.api.FeatureFunctionRequirement
- getRight() - Method in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
Getter for
Pair.rightVal
- getRole() - Method in interface org.openmuc.jeebus.spine.api.Feature
- getScenarioSupport() - Method in interface org.openmuc.jeebus.spine.spi.UseCase
- getSelectedData(List<DATA>, List<SELECTOR>, ListFeatureFunctionTypeInfo<DATA, ?, SELECTOR, ?>) - Static method in class org.openmuc.jeebus.spine.utils.Selectors
-
Takes a list of selectors and a list of fitting data class objects (e.g.
- getSelectors(FilterType, Class<SELECTOR>) - Static method in class org.openmuc.jeebus.spine.utils.Filters
-
Finds the selectors list of the given type for a given selector type.
- getSelectorType() - Method in class org.openmuc.jeebus.spine.spi.function.ListFeatureFunctionTypeInfo
- getSenderAddress() - Method in interface org.openmuc.jeebus.spine.api.RequestResult
-
Returns the address of the sender who answered the request.
- getServiceDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- getSpecificationVersion() - Method in interface org.openmuc.jeebus.spine.api.Device
- getStateDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- getStateListDataFunction() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- getStaticAddress() - Method in interface org.openmuc.jeebus.spine.api.Entity
-
Returns the address of this entity relative to the parent device.
- getThreadName(String, String) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- getThrowable() - Method in class org.openmuc.jeebus.spine.api.SpineAcknowledgment
- getType() - Method in interface org.openmuc.jeebus.spine.api.Device
- getType() - Method in interface org.openmuc.jeebus.spine.api.Entity
- getType() - Method in interface org.openmuc.jeebus.spine.api.Feature
- getType() - Method in class org.openmuc.jeebus.spine.api.FeatureFunctionRequirement
- getUpdateListFromCmd(CmdType) - Method in class org.openmuc.jeebus.spine.spi.function.ListFeatureFunctionTypeInfo
-
Retrieve the update data list from the given write command
- getUpdateType() - Method in class org.openmuc.jeebus.spine.spi.function.DataUpdate
- getUseCaseInfo() - Method in class org.openmuc.jeebus.spine.api.UseCasePartner
-
It is recommended to check the "UseCaseAvailable" flag to see whether the use case is actually available right now.
- getUseCases() - Method in interface org.openmuc.jeebus.spine.api.Device
- getVersion() - Method in interface org.openmuc.jeebus.spine.spi.UseCase
- groupIndices(List<T>, BiPredicate<? super T, ? super T>) - Static method in class org.openmuc.jeebus.spine.utils.algorithms.Grouping
-
Group list elements according to the given equality predicate, storing the groups as lists of indices into the original list.
- Grouping - Class in org.openmuc.jeebus.spine.utils.algorithms
-
Utility class for algorithms that group collection elements together.
- groupZipMap(List<K>, List<V>, BiPredicate<? super K, ? super K>) - Static method in class org.openmuc.jeebus.spine.utils.algorithms.Grouping
-
Construct a multimap from a list of keys and a list of values.
- groupZipMapFromIndices(List<List<Integer>>, List<K>, List<V>) - Static method in class org.openmuc.jeebus.spine.utils.algorithms.Grouping
-
Construct a map from a grouped list of keys and a list of values.
H
- handleDiscovery(String, NodeManagementUseCaseDataType, NodeManagementDetailedDiscoveryDataType) - Method in class org.openmuc.jeebus.spine.impl.UseCaseDiscoveryWrapper
- hasDescription() - Method in interface org.openmuc.jeebus.spine.api.Device
- hasDescription() - Method in interface org.openmuc.jeebus.spine.api.Entity
- hasDescription() - Method in interface org.openmuc.jeebus.spine.api.Feature
- hashCode() - Method in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
Standard
hashCode()
method for POD objects. - hasLabel() - Method in interface org.openmuc.jeebus.spine.api.Device
- hasLabel() - Method in interface org.openmuc.jeebus.spine.api.Entity
- hasLabel() - Method in interface org.openmuc.jeebus.spine.api.Feature
- HeartbeatDataFunction - Class in org.openmuc.jeebus.spine.utils.features.devicediagnosis
I
- IDS_NULL - org.openmuc.jeebus.spine.impl.DataIdDescription.IdValidationStatus
- IncompleteBuildException - Exception in org.openmuc.jeebus.spine.api
- IncompleteBuildException(String) - Constructor for exception org.openmuc.jeebus.spine.api.IncompleteBuildException
- increaseCounterAndNotifySubscribers() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.HeartbeatDataFunction
- indicesWhere(Stream<A>, BiPredicate<Integer, ? super A>) - Static method in class org.openmuc.jeebus.spine.utils.algorithms.Zipping
-
Find indices in the source stream where the given predicate holds.
- INSTANCE - Static variable in class org.openmuc.jeebus.spine.impl.parser.CustomToStringStrategy
- INVALID - org.openmuc.jeebus.spine.impl.DataIdDescription.IdValidationStatus
- isCallable() - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- isConnected() - Method in class org.openmuc.jeebus.spine.spi.Communication
-
Is the communication layer currently connected to the network?
- isDevice() - Method in interface org.openmuc.jeebus.spine.api.EntityParent
- isDirectSubentity(EntityAddressType, EntityAddressType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
-
Is entityAddressChild a direct child of entityAddressParent?
- isFilterDeleteSet(CmdType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- isFilterPartialSet(CmdType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- isIdentifiableList() - Method in class org.openmuc.jeebus.spine.spi.function.ListFeatureFunctionTypeInfo
- isPositive() - Method in class org.openmuc.jeebus.spine.api.SpineAcknowledgment
- isReadable() - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- isSelected(DATA, SELECTOR) - Method in interface org.openmuc.jeebus.spine.spi.AdditionalSelectorCondition
- isSelected(Class<DATA>, Class<SELECTOR>, DATA, SELECTOR) - Static method in class org.openmuc.jeebus.spine.spi.AdditionalSelectorConditions
-
Retrieve an
AdditionalSelectorCondition
from the registry and check it against the provided selector and data. - isStrictMode() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- isStrictMode() - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeatureFunction
- isSubAddress(EntityAddressType, FeatureAddressType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- isTrusted(FeatureAddressType, String) - Method in interface org.openmuc.jeebus.spine.spi.FeaturePermission
- isUseDefaultFieldValueMarkers() - Method in class org.openmuc.jeebus.spine.impl.parser.CustomToStringStrategy
- isUseIdentityHashCode() - Method in class org.openmuc.jeebus.spine.impl.parser.CustomToStringStrategy
- isValidEnumValue(Class<E>, String) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
-
Returns if a string is a valid value of a given enum.
- isWritable() - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
K
- KeyValue - Class in org.openmuc.jeebus.spine.utils.features.deviceconfiguration
- KeyValue(DeviceConfigurationFeature, Long, DeviceConfigurationKeyValueDataType, DeviceConfigurationKeyValueDescriptionDataType, DeviceConfigurationKeyValueConstraintsDataType) - Constructor for class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- KeyValueConstraintsListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.deviceconfiguration
- KeyValueDataTypeBuilder - Class in org.openmuc.jeebus.spine.utils.features.deviceconfiguration
- KeyValueDescriptionListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.deviceconfiguration
- KeyValueListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.deviceconfiguration
L
- leftToError(Function<L, E>) - Method in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
Eliminator method: apply the given function to the left value, and throw the returned exception if nonnull.
- leftVal - Variable in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
The left value.
- LimitConstraintsDataFunction - Class in org.openmuc.jeebus.spine.utils.features.loadcontrol
- LimitDescriptionFunction - Class in org.openmuc.jeebus.spine.utils.features.loadcontrol
- LimitDescriptionFunction(LoadControlFeature) - Constructor for class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitDescriptionFunction
- LimitListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.loadcontrol
- listFeatureFunctionNotifier - Variable in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- ListFeatureFunctionNotifier<DATA,DATA_LIST,SELECTOR,ELEMENTS> - Class in org.openmuc.jeebus.spine.spi.function
-
Delegate class that handles notifying subscribers when the data of a
ReadListFeatureFunction
changes. - ListFeatureFunctionNotifier(ReadListFeatureFunction<DATA, DATA_LIST, SELECTOR, ELEMENTS, ?>, Feature, DataListHolder<DATA, SELECTOR>, ListFeatureFunctionTypeInfo<DATA, DATA_LIST, SELECTOR, ELEMENTS>) - Constructor for class org.openmuc.jeebus.spine.spi.function.ListFeatureFunctionNotifier
- ListFeatureFunctionTypeInfo<DATA,DATA_LIST,SELECTOR,ELEMENTS> - Class in org.openmuc.jeebus.spine.spi.function
-
RTTI class for
ReadListFeatureFunction
andReadAndWriteListFeatureFunction
. - ListFeatureFunctionTypeInfo(DataIdDescription<DATA>, Class<DATA_LIST>, Class<SELECTOR>, Class<ELEMENTS>) - Constructor for class org.openmuc.jeebus.spine.spi.function.ListFeatureFunctionTypeInfo
-
The class object for
ListFeatureFunctionTypeInfo
is obtained fromdataIdDesc
. - LoadControlFeature - Class in org.openmuc.jeebus.spine.utils.features.loadcontrol
- LoadControlFeature() - Constructor for class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeature
- LoadControlFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS> - Class in org.openmuc.jeebus.spine.utils.features.loadcontrol
- LoadControlLimitDataTypeBuilder - Class in org.openmuc.jeebus.spine.utils.features.loadcontrol
- logger - Static variable in class org.openmuc.jeebus.spine.spi.function.ListFeatureFunctionNotifier
M
- MANDATORY - org.openmuc.jeebus.spine.api.PresenceIndication
-
Abbreviation in Specifications: M
Requirement Keyword: SHALL - mapAddressToCommunication(String, Integer) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Assigns the given address to the given communication interface.
- matchAddress(FeatureAddressType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- MatchingDataWriteListValidation<DATA> - Interface in org.openmuc.jeebus.spine.api.validation
- MeasurementConstraintsListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.measurement
- MeasurementDescriptionListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.measurement
- MeasurementFeature - Class in org.openmuc.jeebus.spine.utils.features.measurement
- MeasurementFeature() - Constructor for class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
- MeasurementFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS> - Class in org.openmuc.jeebus.spine.utils.features.measurement
- MeasurementFeatureFunction(String, ListFeatureFunctionTypeInfo<DATA, DATA_LIST, SELECTOR, ELEMENTS>) - Constructor for class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeatureFunction
- MeasurementListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.measurement
- MeasurementSeriesListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.measurement
- MeasurementThresholdRelationListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.measurement
- MergingJakartaXmlBindAnnotationIntrospector - Class in org.openmuc.jeebus.spine.impl.parser
- MergingJakartaXmlBindAnnotationIntrospector(TypeFactory) - Constructor for class org.openmuc.jeebus.spine.impl.parser.MergingJakartaXmlBindAnnotationIntrospector
- MessageParser - Class in org.openmuc.jeebus.spine.impl.parser
- messageReceived(RequestResult) - Method in interface org.openmuc.jeebus.spine.spi.SpineSubscription
- min(PresenceIndication, PresenceIndication) - Static method in enum org.openmuc.jeebus.spine.api.PresenceIndication
N
- NamedThreadFactory - Class in org.openmuc.jeebus.spine.utils
- NamedThreadFactory(String) - Constructor for class org.openmuc.jeebus.spine.utils.NamedThreadFactory
-
Create a new ThreadFactory with the specified prefix as name
- newConnection(String) - Method in interface org.openmuc.jeebus.spine.api.ConnectionHandler
-
Returns an open connection to the requested communication partner.
- newThread(Runnable) - Method in class org.openmuc.jeebus.spine.utils.NamedThreadFactory
-
create a new named thread
- NO_ERROR - org.openmuc.jeebus.spine.api.Error
- NodeDataFunction - Class in org.openmuc.jeebus.spine.utils.features.loadcontrol
- NodeManagement - Interface in org.openmuc.jeebus.spine.api
- notifyDisconnect(DisconnectReason, ShipConnectionInterface) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
- notifySubscribers(CmdType) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Notifies subscribers of this SPINE feature that data contained in the given command has changed.
- notifySubscribers(FunctionEnumType, FilterType) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Notifies subscribers of this SPINE feature that data contained in the given SPINE function has changed.
O
- of(L, R) - Static method in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
Static factory method.
- onBind(NodeManagementBindingRequestCallType.BindingRequest) - Method in interface org.openmuc.jeebus.spine.spi.BindingListener
- onMessageReceived(SpineConnection, DatagramType) - Method in class org.openmuc.jeebus.spine.spi.Communication
- onUpdate(List<UseCasePartner>) - Method in interface org.openmuc.jeebus.spine.spi.UseCaseListener
-
This method is called when the NodeManagement identifies one or more valid use case partners.
- open(String) - Method in class org.openmuc.jeebus.spine.spi.Communication
- OPTIONAL - org.openmuc.jeebus.spine.api.PresenceIndication
-
Abbreviation in Specifications: O
Requirement Keyword: MAY - org.openmuc.jeebus.spine.api - package org.openmuc.jeebus.spine.api
- org.openmuc.jeebus.spine.api.options - package org.openmuc.jeebus.spine.api.options
- org.openmuc.jeebus.spine.api.validation - package org.openmuc.jeebus.spine.api.validation
- org.openmuc.jeebus.spine.impl - package org.openmuc.jeebus.spine.impl
- org.openmuc.jeebus.spine.impl.parser - package org.openmuc.jeebus.spine.impl.parser
- org.openmuc.jeebus.spine.spi - package org.openmuc.jeebus.spine.spi
- org.openmuc.jeebus.spine.spi.function - package org.openmuc.jeebus.spine.spi.function
- org.openmuc.jeebus.spine.utils - package org.openmuc.jeebus.spine.utils
- org.openmuc.jeebus.spine.utils.algorithms - package org.openmuc.jeebus.spine.utils.algorithms
- org.openmuc.jeebus.spine.utils.datatypes - package org.openmuc.jeebus.spine.utils.datatypes
- org.openmuc.jeebus.spine.utils.features - package org.openmuc.jeebus.spine.utils.features
- org.openmuc.jeebus.spine.utils.features.deviceconfiguration - package org.openmuc.jeebus.spine.utils.features.deviceconfiguration
- org.openmuc.jeebus.spine.utils.features.devicediagnosis - package org.openmuc.jeebus.spine.utils.features.devicediagnosis
- org.openmuc.jeebus.spine.utils.features.electricalconnection - package org.openmuc.jeebus.spine.utils.features.electricalconnection
- org.openmuc.jeebus.spine.utils.features.loadcontrol - package org.openmuc.jeebus.spine.utils.features.loadcontrol
- org.openmuc.jeebus.spine.utils.features.measurement - package org.openmuc.jeebus.spine.utils.features.measurement
- OVERLOAD - org.openmuc.jeebus.spine.api.Error
P
- Pair<L,R> - Class in org.openmuc.jeebus.spine.utils.datatypes
-
Simple generic datatype that holds a pair of values.
- Pair(L, R) - Constructor for class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
Construct a pair from a right value and a left value.
- ParameterDescriptionListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.electricalconnection
- parseDatagram(DatagramType) - Method in interface org.openmuc.jeebus.spine.api.Device
-
Forwards the given datagram to the receiving feature for processing
- PARTIAL_WRITE - org.openmuc.jeebus.spine.api.options.WriteSingleCmdOption
- PARTIAL_WRITE_BY_FUNCTION_ID - org.openmuc.jeebus.spine.api.options.WriteListCmdOption
- PARTIAL_WRITE_BY_SELECTOR - org.openmuc.jeebus.spine.api.options.WriteListCmdOption
- PermittedValueSetListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.electricalconnection
- PresenceIndication - Enum in org.openmuc.jeebus.spine.api
-
In the SPINE protocol or the Use Case specifications, data is normally marked with presence indicators marking whether the data is MANDATORY, RECOMMENDED or OPTIONAL.
R
- read(FilterType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- read(FilterType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- read(FilterType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- read(FilterType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.HeartbeatDataFunction
- READ_BY_SELECTOR - org.openmuc.jeebus.spine.api.options.ReadListCmdOption
- READ_ELEMENTS - org.openmuc.jeebus.spine.api.options.ReadListCmdOption
- READ_ELEMENTS - org.openmuc.jeebus.spine.api.options.ReadSingleCmdOption
- READ_ELEMENTS_BY_SELECTOR - org.openmuc.jeebus.spine.api.options.ReadListCmdOption
- ReadAndWriteListFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS,TYPE extends ListFeatureFunctionTypeInfo<DATA,DATA_LIST,SELECTOR,ELEMENTS>> - Class in org.openmuc.jeebus.spine.spi.function
- ReadAndWriteListFeatureFunction(String, TYPE) - Constructor for class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
-
Constructs a ReadAndWriteFeatureFunction.
- ReadAndWriteSingleFeatureFunction<DATA,ELEMENTS,TYPE extends DataFeatureFunctionTypeInfo<DATA,ELEMENTS>> - Class in org.openmuc.jeebus.spine.spi.function
- ReadAndWriteSingleFeatureFunction(String, TYPE) - Constructor for class org.openmuc.jeebus.spine.spi.function.ReadAndWriteSingleFeatureFunction
- ReadListCmdOption - Enum in org.openmuc.jeebus.spine.api.options
- ReadListFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS,TYPE extends ListFeatureFunctionTypeInfo<DATA,DATA_LIST,SELECTOR,ELEMENTS>> - Class in org.openmuc.jeebus.spine.spi.function
- ReadListFeatureFunction(String, TYPE) - Constructor for class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Constructs a ReadFeatureFunction.
- ReadListValidation<SELECTOR,ELEMENTS> - Interface in org.openmuc.jeebus.spine.api.validation
- ReadSingleCmdOption - Enum in org.openmuc.jeebus.spine.api.options
- ReadSingleDataValidation<ELEMENTS> - Interface in org.openmuc.jeebus.spine.api.validation
- ReadSingleFeatureFunction<DATA,ELEMENTS,TYPE extends DataFeatureFunctionTypeInfo<DATA,ELEMENTS>> - Class in org.openmuc.jeebus.spine.spi.function
- ReadSingleFeatureFunction(String, TYPE) - Constructor for class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- RECOMMENDED - org.openmuc.jeebus.spine.api.PresenceIndication
-
Abbreviation in Specifications: R
Requirement Keyword: SHOULD - register(Class<DATA>, Class<SELECTOR>, AdditionalSelectorCondition<DATA, SELECTOR>) - Static method in class org.openmuc.jeebus.spine.spi.AdditionalSelectorConditions
-
Register an
AdditionalSelectorCondition
for the selector typeAdditionalSelectorConditions
and the data typeAdditionalSelectorConditions
. - registerConnection(SpineConnection) - Method in interface org.openmuc.jeebus.spine.api.ConnectionHandler
-
Register an open connection
- releaseBoundClient(FeatureAddressType) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Releases the binding of the client feature located at the given address to this feature.
- releaseBoundServer(FeatureAddressType) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Releases the binding of this feature to the server feature located at the given address.
- releaseSubscriber(FeatureAddressType) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Releases the subscription of the client feature located at the given address to this feature.
- releaseSubscription(FeatureAddressType) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Releases the subscription of this feature to the server feature located at the given address.
- removeAddressMapping(String) - Method in interface org.openmuc.jeebus.spine.api.ConnectionHandler
- removeAddressMapping(String) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Unmap the current communication interface from the given communication address.
- removeData(int) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- removeData(List<Integer>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- removeDevice(String) - Method in class org.openmuc.jeebus.spine.spi.Communication
- removeKeyValue(Long) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.DeviceConfigurationFeature
- requestBind(FeatureAddressType, FeatureTypeEnumType) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Sends a binding request to the remote feature located at the given address.
- requestBindingData(String) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Reads the binding data the remote device registered with this device.
- requestDestinationListData(String) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Returns the destination list data of the remote device.
- requestRead(FeatureAddressType, CmdType) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Sends a read request to the remote feature located at the given address.
- RequestResult - Interface in org.openmuc.jeebus.spine.api
- requestSubscription(FeatureAddressType, FeatureTypeEnumType, SpineSubscription) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Sends a subscription request to the remote feature located at the given address.
- requestSubscriptionData(String) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Reads the subscription data the remote device registered with this device.
- requestWrite(FeatureAddressType, CmdType) - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Sends a write request to the remote feature located at the given address.
- requireBinding() - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
-
Call this if the function requires binding before write requests are accepted
- RESTRICTED_FUNCTION_COMBINATION_UNSUPPORTED - org.openmuc.jeebus.spine.api.Error
- rightVal - Variable in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
The right value.
- run() - Method in class org.openmuc.jeebus.spine.impl.Discovery
- runUpdate() - Method in class org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction
-
Runs the update by adding the new data, validating it and notifying the subscribers.
S
- selectorFits(V, V) - Static method in class org.openmuc.jeebus.spine.utils.Selectors
-
This method simplifies checking if values fit for a given selector.
- Selectors - Class in org.openmuc.jeebus.spine.utils
-
Utility class for working with selector types.
- sendHeartbeat() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- sendMessage(DatagramType) - Method in interface org.openmuc.jeebus.spine.spi.SpineConnection
-
Sends a message to the connected device
- ServiceDataFunction - Class in org.openmuc.jeebus.spine.utils.features.devicediagnosis
- setAllowedReadCmdOptions(ReadListCmdOption...) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Sets the
ReadListCmdOption
that are allowed to use for the given data. - setAllowedReadCmdOptions(ReadSingleCmdOption...) - Method in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- setAllowedWriteCmdOptions(WriteListCmdOption...) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
-
Sets the allowed
WriteListCmdOption
s defined by the FeatureFunction/Use Case. - setCallable(boolean) - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
-
Makes this function callable from other features.
- setCmdDataList(CmdType, List<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.ListFeatureFunctionTypeInfo
-
Takes a list of
ListFeatureFunctionTypeInfo
type objects and sets / adds it to theListFeatureFunctionTypeInfo
type object in the given cmd. - setDescription(String) - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
- setDescription(String) - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
- setDevice(Device) - Method in class org.openmuc.jeebus.spine.spi.Communication
- setDevice(Device) - Method in interface org.openmuc.jeebus.spine.spi.UseCase
-
Deprecated.this method is called by
Device.addUseCase(UseCase)
, which also performs other work to register the use case to the device. CallingsetDevice
outside of that will result in the use case not being properly registered to the device and should be avoided. - setFeature(Feature) - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
-
This method is automatically called by
Feature.addFunction(FeatureFunction)
. - setFeature(Feature) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- setFeatureGroup(String) - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
- setFeaturePermission(FeaturePermission) - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
-
Sets the permissions required to access, bind to and subscribe to the new SPINE feature.
- setIdxList(Integer) - Method in interface org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction.AfterUpdateSingleCall
- setIdxList(List<Integer>) - Method in interface org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction.AfterUpdateListCall
- setKeyValueList(List<KeyValue>) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueListDataFunction
- setLabel(String) - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
- setLabel(String) - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
- setMinimumTrustLevel(String) - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
- setReadable(boolean, boolean) - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
-
Makes this function readable for other features.
- setRole(RoleType) - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
-
This method must be called before calling
FeatureBuilder.apply()
orFeatureBuilder.build()
! - setStrictMode(boolean) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeature
-
Set strictMode to true if any notify should fail when there are warnings from the validation.
- setStrictMode(boolean) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementFeatureFunction
- setType(EntityTypeEnumType) - Method in class org.openmuc.jeebus.spine.impl.EntityBuilder
-
This method must be called before calling
EntityBuilder.applyToDevice()
,EntityBuilder.applyToEntity()
orEntityBuilder.build()
! - setType(FeatureTypeEnumType) - Method in class org.openmuc.jeebus.spine.impl.FeatureBuilder
-
This method must be called before calling
FeatureBuilder.apply()
orFeatureBuilder.build()
! - setup(DeviceBuilder) - Method in interface org.openmuc.jeebus.spine.spi.UseCase
-
After adding this UseCase to a Device (
DeviceBuilder.addUseCase(UseCase)
) this method is invoked. - setup(EntityBuilder) - Method in interface org.openmuc.jeebus.spine.spi.UseCase
-
After adding this UseCase to an Entity (
EntityBuilder.addUseCase(UseCase)
) this method is invoked. - setUseCaseMatchingDataWriteValidation(MatchingDataWriteListValidation<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
- setUseCaseReadSingleDataValidation(ReadSingleDataValidation<ELEMENTS>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- setUseCaseReadValidation(ReadListValidation<SELECTOR, ELEMENTS>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Sets a validation for the read command like
ReadListFeatureFunction.validateReadCmd(java.util.List<SELECTOR>, ELEMENTS, org.openmuc.jeebus.spine.api.options.ReadListCmdOption)
. - setUseCaseWriteDataListener(WriteDataListListener<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
-
Sets a listener that is called when changes were made to any data.
- setUseCaseWriteDataListener(WriteSingleDataListener<DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteSingleFeatureFunction
- setUseCaseWriteValidation(WriteSingleDataValidation<DATA, ELEMENTS>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteSingleFeatureFunction
- setUseCaseWriteValidationFull(WriteListValidationFull<DATA, SELECTOR, ELEMENTS>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
-
Validates the write command like
ReadAndWriteListFeatureFunction.validateWriteCmd(org.openmuc.jeebus.spine.xsd.v1.FilterType, org.openmuc.jeebus.spine.xsd.v1.FilterType, java.util.List<DATA>)
. - setWritable(boolean, boolean) - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
-
Makes this function writable for other features.
- shutdown() - Method in interface org.openmuc.jeebus.spine.api.Feature
-
Shut down the feature, stopping any associated threads and releasing any other held resources.
- Shutdownable - Interface in org.openmuc.jeebus.spine.api
-
Objects that hold references to long-running threads or executors, open network connections, etc -- directly (as fields on the object) or indirectly (via child objects) -- which can be shut down and released.
- shutdownExecutor() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.HeartbeatDataFunction
- simplifyCmd(CmdType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- simplifyCmds(DatagramType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- simplifyDatagram(DatagramType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- SpecificationVersionDataTypeMixIn - Class in org.openmuc.jeebus.spine.impl.parser
- SpecificationVersionDataTypeMixIn() - Constructor for class org.openmuc.jeebus.spine.impl.parser.SpecificationVersionDataTypeMixIn
- SpineAcknowledgment - Class in org.openmuc.jeebus.spine.api
- SpineAcknowledgment(Error) - Constructor for class org.openmuc.jeebus.spine.api.SpineAcknowledgment
- SpineAcknowledgment(Error, String) - Constructor for class org.openmuc.jeebus.spine.api.SpineAcknowledgment
- SpineConnection - Interface in org.openmuc.jeebus.spine.spi
- SpineException - Exception in org.openmuc.jeebus.spine.api
- SpineException(Error, String) - Constructor for exception org.openmuc.jeebus.spine.api.SpineException
- SpineException(Error, String, Throwable) - Constructor for exception org.openmuc.jeebus.spine.api.SpineException
- SpineObjects - Class in org.openmuc.jeebus.spine.utils
-
Utility class that bundles methods for generically copying, comparing, and writing to generated SPINE objects.
- SpineSubscription - Interface in org.openmuc.jeebus.spine.spi
- SpineUtilities - Class in org.openmuc.jeebus.spine.utils
- splitByType(List<? super T>, Class<? extends T>) - Static method in class org.openmuc.jeebus.spine.utils.Selectors
-
Splits given list into two new lists: elements of given type, and classes of elements that didn't match.
- startDiscovery(String) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Starts the automatic discovery process on the given communication address.
- startHeartbeat() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.DeviceDiagnosisFeature
- startHeartbeat() - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.HeartbeatDataFunction
- StateDataFunction - Class in org.openmuc.jeebus.spine.utils.features.devicediagnosis
- StateDataFunction() - Constructor for class org.openmuc.jeebus.spine.utils.features.devicediagnosis.StateDataFunction
- StateListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.electricalconnection
- StateListDataFunction - Class in org.openmuc.jeebus.spine.utils.features.loadcontrol
- subscribeDestinationListData(String, SpineSubscription, boolean) - Method in interface org.openmuc.jeebus.spine.api.NodeManagement
-
Subscribes to the destination list data function of the remote device.
- subscriptionAllowed(NodeManagementSubscriptionRequestCallType.SubscriptionRequest) - Method in interface org.openmuc.jeebus.spine.spi.FeaturePermission
- supportsPartialRead(NodeManagementDetailedDiscoveryDataType, String, String) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
T
- TIMEOUT - org.openmuc.jeebus.spine.api.Error
- timestampIsInInterval(String, TimestampIntervalType) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
-
Checks if a given timestamp is in given interval.
- toJson(DatagramType) - Static method in class org.openmuc.jeebus.spine.impl.parser.MessageParser
- toRelativeMilliseconds(String) - Static method in class org.openmuc.jeebus.spine.utils.SpineUtilities
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueConstraintsListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDescriptionListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.ServiceDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.StateDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.electricalconnection.CharacteristicListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.electricalconnection.DescriptionListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ParameterDescriptionListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.electricalconnection.PermittedValueSetListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.electricalconnection.StateListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.loadcontrol.EventListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitConstraintsDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitDescriptionFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.loadcontrol.StateListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementConstraintsListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementDescriptionListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementSeriesListDataFunction
- TYPE_INFO - Static variable in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementThresholdRelationListDataFunction
U
- UPDATE - org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction.UpdateType
- UPDATE_DATA - org.openmuc.jeebus.spine.api.DataUpdateType
-
A Partial write command, a full write for existent data or a delete command with set ELEMENTS.
- updateAndScheduleStartAndExpiration(int, LoadControlLimitDataType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitListDataFunction
-
updates given data at given index and schedules start if timePeriod startTime is not null and expiration if endTime is not null.
- updateConstraints(DeviceConfigurationKeyValueConstraintsDataType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- updated(DATA, Integer) - Static method in class org.openmuc.jeebus.spine.spi.function.DataUpdate
- updateData(int, DATA) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Updates data at given index by changing to the given update data.
- updateData(DATA) - Method in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
-
Updates the data for the given update.
- updateData(Map<Integer, DATA>) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Updates each of the data from the given map at given index by changing to the given update data.
- updateData(DeviceConfigurationKeyValueDataType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- updateDescription(DeviceConfigurationKeyValueDescriptionDataType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- UseCase - Interface in org.openmuc.jeebus.spine.spi
- UseCaseDiscoveryWrapper - Class in org.openmuc.jeebus.spine.impl
- UseCaseDiscoveryWrapper(UseCaseListener, String, String, Map<Long, PresenceIndication>, Set<FeatureFunctionRequirement>) - Constructor for class org.openmuc.jeebus.spine.impl.UseCaseDiscoveryWrapper
- UseCaseListener - Interface in org.openmuc.jeebus.spine.spi
-
This is THE new interface for registering listeners at the NodeManagement of SPINE devices.
- UseCasePartner - Class in org.openmuc.jeebus.spine.api
-
This class encapsulates a complete set of information on a valid, remote Use Case partner.
- UseCasePartner(String, NodeManagementDetailedDiscoveryDeviceInformationType, NodeManagementDetailedDiscoveryEntityInformationType, Map<FeatureTypeEnumType, NodeManagementDetailedDiscoveryFeatureInformationType>, NodeManagementUseCaseDataType.UseCaseInformation) - Constructor for class org.openmuc.jeebus.spine.api.UseCasePartner
- useCaseWriteDataListListener - Variable in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
V
- VALID_ID - org.openmuc.jeebus.spine.impl.DataIdDescription.IdValidationStatus
- validateData(DATA) - Method in interface org.openmuc.jeebus.spine.api.validation.DataValidation
- validateData(DATA) - Method in class org.openmuc.jeebus.spine.impl.DataIdDescription
-
Validates if given data is valid for this id description.
- validateData(DeviceConfigurationKeyValueConstraintsDataType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueConstraintsListDataFunction
- validateData(DeviceConfigurationKeyValueDataType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueListDataFunction
- validateData(DeviceConfigurationKeyValueDescriptionDataType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDescriptionListDataFunction
- validateData(DeviceDiagnosisServiceDataType) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.ServiceDataFunction
- validateData(DeviceDiagnosisStateDataType) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.StateDataFunction
- validateData(ElectricalConnectionCharacteristicDataType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.CharacteristicListDataFunction
- validateData(ElectricalConnectionDescriptionDataType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.DescriptionListDataFunction
- validateData(ElectricalConnectionParameterDescriptionDataType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ParameterDescriptionListDataFunction
- validateData(ElectricalConnectionPermittedValueSetDataType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.PermittedValueSetListDataFunction
- validateData(ElectricalConnectionStateDataType) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.StateListDataFunction
- validateData(LoadControlEventDataType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.EventListDataFunction
- validateData(LoadControlLimitConstraintsDataType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitConstraintsDataFunction
- validateData(LoadControlLimitDataType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitListDataFunction
- validateData(LoadControlLimitDescriptionDataType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitDescriptionFunction
- validateData(LoadControlNodeDataType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.NodeDataFunction
- validateData(LoadControlStateDataType) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.StateListDataFunction
- validateData(MeasurementConstraintsDataType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementConstraintsListDataFunction
- validateData(MeasurementDataType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementListDataFunction
- validateData(MeasurementDescriptionDataType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementDescriptionListDataFunction
- validateData(MeasurementSeriesDataType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementSeriesListDataFunction
- validateData(MeasurementThresholdRelationDataType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementThresholdRelationListDataFunction
- validateIsRemoteControllable() - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeatureFunction
- validateReadCmd(ELEMENTS, ReadSingleCmdOption) - Method in interface org.openmuc.jeebus.spine.api.validation.ReadSingleDataValidation
- validateReadCmd(ELEMENTS, ReadSingleCmdOption) - Method in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- validateReadCmd(List<DeviceConfigurationKeyValueConstraintsListDataSelectorsType>, DeviceConfigurationKeyValueConstraintsDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueConstraintsListDataFunction
- validateReadCmd(List<DeviceConfigurationKeyValueDescriptionListDataSelectorsType>, DeviceConfigurationKeyValueDescriptionDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDescriptionListDataFunction
- validateReadCmd(List<DeviceConfigurationKeyValueListDataSelectorsType>, DeviceConfigurationKeyValueDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueListDataFunction
- validateReadCmd(List<ElectricalConnectionCharacteristicListDataSelectorsType>, ElectricalConnectionCharacteristicDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.CharacteristicListDataFunction
- validateReadCmd(List<ElectricalConnectionDescriptionListDataSelectorsType>, ElectricalConnectionDescriptionDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.DescriptionListDataFunction
- validateReadCmd(List<ElectricalConnectionParameterDescriptionListDataSelectorsType>, ElectricalConnectionParameterDescriptionDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ParameterDescriptionListDataFunction
- validateReadCmd(List<ElectricalConnectionPermittedValueSetListDataSelectorsType>, ElectricalConnectionPermittedValueSetDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.PermittedValueSetListDataFunction
- validateReadCmd(List<ElectricalConnectionStateListDataSelectorsType>, ElectricalConnectionStateDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.StateListDataFunction
- validateReadCmd(List<LoadControlEventListDataSelectorsType>, LoadControlEventDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.EventListDataFunction
- validateReadCmd(List<LoadControlLimitConstraintsListDataSelectorsType>, LoadControlLimitConstraintsDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitConstraintsDataFunction
- validateReadCmd(List<LoadControlLimitDescriptionListDataSelectorsType>, LoadControlLimitDescriptionDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitDescriptionFunction
- validateReadCmd(List<LoadControlLimitListDataSelectorsType>, LoadControlLimitDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitListDataFunction
- validateReadCmd(List<LoadControlStateListDataSelectorsType>, LoadControlStateDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.StateListDataFunction
- validateReadCmd(List<MeasurementConstraintsListDataSelectorsType>, MeasurementConstraintsDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementConstraintsListDataFunction
- validateReadCmd(List<MeasurementDescriptionListDataSelectorsType>, MeasurementDescriptionDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementDescriptionListDataFunction
- validateReadCmd(List<MeasurementListDataSelectorsType>, MeasurementDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementListDataFunction
- validateReadCmd(List<MeasurementSeriesListDataSelectorsType>, MeasurementSeriesDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementSeriesListDataFunction
- validateReadCmd(List<MeasurementThresholdRelationListDataSelectorsType>, MeasurementThresholdRelationDataElementsType, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementThresholdRelationListDataFunction
- validateReadCmd(List<SELECTOR>, ELEMENTS, ReadListCmdOption) - Method in interface org.openmuc.jeebus.spine.api.validation.ReadListValidation
- validateReadCmd(List<SELECTOR>, ELEMENTS, ReadListCmdOption) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
-
Validates the read command.
- validateReadCmd(DeviceDiagnosisServiceDataElementsType, ReadSingleCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.ServiceDataFunction
- validateReadCmd(DeviceDiagnosisServiceDataElementsType, ReadSingleCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.StateDataFunction
- validateReadCmd(LoadControlNodeDataElementsType, ReadSingleCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.NodeDataFunction
- validateRecommendedBehaviour(MeasurementDataType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementListDataFunction
- validateRecommendedBehaviour(MeasurementSeriesDataType) - Method in class org.openmuc.jeebus.spine.utils.features.measurement.MeasurementSeriesListDataFunction
- validateUpdateForMatchingData(DATA, List<DATA>, WriteListCmdOption) - Method in interface org.openmuc.jeebus.spine.api.validation.MatchingDataWriteListValidation
- validateUpdateForMatchingData(DATA, List<DATA>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
-
Validates each update data for its matching data that is changed by the update data.
- validateUpdateForMatchingData(DeviceConfigurationKeyValueConstraintsDataType, List<DeviceConfigurationKeyValueConstraintsDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueConstraintsListDataFunction
- validateUpdateForMatchingData(DeviceConfigurationKeyValueDataType, List<DeviceConfigurationKeyValueDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueListDataFunction
- validateUpdateForMatchingData(DeviceConfigurationKeyValueDescriptionDataType, List<DeviceConfigurationKeyValueDescriptionDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDescriptionListDataFunction
- validateUpdateForMatchingData(ElectricalConnectionCharacteristicDataType, List<ElectricalConnectionCharacteristicDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.CharacteristicListDataFunction
- validateUpdateForMatchingData(ElectricalConnectionDescriptionDataType, List<ElectricalConnectionDescriptionDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.DescriptionListDataFunction
- validateUpdateForMatchingData(ElectricalConnectionParameterDescriptionDataType, List<ElectricalConnectionParameterDescriptionDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ParameterDescriptionListDataFunction
- validateUpdateForMatchingData(ElectricalConnectionPermittedValueSetDataType, List<ElectricalConnectionPermittedValueSetDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.PermittedValueSetListDataFunction
- validateUpdateForMatchingData(ElectricalConnectionStateDataType, List<ElectricalConnectionStateDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.StateListDataFunction
- validateUpdateForMatchingData(LoadControlEventDataType, List<LoadControlEventDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.EventListDataFunction
- validateUpdateForMatchingData(LoadControlLimitConstraintsDataType, List<LoadControlLimitConstraintsDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitConstraintsDataFunction
- validateUpdateForMatchingData(LoadControlLimitDataType, List<LoadControlLimitDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitListDataFunction
- validateUpdateForMatchingData(LoadControlLimitDescriptionDataType, List<LoadControlLimitDescriptionDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitDescriptionFunction
- validateUpdateForMatchingData(LoadControlStateDataType, List<LoadControlStateDataType>, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.StateListDataFunction
- validateWriteCmdFull(DATA, ELEMENTS, WriteSingleCmdOption) - Method in interface org.openmuc.jeebus.spine.api.validation.WriteSingleDataValidation
- validateWriteCmdFull(List<DATA>, List<SELECTOR>, ELEMENTS, WriteListCmdOption) - Method in interface org.openmuc.jeebus.spine.api.validation.WriteListValidationFull
- validateWriteCmdFull(List<DATA>, List<SELECTOR>, ELEMENTS, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
-
Validates a write command by taking the full update data list, selector list, elementsType object and the
WriteListCmdOption
that is used. - validateWriteCmdFull(List<DeviceConfigurationKeyValueConstraintsDataType>, List<DeviceConfigurationKeyValueConstraintsListDataSelectorsType>, DeviceConfigurationKeyValueConstraintsDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueConstraintsListDataFunction
- validateWriteCmdFull(List<DeviceConfigurationKeyValueDataType>, List<DeviceConfigurationKeyValueListDataSelectorsType>, DeviceConfigurationKeyValueDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueListDataFunction
- validateWriteCmdFull(List<DeviceConfigurationKeyValueDescriptionDataType>, List<DeviceConfigurationKeyValueDescriptionListDataSelectorsType>, DeviceConfigurationKeyValueDescriptionDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDescriptionListDataFunction
- validateWriteCmdFull(List<ElectricalConnectionCharacteristicDataType>, List<ElectricalConnectionCharacteristicListDataSelectorsType>, ElectricalConnectionCharacteristicDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.CharacteristicListDataFunction
- validateWriteCmdFull(List<ElectricalConnectionDescriptionDataType>, List<ElectricalConnectionDescriptionListDataSelectorsType>, ElectricalConnectionDescriptionDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.DescriptionListDataFunction
- validateWriteCmdFull(List<ElectricalConnectionParameterDescriptionDataType>, List<ElectricalConnectionParameterDescriptionListDataSelectorsType>, ElectricalConnectionParameterDescriptionDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ParameterDescriptionListDataFunction
- validateWriteCmdFull(List<ElectricalConnectionPermittedValueSetDataType>, List<ElectricalConnectionPermittedValueSetListDataSelectorsType>, ElectricalConnectionPermittedValueSetDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.PermittedValueSetListDataFunction
- validateWriteCmdFull(List<ElectricalConnectionStateDataType>, List<ElectricalConnectionStateListDataSelectorsType>, ElectricalConnectionStateDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.StateListDataFunction
- validateWriteCmdFull(List<LoadControlEventDataType>, List<LoadControlEventListDataSelectorsType>, LoadControlEventDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.EventListDataFunction
- validateWriteCmdFull(List<LoadControlLimitConstraintsDataType>, List<LoadControlLimitConstraintsListDataSelectorsType>, LoadControlLimitConstraintsDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitConstraintsDataFunction
- validateWriteCmdFull(List<LoadControlLimitDataType>, List<LoadControlLimitListDataSelectorsType>, LoadControlLimitDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitListDataFunction
- validateWriteCmdFull(List<LoadControlLimitDescriptionDataType>, List<LoadControlLimitDescriptionListDataSelectorsType>, LoadControlLimitDescriptionDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitDescriptionFunction
- validateWriteCmdFull(List<LoadControlStateDataType>, List<LoadControlStateListDataSelectorsType>, LoadControlStateDataElementsType, WriteListCmdOption) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.StateListDataFunction
- value - Variable in class org.openmuc.jeebus.spine.impl.parser.SpecificationVersionDataTypeMixIn
- valueOf(String) - Static method in enum org.openmuc.jeebus.spine.api.DataUpdateType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.openmuc.jeebus.spine.api.Error
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.openmuc.jeebus.spine.api.options.ReadListCmdOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.openmuc.jeebus.spine.api.options.ReadSingleCmdOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.openmuc.jeebus.spine.api.options.WriteListCmdOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.openmuc.jeebus.spine.api.options.WriteSingleCmdOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.openmuc.jeebus.spine.api.PresenceIndication
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.openmuc.jeebus.spine.impl.DataIdDescription.IdValidationStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction.UpdateType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.openmuc.jeebus.spine.api.DataUpdateType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.openmuc.jeebus.spine.api.Error
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.openmuc.jeebus.spine.api.options.ReadListCmdOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.openmuc.jeebus.spine.api.options.ReadSingleCmdOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.openmuc.jeebus.spine.api.options.WriteListCmdOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.openmuc.jeebus.spine.api.options.WriteSingleCmdOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.openmuc.jeebus.spine.api.PresenceIndication
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.openmuc.jeebus.spine.impl.DataIdDescription.IdValidationStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.openmuc.jeebus.spine.spi.function.DataUpdateTransaction.UpdateType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- version() - Method in class org.openmuc.jeebus.spine.impl.parser.MergingJakartaXmlBindAnnotationIntrospector
- visit(BiFunction<? super L, ? super R, T>) - Method in class org.openmuc.jeebus.spine.utils.datatypes.Pair
-
Visitor method: apply a
BiFunction
to the values held in this pair.
W
- withAcknowledgmentEnabled(boolean) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
- withAutomaticDestinationListDetection(boolean) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
- withCommunication(Communication) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
This method must be called before calling
DeviceBuilder.build()
! - withCommunicationMode(NetworkManagementFeatureSetType) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Controls if the device should support the enhanced communication mode, i.e.
- withDescription(String) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
- withDeviceType(DeviceTypeEnumType) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
This method must be called before calling
DeviceBuilder.build()
! - withDiscoverDevices(boolean) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Enables the automatic DetailedDiscovery of newly discovered SPINE devices.
- withDuration(String) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDataTypeBuilder
- withId(String) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Sets the device address of the new SPINE device.
- withIsLimitActive(Boolean) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
- withIsLimitChangeable(Boolean) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
- withIsValueChangeable(Boolean) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDataTypeBuilder
- withKeyId(Long) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDataTypeBuilder
- withLabel(String) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
- withLimitId(Long) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
- withNumber(Long) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDataTypeBuilder
- withScale(Short) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDataTypeBuilder
- withTimePeriodEndTime(String) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
- withTimePeriodStartTime(String) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
- withUseCases(List<UseCase>) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Adds all given use cases using
DeviceBuilder.addUseCase(UseCase)
- withUseCases(UseCase...) - Method in class org.openmuc.jeebus.spine.impl.DeviceBuilder
-
Adds all given use cases using
DeviceBuilder.addUseCase(UseCase)
- withValueNumber(Long) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
- withValueScale(Short) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlLimitDataTypeBuilder
- write(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.FeatureFunction
- write(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
- write(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteSingleFeatureFunction
- write(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction
- write(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction
- write(CmdType, FeatureAddressType) - Method in class org.openmuc.jeebus.spine.utils.features.devicediagnosis.HeartbeatDataFunction
- writeConstraintsData(DeviceConfigurationKeyValueConstraintsDataType, DataUpdateType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- writeData(DATA) - Method in interface org.openmuc.jeebus.spine.api.WriteSingleDataListener
- writeData(DATA, DataUpdateType, Integer) - Method in interface org.openmuc.jeebus.spine.api.WriteDataListListener
- writeData(DATA, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction
-
Called when changes were made to any data.
- writeData(DeviceConfigurationKeyValueConstraintsDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueConstraintsListDataFunction
- writeData(DeviceConfigurationKeyValueDataType, DataUpdateType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- writeData(DeviceConfigurationKeyValueDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueListDataFunction
- writeData(DeviceConfigurationKeyValueDescriptionDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValueDescriptionListDataFunction
- writeData(ElectricalConnectionCharacteristicDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.CharacteristicListDataFunction
- writeData(ElectricalConnectionDescriptionDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.DescriptionListDataFunction
- writeData(ElectricalConnectionParameterDescriptionDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.ParameterDescriptionListDataFunction
- writeData(ElectricalConnectionPermittedValueSetDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.PermittedValueSetListDataFunction
- writeData(ElectricalConnectionStateDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.electricalconnection.StateListDataFunction
- writeData(LoadControlEventDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.EventListDataFunction
- writeData(LoadControlLimitConstraintsDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitConstraintsDataFunction
- writeData(LoadControlLimitDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitListDataFunction
- writeData(LoadControlLimitDescriptionDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.LimitDescriptionFunction
- writeData(LoadControlStateDataType, DataUpdateType, Integer) - Method in class org.openmuc.jeebus.spine.utils.features.loadcontrol.StateListDataFunction
- WriteDataListListener<DATA> - Interface in org.openmuc.jeebus.spine.api
- writeDeleteElements(Object, Object, Object) - Static method in class org.openmuc.jeebus.spine.utils.SpineObjects
-
This method writes the given elements type by creating a
ElementTagType
for every attribute that is null in the update and not null in the old data. - writeDescriptionData(DeviceConfigurationKeyValueDescriptionDataType, DataUpdateType) - Method in class org.openmuc.jeebus.spine.utils.features.deviceconfiguration.KeyValue
- writeForAllNonNullProperties(Object, Object) - Static method in class org.openmuc.jeebus.spine.utils.SpineObjects
-
Overwrites all attributes of the writeable by the base attributes of the update that are not null in the update.
- WriteListCmdOption - Enum in org.openmuc.jeebus.spine.api.options
- WriteListValidationFull<DATA,SELECTOR,ELEMENTS> - Interface in org.openmuc.jeebus.spine.api.validation
- WriteSingleCmdOption - Enum in org.openmuc.jeebus.spine.api.options
- WriteSingleDataListener<DATA> - Interface in org.openmuc.jeebus.spine.api
- WriteSingleDataValidation<DATA,ELEMENTS> - Interface in org.openmuc.jeebus.spine.api.validation
Z
- zip(Stream<A>, Stream<B>) - Static method in class org.openmuc.jeebus.spine.utils.algorithms.Zipping
-
Combine elements from two streams in lockstep to produce a new stream.
- zipMap(Stream<A>, Stream<B>, BiFunction<A, B, C>) - Static method in class org.openmuc.jeebus.spine.utils.algorithms.Zipping
-
Combine elements from two streams in lockstep to produce a new stream.
- Zipping - Class in org.openmuc.jeebus.spine.utils.algorithms
-
Utility class for algorithms that zip streams/collections together, i.e.
- zipWithCount(Stream<A>, BiFunction<A, Integer, C>) - Static method in class org.openmuc.jeebus.spine.utils.algorithms.Zipping
-
A specialization of
Zipping.zipMap(Stream, Stream, BiFunction)
where the second stream just counts up from 0.
All Classes All Packages