These values are used for output streams that could change from ByteArray's to File based output streams.

This function deletes any temnporary files that have been generated

maybeExistingFile is used in the case of blob files, where we already have an existing file containing the data. This is the path to said file.

If bitLengthFrom1To64 bits are available to be written before bitLimit0b (if defined) is encountered, then this writes the bitLengthFrom1To64 least significant bits of the long using the current bit order and byte order, and returns true.

If not enough bits are available, this writes nothing and returns false.

It is a usage error if bitLengthFrom1To64 is not in the range 1 to 64 inclusive.

If bitLengthFrom1To64 bits are available to be written before bitLimit0b (if defined) is encountered, then this writes the bitLengthFrom1To64 least significant bits of the long using the current bit order and byte order, and returns true.

If not enough bits are available, this writes nothing and returns false.

It is a usage error if bitLengthFrom1To64 is not in the range 1 to 64 inclusive.

close-out this output stream. No more writing to this after.

advances the bit position to the specified alignment.

Note that the bitAlignment1b argument is 1-based.

Passing 0 as the argument is a usage error.

Passing 1 as the argument performs no alignment, as any bit position is 1-bit aligned.

For any other value, the bit position (1-based) is advanced to the next multiple of that argument value.

False is returned if there are insufficient available bits to achieve the alignment.

Debugging flag. If set then performance may be reduced, but historic and upcoming data may be viewed using the pastData and futureData methods.

This should be set at the beginning of execution. If it is set after data has been accessed then IllegalStateException is thrown.

Offset within the first byte to the first bit. This is the number of bits to skip. Value is from 0 to 7.

For assertion checking really. Optimizations should remove the need for most alignment operations. This can be used in assertions that check that this is working properly.

Note that the bitAlignment1b argument is 1-based.

Passing 0 as the argument is a usage error.

Passing 1 as the argument performs no alignment, as any bit position is 1-bit aligned.

Absolute bit limit zero based

If defined it is the position 1 bit past the last bit location that can be written. So if we at starting at bitPos0b of 0, and we allow only 100 bits, then the bit positions are 0 to 99, and the bit limit is 100.

Absolute bit position zero based. Absolute as in relative the the start of the output data stream.

This is a Maybe type because we might not know this value, but still need to do unparsing into a buffer.

the starting bit pos is undefined to start. then it is in many cases set to some value n, because we know in advance how long the prior data is. Then when absorbed into the direct stream, the stream technically starts at 0, but we need to keep track of the former starting bit pos so as to be able to convert relative positions to absolute positions correctly.

Relative bit limit zero based

Access to historic (past data) and upcoming data for purposes of display in a trace or debugger.

If areDebugging is false, these throw IllegalStateException

If bitLengthFrom1 bits are available to be written before bitLimit0b (if defined) is encountered, then this writes the bitLengthFrom1 least significant bits of the bigInt using the current bit order and byte order, and returns true. The signed flag determines whether or not the output should be output as a signed or unsigned type.

If not enough bits are available or the big integer cannot fit into bitLengthFrom1 bits, this writes nothing and returns false.

It is a usage error if signed is false and bigInt is a negative BigInteger.

It is a usage error if bitLengthFrom1 is not greater than or equal to 1.

Float and Double

These are unparsed per the currently set BinaryFloatRep, byteOrder, and bitOrder

Returns false if there are not 32 bits or 64 bits (respectively) available.

If bitLengthFrom1 bits are available to be written before bitLimit0b (if defined) is encountered, then this writes the bitLengthFrom1 bits of the ba using the current bit order and byte order, and returns true. The array is assumed to be have bigEndian byte order and most significant bit first bit order.

If not enough bits are available, this writes nothing and returns false.

ignoreByteOrder is used when we are working with a FileOutputStream. Given that the bytes are already converted to BigEndian when they are written out to a file, we no longer need to convert little endian arrays so byte order can be ignored.

It is a usage error if bitLengthFrom1 is not greater than or equal to 1.

Returns number of bytes transferred. Stops when the bitLimit is encountered if one is defined.

Use when calling from a put/write operation that has already checked the length limit.

Assumed to be called from inner loops, so should be fast as possible.

Returns number of characters transferred. Stops when the bitLimit is encountered if one is defined.

just a synonym

Returns number of bits remaining (if a limit is defined). Nope if not defined.

sets, but also maintains the absolute bit limit, if that is defined.

Returns false if the set was unsuccessful, meaning one is setting a limit that extends past a pre-existing limit.

Must be called by anything that writes to the DOS if the amount written was 1 bit or more.

Besides setting the relBitPos, it also maintains the value of the absolute bit pos, if it is known.

Advances the bit position by nBits. If nBits aren't available this returns false. Otherwise it returns true.

Determines, as soon as possible, whether the stream has zero length, or non-zero length.

Only produces Zero length if the stream is finished, so we know nothing will be added to make it non-zero.

Starts as Unknown status, transitions to either Zero or NonZero.

Works even if the streams have been collapsing together as a result of earlier streams having been setFinished.