Module org.refcodes.serial

Package org.refcodes.serial

Class PacketInputStream.Builder

java.lang.Object

org.refcodes.serial.PacketInputStream.Builder

All Implemented Interfaces:

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

Direct Known Subclasses:

StopAndWaitPacketInputStream.Builder

Enclosing class:

PacketInputStream

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

Builder to build PacketInputStream instances.

Method Summary

Modifier and Type	Method	Description
PacketInputStream	build()	Returns the PacketInputStream instance build according to the PacketInputStream.Builder configuration.
PacketInputStream.Builder	withBlockSize(int aBlockSize)
PacketInputStream.Builder	withCrcAlgorithm(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
PacketInputStream.Builder	withCrcChecksumConcatenateMode(org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
PacketInputStream.Builder	withCrcChecksumValidationMode(org.refcodes.numerical.ChecksumValidationMode aCrcChecksumValidationMode)
PacketInputStream.Builder	withEndianess(org.refcodes.numerical.Endianess aEndianess)
PacketInputStream.Builder	withInputStream(InputStream aInputStream)
PacketInputStream.Builder	withPacketLengthWidth(int aPacketLengthWidth)	Sets the packet length width (in bytes) for the packet length width (in bytes) property.
PacketInputStream.Builder	withPacketMagicBytes(byte[] aPacketMagicBytes)	Sets the magic bytes for the packet magic bytes property.
PacketInputStream.Builder	withPacketSegmentPackager(SegmentPackager aPacketSegmentPackager)	Sets the SegmentPackager for the packet SegmentPackager property.
PacketInputStream.Builder	withSequenceNumberConcatenateMode(org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode)	Sets the ConcatenateMode for the sequence number ConcatenateMode property.
PacketInputStream.Builder	withSequenceNumberInitValue(int aSequenceNumberInitValue)	Sets the sequence number initial value for the sequence number initial value property.
PacketInputStream.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 PacketInputStream build()

Returns the PacketInputStream instance build according to the PacketInputStream.Builder configuration.

Returns:

The accordingly configured PacketInputStream.

withBlockSize

public PacketInputStream.Builder withBlockSize(int aBlockSize)

Specified by:

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

withCrcAlgorithm

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

Specified by:

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

withCrcChecksumConcatenateMode

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

Specified by:

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

withCrcChecksumValidationMode

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

Specified by:

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

withEndianess

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

Specified by:

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

withInputStream

public PacketInputStream.Builder withInputStream(InputStream aInputStream)

Specified by:

withInputStream in interface org.refcodes.mixin.InputStreamAccessor.InputStreamBuilder<PacketInputStream.Builder>

withPacketMagicBytes

public PacketInputStream.Builder withPacketMagicBytes(byte[] aPacketMagicBytes)

Sets the magic bytes for the packet magic bytes property.

Specified by:

withPacketMagicBytes in interface PacketMagicBytesAccessor.PacketMagicBytesBuilder<PacketInputStream.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 PacketInputStream.Builder withPacketSegmentPackager(SegmentPackager aPacketSegmentPackager)

Sets the SegmentPackager for the packet SegmentPackager property.

Specified by:

withPacketSegmentPackager in interface PacketSegmentPackagerAccessor.PacketSegmentPackagerBuilder<PacketInputStream.Builder>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withSequenceNumberConcatenateMode

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

Sets the ConcatenateMode for the sequence number ConcatenateMode property.

Specified by:

withSequenceNumberConcatenateMode in interface SequenceNumberConcatenateModeAccessor.SequenceNumberConcatenateModeBuilder<PacketInputStream.Builder>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withSequenceNumberInitValue

public PacketInputStream.Builder withSequenceNumberInitValue(int aSequenceNumberInitValue)

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

Specified by:

withSequenceNumberInitValue in interface SequenceNumberInitValueAccessor.SequenceNumberInitValueBuilder<PacketInputStream.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 PacketInputStream.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<PacketInputStream.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 PacketInputStream.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<PacketInputStream.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.