DDSJAVA — Remove unnecessary DataWriter.write overloads

Title: Remove unnecessary DataWriter.write overloads

Source:

RTI (Rick Warren, rick.warren@rti.com)

Summary:

The specification currently provides overloads for DataWriter.write that take the following combinations of parameters

1. The sample to write, without an instance handle. (If the type is not keyed, no instance handle is necessary. If it is keyed, the instance handle is implicitly nil and will be inferred by the implementation.)

2. The sample to write, without an instance handle but with a time stamp.

3. The sample to write, with an instance handle.

4. The sample to write, with both an instance handle and a time stamp.

The overloads would be easier to understand if they formed a progression from fewer parameters to more. We can do this by removing (2).

Proposed Resolution:

Remove the following methods:

• public void write(

• TYPE instanceData,

• Time sourceTimestamp) throws TimeoutException;

• public void write(

• TYPE instanceData,

• long sourceTimestamp,

• TimeUnit unit) throws TimeoutException;

Also, update the documentation of the remaining overloads to clarify that if the topic is not keyed, they can be called with a nil or null InstanceHandle.

No Data Available