Add FileAddress interface #28
Conversation
Removes the current implementation of FileAddress in favor of a interface to make our framework more general. In addition, an internal package for current implementation was added until we organize the code in a better way, with the address classes moved there.
Codecov Report
@@ Coverage Diff @@
## master #28 +/- ##
============================================
- Coverage 87.97% 85.42% -2.56%
- Complexity 65 73 +8
============================================
Files 8 9 +1
Lines 183 199 +16
Branches 19 21 +2
============================================
+ Hits 161 170 +9
- Misses 19 25 +6
- Partials 3 4 +1
Continue to review full report at Codecov.
|
magicDGS
left a comment
magicDGS
left a comment
There was a problem hiding this comment.
The interface should not enforce cached bytes.
|
|
||
|
|
||
| /** | ||
| * Gets the number of bytes used to encode this file address into a byte array with {@link |
There was a problem hiding this comment.
Move link to different line.
| /** | ||
| * Seeks the byte chanel to the file pointer position. | ||
| * | ||
| * |
| * Seeks the byte chanel to the file pointer position. | ||
| * | ||
| * | ||
| * <p>Default implementation returns the byte channel after calling {@link |
| } | ||
|
|
||
| /** | ||
| * Returns {@code true} if the two addresses point to the same position in the file; {@code |
There was a problem hiding this comment.
Move the last {@code to the next line
| * does not support | ||
| * this field. | ||
| * @see org.magicdgs.hdf5j.fileformat.address.FileAddressManager#getUndefinedAddress() | ||
| * @see org.magicdgs.hdf5j.internal.address.FileAddressManager |
There was a problem hiding this comment.
Should point to the FileAddress.UNDEFINED_FILE_POINTER.
| * | ||
| * @return byte array in big-endian order to encode the address. | ||
| */ | ||
| public byte[] asByteArray(); |
There was a problem hiding this comment.
I'd vote for change the signature to asByteArray(int numberOfBytes) to be able to encode it with different number of bytes.
| * | ||
| * @return the number of bytes used to encode this file address position. | ||
| */ | ||
| public int getNumberOfBytes(); |
There was a problem hiding this comment.
I vote for remove the encapsulation of the number of bytes into the file address in the interface.
| * | ||
| * @return address hexadecimal representation. | ||
| */ | ||
| public default String hexDisplay() { |
There was a problem hiding this comment.
If the asByteArray signature changes, remove default behavior and point to the static method for a common implementation.
Removes the current implementation of FileAddress in favor of a interface to make our framework more general.
In addition, an internal package for current implementation was added until we organize the code in a better way, with the address classes moved there.
Closes #24