org.openbase.jul.extension.protobuf.iface

Interface DataBuilderProvider<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

Type Parameters:

M - Message

MB - Builder

All Known Subinterfaces:

MessageController<M,MB>

public interface DataBuilderProvider<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

* @author Tamino Huxohl

Method Summary

Modifier and Type	Method and Description
MB	cloneDataBuilder()
BuilderSyncSetup<MB>	getBuilderSetup()
ClosableDataBuilder<MB>	getDataBuilder(Object consumer) This method generates a closable data builder wrapper including the internal builder instance.
ClosableDataBuilder<MB>	getDataBuilder(Object consumer, boolean notifyChange) This method generates a closable data builder wrapper including the internal builder instance.

Method Detail

cloneDataBuilder

MB cloneDataBuilder()

getBuilderSetup

BuilderSyncSetup<MB> getBuilderSetup()

getDataBuilder

ClosableDataBuilder<MB> getDataBuilder(Object consumer)

This method generates a closable data builder wrapper including the internal builder instance. Be informed that the internal builder is directly locked and all internal builder operations are queued. Therefore please call the close method soon as possible to release the builder lock after you builder modifications, otherwise the overall processing pipeline is delayed.

  Usage Example:

     try (ClosableDataBuilder<MotionSensor.Builder> dataBuilder = getDataBuilder(this)) {
         dataBuilder.getInternalBuilder().setMotionState(motion);
     } catch (Exception ex) {
         throw new CouldNotPerformException("Could not apply data change!", ex);
     }
 
 

In this example the ClosableDataBuilder.close method is be called in background after leaving the try brackets.

Parameters:

consumer -

Returns:

a new builder wrapper with a locked builder instance.

getDataBuilder

ClosableDataBuilder<MB> getDataBuilder(Object consumer,
                                       boolean notifyChange)

This method generates a closable data builder wrapper including the internal builder instance. Be informed that the internal builder is directly locked and all internal builder operations are queued. Therefore please call the close method soon as possible to release the builder lock after you builder modifications, otherwise the overall processing pipeline is delayed.

  Usage Example:

     try (ClosableDataBuilder<MotionSensor.Builder> dataBuilder = getDataBuilder(this)) {
         dataBuilder.getInternalBuilder().setMotionState(motion);
     } catch (Exception ex) {
         throw new CouldNotPerformException("Could not apply data change!", ex);
     }
 
 

In this example the ClosableDataBuilder.close method is be called in background after leaving the try brackets.

Parameters:

consumer -

notifyChange - this flag defines if notifyChange is done after unlocking.

Returns:

a new builder wrapper with a locked builder instance.