Module org.refcodes.serial

Package org.refcodes.serial

Class PacketOutputStream.Builder

java.lang.Object

org.refcodes.serial.PacketOutputStream.Builder

All Implemented Interfaces:

org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<PacketOutputStream.Builder>, org.refcodes.mixin.OutputStreamAccessor.OutputStreamBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.CrcChecksumValidationModeAccessor.CrcChecksumValidationModeBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.EndianessAccessor.EndianessBuilder<PacketOutputStream.Builder>, PacketLengthWidthAccessor.PacketLengthWidthBuilder<PacketOutputStream.Builder>, PacketMagicBytesAccessor.PacketMagicBytesBuilder<PacketOutputStream.Builder>, PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<PacketOutputStream.Builder>, SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<PacketOutputStream.Builder>, SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<PacketOutputStream.Builder>, SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<PacketOutputStream.Builder>

Direct Known Subclasses:

StopAndWaitPacketOutputStream.Builder

Enclosing class:

PacketOutputStream

public static class PacketOutputStream.Builder
extends Object
implements PacketLengthWidthAccessor.PacketLengthWidthBuilder<PacketOutputStream.Builder>, SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<PacketOutputStream.Builder>, SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<PacketOutputStream.Builder>, org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<PacketOutputStream.Builder>, org.refcodes.mixin.OutputStreamAccessor.OutputStreamBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.EndianessAccessor.EndianessBuilder<PacketOutputStream.Builder>, SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<PacketOutputStream.Builder>, PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.CrcChecksumValidationModeAccessor.CrcChecksumValidationModeBuilder<PacketOutputStream.Builder>, org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<PacketOutputStream.Builder>, PacketMagicBytesAccessor.PacketMagicBytesBuilder<PacketOutputStream.Builder>

Builder to build StopAndWaitPacketInputStream instances.

Method Summary

Modifier and Type	Method	Description
PacketOutputStream	build()	Returns the StopAndWaitPacketInputStream instance build according to the PacketOutputStream.Builder configuration.
PacketOutputStream.Builder	withBlockSize(int aBlockSize)
PacketOutputStream.Builder	withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
PacketOutputStream.Builder	withCrcChecksumConcatenateMode(org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
PacketOutputStream.Builder	withCrcChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)
PacketOutputStream.Builder	withEndianess(org.refcodes.numerical.Endianess aEndianess)
PacketOutputStream.Builder	withOutputStream(OutputStream aOutputStream)
PacketOutputStream.Builder	withPacketLengthWidth(int aPacketLengthWidth)	Sets the packet length width (in bytes) for the packet length width (in bytes) property.
PacketOutputStream.Builder	withPacketMagicBytes(byte[] aPacketMagicBytes)	Sets the magic bytes for the packet magic bytes property.
PacketOutputStream.Builder	withPacketSegmentPackager(SegmentPackager aPacketSegmentPackager)	Sets the SegmentPackager for the packet SegmentPackager property.
PacketOutputStream.Builder	withSequenceNumberConcatenateMode(org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode)	Sets the ConcatenateMode for the sequence number ConcatenateMode property.
PacketOutputStream.Builder	withSequenceNumberInitValue(int aSequenceNumberInitValue)	Sets the sequence number initial value for the sequence number initial value property.
PacketOutputStream.Builder	withSequenceNumberWidth(int aSequenceNumberWidth)	Sets the sequence number width (in bytes) for the sequence number width (in bytes) property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.serial.PacketMagicBytesAccessor.PacketMagicBytesBuilder

withPacketMagicBytes, withPacketMagicBytes

Method Detail

build

public PacketOutputStream build()

Returns the StopAndWaitPacketInputStream instance build according to the PacketOutputStream.Builder configuration.

Returns:

The accordingly configured StopAndWaitPacketInputStream.

withBlockSize

public PacketOutputStream.Builder withBlockSize(int aBlockSize)

Specified by:

withBlockSize in interface org.refcodes.mixin.BlockSizeAccessor.BlockSizeBuilder<PacketOutputStream.Builder>

withCrcAlgorithm

public PacketOutputStream.Builder withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)

Specified by:

withCrcAlgorithm in interface org.refcodes.numerical.CrcAlgorithmAccessor.CrcAlgorithmBuilder<PacketOutputStream.Builder>

withCrcChecksumConcatenateMode

public PacketOutputStream.Builder withCrcChecksumConcatenateMode(org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)

Specified by:

withCrcChecksumConcatenateMode in interface org.refcodes.numerical.CrcChecksumConcatenateModeAccessor.CrcChecksumConcatenateModeBuilder<PacketOutputStream.Builder>

withCrcChecksumValidationMode

public PacketOutputStream.Builder withCrcChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)

Specified by:

withCrcChecksumValidationMode in interface org.refcodes.numerical.CrcChecksumValidationModeAccessor.CrcChecksumValidationModeBuilder<PacketOutputStream.Builder>

withEndianess

public PacketOutputStream.Builder withEndianess(org.refcodes.numerical.Endianess aEndianess)

Specified by:

withEndianess in interface org.refcodes.numerical.EndianessAccessor.EndianessBuilder<PacketOutputStream.Builder>

withOutputStream

public PacketOutputStream.Builder withOutputStream(OutputStream aOutputStream)

Specified by:

withOutputStream in interface org.refcodes.mixin.OutputStreamAccessor.OutputStreamBuilder<PacketOutputStream.Builder>

withPacketMagicBytes

public PacketOutputStream.Builder withPacketMagicBytes(byte[] aPacketMagicBytes)

Sets the magic bytes for the packet magic bytes property.

Specified by:

withPacketMagicBytes in interface PacketMagicBytesAccessor.PacketMagicBytesBuilder<PacketOutputStream.Builder>

Parameters:

aPacketMagicBytes - The magic bytes to be stored by the packet magic bytes property.

Returns:

The builder for applying multiple build operations.

withPacketSegmentPackager

public PacketOutputStream.Builder withPacketSegmentPackager(SegmentPackager aPacketSegmentPackager)

Sets the SegmentPackager for the packet SegmentPackager property.

Specified by:

withPacketSegmentPackager in interface PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<PacketOutputStream.Builder>

Parameters:

aPacketSegmentPackager - The SegmentPackager to be stored by the packet SegmentPackager property.

Returns:

The builder for applying multiple build operations.

withSequenceNumberConcatenateMode

public PacketOutputStream.Builder withSequenceNumberConcatenateMode(org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode)

Sets the ConcatenateMode for the sequence number ConcatenateMode property.

Specified by:

withSequenceNumberConcatenateMode in interface SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<PacketOutputStream.Builder>

Parameters:

aSequenceNumberConcatenateMode - The ConcatenateMode to be stored by the sequence number ConcatenateMode property.

Returns:

The builder for applying multiple build operations.

withSequenceNumberInitValue

public PacketOutputStream.Builder withSequenceNumberInitValue(int aSequenceNumberInitValue)

Sets the sequence number initial value for the sequence number initial value property.

Specified by:

withSequenceNumberInitValue in interface SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<PacketOutputStream.Builder>

Parameters:

aSequenceNumberInitValue - The sequence number initial value to be stored by the sequence number initial value property.

Returns:

The builder for applying multiple build operations.

withSequenceNumberWidth

public PacketOutputStream.Builder withSequenceNumberWidth(int aSequenceNumberWidth)

Sets the sequence number width (in bytes) for the sequence number width (in bytes) property.

Specified by:

withSequenceNumberWidth in interface SequenceNumberWidthAccessor.SequenceNumberWidthBuilder<PacketOutputStream.Builder>

Parameters:

aSequenceNumberWidth - The sequence number width (in bytes) to be stored by the sequence number width (in bytes) property.

Returns:

The builder for applying multiple build operations.

withPacketLengthWidth

public PacketOutputStream.Builder withPacketLengthWidth(int aPacketLengthWidth)

Sets the packet length width (in bytes) for the packet length width (in bytes) property.

Specified by:

withPacketLengthWidth in interface PacketLengthWidthAccessor.PacketLengthWidthBuilder<PacketOutputStream.Builder>

Parameters:

aPacketLengthWidth - The packet length width (in bytes) to be stored by the packet length width (in bytes) property.

Returns:

The builder for applying multiple build operations.