Module org.refcodes.serial
Package org.refcodes.serial

Class SerialSugar

java.lang.Object
org.refcodes.serial.SerialSugar
public class SerialSugar extends Object
Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the construction of various serial types such as Segment or Section type instances (and the like).

  • Constructor Details

    • SerialSugar

      protected SerialSugar()
      Instantiates a new serial sugar.

  • Method Details

    • nullSegment

      public static NullSegment nullSegment()
      The NullSegment represents a no-operation Segment, useful as placeholder in a SegmentComposite.
      Returns:
      The accordingly created NullSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(Class<E> aType, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aType - the enumeratrion's type
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(Enum<E> aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(String aAlias, Class<E> aType, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aType - the enumeratrion's type
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(String aAlias, Enum<E> aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(Class<E> aType)
      Constructs an empty EnumSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the EnumSegment's value.
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aType - the enumeratrion's type
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(Class<E> aType, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty EnumSegment with the given Endianess.
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aType - the enumeratrion's type
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(Enum<E> aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a EnumSegment with the given enumeration value (payload) and the given Endianess for the representation of the EnumSegment's value.
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aValue - The value (payload) to be contained by the EnumSegment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(String aAlias, Class<E> aType)
      Constructs an empty EnumSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the EnumSegment's value.
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aType - the enumeratrion's type
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(String aAlias, Class<E> aType, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty EnumSegment with the given Endianess.
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aType - the enumeratrion's type
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(String aAlias, Enum<E> aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a EnumSegment with the given enumeration value (payload) and the given Endianess for the representation of the EnumSegment's value.
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the EnumSegment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created EnumSegment.

    • enumSegment

      public static <E extends Enum<E>> EnumSegment<E> enumSegment(String aAlias, Class<E> aType, Enum<E> aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a EnumSegment with the given enumeration value (payload) and the given Endianess for the representation of the EnumSegment's value.
      Type Parameters:
      E - The type of the enumeration.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aType - the enumeration's type
      aValue - The value (payload) to be contained by the EnumSegment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created EnumSegment.

    • allocSegment

      public static <DECORATEE extends Section> AllocSectionDecoratorSegment<DECORATEE> allocSegment(DECORATEE aDecoratee)
      Constructs a AllocSectionDecoratorSegment with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee used for this decorator.
      Returns:
      The accordingly created AllocSectionDecoratorSegment.

    • allocSegment

      public static <DECORATEE extends Section> AllocSectionDecoratorSegment<DECORATEE> allocSegment(DECORATEE aDecoratee, org.refcodes.numerical.Endianess aEndianess)
      Constructs a AllocSectionDecoratorSegment with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length and the provided Endianess representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee used for this decorator.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created AllocSectionDecoratorSegment.

    • allocSegment

      public static <DECORATEE extends Section> AllocSectionDecoratorSegment<DECORATEE> allocSegment(DECORATEE aDecoratee, int aLengthWidth)
      Constructs a AllocSectionDecoratorSegment with the given decoratee and with the given number of bytes used to specify the decoratee's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee used for this decorator.
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created AllocSectionDecoratorSegment.

    • allocSegment

      public static <DECORATEE extends Section> AllocSectionDecoratorSegment<DECORATEE> allocSegment(DECORATEE aDecoratee, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a AllocSectionDecoratorSegment with the given decoratee and with the given number of bytes used to specify the decoratee's length and the provided Endianess representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee used for this decorator.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created AllocSectionDecoratorSegment.

    • allocSegment

      public static <DECORATEE extends Section> AllocSectionDecoratorSegment<DECORATEE> allocSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according AllocSectionDecoratorSegment instance. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee used for this decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AllocSectionDecoratorSegment.

    • allocSegmentBody

      public static <DECORATEE extends Section> AllocSegmentBody<DECORATEE> allocSegmentBody(DECORATEE aDecoratee)
      Constructs the decorator with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The type of the Section decoratee.
      Parameters:
      aDecoratee - The decoratee used for this decorator.
      Returns:
      The accordingly created AllocSegmentBody.

    • allocSegmentHead

      public static AllocSegmentHead allocSegmentHead()
      Constructs an empty head with a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the body's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the body's length.
      Returns:
      The accordingly created AllocSegmentHead.

    • allocSegmentHead

      public static AllocSegmentHead allocSegmentHead(AllocSegmentBody<?> aBody)
      Constructs the head with the given body and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the body's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the body's length.
      Parameters:
      aBody - The body referenced by this head.
      Returns:
      The accordingly created AllocSegmentHead.

    • allocSegmentHead

      public static AllocSegmentHead allocSegmentHead(AllocSegmentBody<?> aBody, org.refcodes.numerical.Endianess aEndianess)
      Constructs the head with the given body and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the body's length and the provided Endianess representation of the body's length.
      Parameters:
      aBody - The body referenced by this head.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created AllocSegmentHead.

    • allocSegmentHead

      public static AllocSegmentHead allocSegmentHead(AllocSegmentBody<?> aBody, int aLengthWidth)
      Constructs the head with the given body and with the given number of bytes used to specify the body's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the body's length.
      Parameters:
      aBody - The body referenced by this head.
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created AllocSegmentHead.

    • allocSegmentHead

      public static AllocSegmentHead allocSegmentHead(AllocSegmentBody<?> aBody, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs the head with the given body and with the given number of bytes used to specify the body's length and the provided Endianess representation of the body's length.
      Parameters:
      aBody - The body referenced by this head.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created AllocSegmentHead.

    • allocSegmentHead

      public static AllocSegmentHead allocSegmentHead(AllocSegmentBody<?> aBody, TransmissionMetrics aTransmissionMetrics)
      Constructs the head with the given body. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aBody - The body referenced by this head.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AllocSegmentHead.

    • allocSegmentHead

      public static AllocSegmentHead allocSegmentHead(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty head with a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the body's length and the provided Endianess representation of the body's length.
      Parameters:
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created AllocSegmentHead.

    • allocSegmentHead

      public static AllocSegmentHead allocSegmentHead(int aLengthWidth)
      Constructs an empty head with the given number of bytes used to specify the body's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the body's length.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created AllocSegmentHead.

    • allocSegmentHead

      public static AllocSegmentHead allocSegmentHead(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty head with a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the body's length and the provided Endianess representation of the body's length.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created AllocSegmentHead.

    • arraySection

      public static <ARRAY extends Segment> SegmentArraySection<ARRAY> arraySection(ARRAY... aSegmentArray)
      Constructs a SegmentArraySection with the given Segment elements. Segment instances for the array are created using the provided array's component type.
      Type Parameters:
      ARRAY - The type of the Segment elements to be contained in this SegmentArraySection.
      Parameters:
      aSegmentArray - The array containing the according Segment elements.
      Returns:
      The accordingly created Segment.

    • arraySection

      public static <ARRAY extends Segment> SegmentArraySection<ARRAY> arraySection(Class<ARRAY> aSegmentClass)
      Constructs a SegmentArraySection with instances of the array being created using the provided Class instance.
      Type Parameters:
      ARRAY - The type of the Segment elements to be contained in this SegmentArraySection.
      Parameters:
      aSegmentClass - The class from which to produce the the fixed length Segment elements.
      Returns:
      The accordingly created Segment.

    • arraySection

      public static <ARRAY extends Segment> SegmentArraySection<ARRAY> arraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory)
      Constructs a SegmentArraySection with instances of the array being created using the provided TypeFactory instance.
      Type Parameters:
      ARRAY - The type of the Segment elements to be contained in this SegmentArraySection.
      Parameters:
      aSegmentFactory - The factory producing the the fixed length Segment elements.
      Returns:
      The accordingly created Segment.

    • arraySection

      public static <ARRAY extends Segment> SegmentArraySection<ARRAY> arraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegmentArray)
      Constructs a SegmentArraySection with the given elements. Segment instances for the array are created using the provided TypeFactory instance.
      Type Parameters:
      ARRAY - The type of the Segment elements to be contained in this SegmentArraySection.
      Parameters:
      aSegmentFactory - The factory producing the the fixed length Segment elements.
      aSegmentArray - The array containing the according Segment elements.
      Returns:
      The accordingly created Segment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(byte aEndOfStringByte, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, String... aPayload)
      Constructs an AsciizArraySegment using the provided String elements and using the provided Segment class for creating Segment instances.
      Parameters:
      aEndOfStringByte - The alternate value instead of 0 "zero" identifying the end of the string.
      aLengthWidth - The width (in bytes) to be used for size values (number of elements in the payload array). * @param aEndianess The Endianess to be used for size values.
      aEndianess - the endianess
      aPayload - The String elements being contained in this instance.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(byte aEndOfStringByte, String... aPayload)
      Constructs an AsciizArraySegment containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH as well as the TransmissionMetrics.DEFAULT_ENDIANESS.
      Parameters:
      aEndOfStringByte - The alternate value instead of 0 "zero" identifying the end of the string.
      aPayload - The String elements being contained in this instance.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, String... aPayload)
      Constructs an AsciizArraySegment using the provided String elements and using the provided Segment class for creating Segment instances.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for size values (number of elements in the payload array). * @param aEndianess The Endianess to be used for size values.
      aEndianess - the endianess
      aPayload - The String elements being contained in this instance.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(String... aPayload)
      Constructs an AsciizArraySegment containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH as well as the TransmissionMetrics.DEFAULT_ENDIANESS.
      Parameters:
      aPayload - The String elements being contained in this instance.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(String aAlias, byte aEndOfStringByte, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, String... aPayload)
      Constructs an AsciizArraySegment using the provided arguments.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndOfStringByte - The alternate value instead of 0 "zero" identifying the end of the string.
      aLengthWidth - The width (in bytes) to be used for size values (number of elements in the payload array).
      aEndianess - The Endianess to be used for size values.
      aPayload - The String elements being contained in this instance.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(String aAlias, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, String... aPayload)
      Constructs an AsciizArraySegment using the provided arguments.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aLengthWidth - The width (in bytes) to be used for size values (number of elements in the payload array).
      aEndianess - The Endianess to be used for size values.
      aPayload - The String elements being contained in this instance.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an AsciizArraySegment from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(String aAlias, TransmissionMetrics aTransmissionMetrics, byte aEndOfStringByte)
      Constructs an AsciizArraySegment from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aEndOfStringByte - The alternate value instead of 0 "zero" identifying the end of the string.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(String aAlias, TransmissionMetrics aTransmissionMetrics, String... aValue)
      Constructs an AsciizArraySegment from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the AsciizArraySegment.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an AsciizArraySegment from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizArraySegment

      public static AsciizArraySegment asciizArraySegment(TransmissionMetrics aTransmissionMetrics, String... aValue)
      Constructs an AsciizArraySegment from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the AsciizArraySegment.
      Returns:
      The accordingly created AsciizArraySegment.

    • asciizSegment

      public static AsciizSegment asciizSegment()
      Constructs an empty AsciizSegment. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString).
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(byte aEndOfStringByte)
      Constructs an empty AsciizSegment. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString).
      Parameters:
      aEndOfStringByte - The alternate value instead of 0 "zero" identifying the end of the string.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(byte[] aValue)
      Constructs an AsciizSegment with the given (ASCII encoded) bytes payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the bytes do not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aValue - The payload to be contained by this AsciizSegment.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(byte[] aValue, byte aEndOfStringByte)
      Constructs an AsciizSegment with the given (ASCII encoded) bytes payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the bytes do not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aValue - The payload to be contained by this AsciizSegment.
      aEndOfStringByte - The alternate value instead of 0 "zero" identifying the end of the string.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(String aValue)
      Constructs an AsciizSegment with the given String payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the String does not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aValue - The payload to be contained by this AsciizSegment.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(String aValue, byte aEndOfStringByte)
      Constructs an AsciizSegment with the given String payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the String does not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aValue - The payload to be contained by this AsciizSegment.
      aEndOfStringByte - The alternate value instead of 0 "zero" identifying the end of the string.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(String aAlias, byte[] aValue)
      Constructs an AsciizSegment with the given (ASCII encoded) bytes payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the bytes do not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this AsciizSegment.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(String aAlias, byte[] aValue, byte aEndOfStringByte)
      Constructs an AsciizSegment with the given (ASCII encoded) bytes payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the bytes do not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this AsciizSegment.
      aEndOfStringByte - The alternate value instead of 0 "zero" identifying the end of the string.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(String aAlias, String aValue)
      Constructs an AsciizSegment with the given String payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the String does not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this AsciizSegment.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(String aAlias, String aValue, byte aEndOfStringByte)
      Constructs an AsciizSegment with the given String payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the String does not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this AsciizSegment.
      aEndOfStringByte - The alternate value instead of 0 "zero" identifying the end of the string.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(String aAlias, TransmissionMetrics aTransmissionMetrics, byte[] aValue)
      Constructs an AsciizSegment with the given (ASCII encoded) bytes payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the bytes do not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by this AsciizSegment.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(String aAlias, TransmissionMetrics aTransmissionMetrics, String aValue)
      Constructs an AsciizSegment with the given String payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the String does not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by this AsciizSegment.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an empty AsciizSegment. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString).
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(TransmissionMetrics aTransmissionMetrics, byte[] aValue)
      Constructs an AsciizSegment with the given (ASCII encoded) bytes payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the bytes do not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by this AsciizSegment.
      Returns:
      The accordingly created AsciizSegment.

    • asciizSegment

      public static AsciizSegment asciizSegment(TransmissionMetrics aTransmissionMetrics, String aValue)
      Constructs an AsciizSegment with the given String payload. The serialized content (as of AsciizSegment.toSequence() or Transmission.transmitTo(java.io.OutputStream)) of an AsciizSegment represents an an ASCIIZ String (also known as CString). It is in the responsibility of the programmer to make sure that the String does not contain any 0 ("zero") values as a value of 0 unintendedly terminates the resulting String.
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by this AsciizSegment.
      Returns:
      The accordingly created AsciizSegment.

    • assertMagicBytesSection

      public static <DECORATEE extends Section> AssertMagicBytesSectionDecorator<DECORATEE> assertMagicBytesSection(DECORATEE aDecoratee, byte... aMagicBytes)
      Enriches the provided Section with the given magic bytes being prefixed. Enforces the configured magic bytes to match the received magic bytes (as of AssertMagicBytesSectionDecorator.fromTransmission(Sequence, int, int) and AssertMagicBytesSectionDecorator.receiveFrom(java.io.InputStream, int, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The magic bytes to be prefixed.
      Returns:
      The accordingly created AssertMagicBytesSectionDecorator.

    • assertMagicBytesSection

      public static <DECORATEE extends Section> AssertMagicBytesSectionDecorator<DECORATEE> assertMagicBytesSection(DECORATEE aDecoratee, String aMagicBytes)
      Enriches the provided Section with magic bytes being prefixed (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of AssertMagicBytesSectionDecorator.fromTransmission(Sequence, int, int) and AssertMagicBytesSectionDecorator.receiveFrom(java.io.InputStream, int, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created AssertMagicBytesSectionDecorator.

    • assertMagicBytesSection

      public static <DECORATEE extends Section> AssertMagicBytesSectionDecorator<DECORATEE> assertMagicBytesSection(DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
      Enriches the provided Section with magic bytes being prefixed (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of AssertMagicBytesSectionDecorator.fromTransmission(Sequence, int, int) and AssertMagicBytesSectionDecorator.receiveFrom(java.io.InputStream, int, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created AssertMagicBytesSectionDecorator.

    • assertMagicBytesSection

      public static <DECORATEE extends Section> AssertMagicBytesSectionDecorator<DECORATEE> assertMagicBytesSection(String aAlias, DECORATEE aDecoratee, byte... aMagicBytes)
      Enriches the provided Section with the given magic bytes being prefixed. Enforces the configured magic bytes to match the received magic bytes (as of AssertMagicBytesSectionDecorator.fromTransmission(Sequence, int, int) and AssertMagicBytesSectionDecorator.receiveFrom(java.io.InputStream, int, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The magic bytes to be prefixed.
      Returns:
      The accordingly created AssertMagicBytesSectionDecorator.

    • assertMagicBytesSection

      public static <DECORATEE extends Section> AssertMagicBytesSectionDecorator<DECORATEE> assertMagicBytesSection(String aAlias, DECORATEE aDecoratee, String aMagicBytes)
      Enriches the provided Section with magic bytes being prefixed (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of AssertMagicBytesSectionDecorator.fromTransmission(Sequence, int, int) and AssertMagicBytesSectionDecorator.receiveFrom(java.io.InputStream, int, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created AssertMagicBytesSectionDecorator.

    • assertMagicBytesSection

      public static <DECORATEE extends Section> AssertMagicBytesSectionDecorator<DECORATEE> assertMagicBytesSection(String aAlias, DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
      Enriches the provided Section with magic bytes being prefixed (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of AssertMagicBytesSectionDecorator.fromTransmission(Sequence, int, int) and AssertMagicBytesSectionDecorator.receiveFrom(java.io.InputStream, int, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created AssertMagicBytesSectionDecorator.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(byte... aMagicBytes)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes. Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aMagicBytes - The magic bytes to be stored by this instance.
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(byte[] aMagicBytes, TransmissionMetrics aTransmissionMetrics)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes. Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aMagicBytes - The bytes to be stored by this instance as magic bytes.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE> assertMagicBytesSegment(DECORATEE aDecoratee, byte... aMagicBytes)
      Enriches the provided Segment with the given magic bytes being prefixed. Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The magic bytes to be prefixed.
      Returns:
      The accordingly created AssertMagicBytesSegmentDecorator.

    • assertMagicBytesSegment

      public static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE> assertMagicBytesSegment(DECORATEE aDecoratee, String aMagicBytes)
      Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and AssertMagicBytesSegmentDecorator.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created AssertMagicBytesSegmentDecorator.

    • assertMagicBytesSegment

      public static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE> assertMagicBytesSegment(DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
      Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and AssertMagicBytesSegmentDecorator.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created AssertMagicBytesSegmentDecorator.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(String aMagicBytes)
      Constructs an AssertMagicBytesSegment with the according magic bytes (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(String aAlias, byte... aMagicBytes)
      Constructs an AssertMagicBytesSegment with the according magic bytes. Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The magic bytes to be stored by this instance.
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(String aAlias, byte[] aMagicBytes, TransmissionMetrics aTransmissionMetrics)
      Constructs an AssertMagicBytesSegment with the according magic bytes. Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The bytes to be stored by this instance as magic bytes.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(String aMagicBytes, Charset aCharset)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE> assertMagicBytesSegment(String aAlias, DECORATEE aDecoratee, byte... aMagicBytes)
      Enriches the provided Segment with the given magic bytes being prefixed.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee. Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and AssertMagicBytesSegmentDecorator.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The magic bytes to be prefixed.
      Returns:
      The accordingly created AssertMagicBytesSegmentDecorator.

    • assertMagicBytesSegment

      public static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE> assertMagicBytesSegment(String aAlias, DECORATEE aDecoratee, String aMagicBytes)
      Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and AssertMagicBytesSegmentDecorator.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created AssertMagicBytesSegmentDecorator.

    • assertMagicBytesSegment

      public static <DECORATEE extends Segment> AssertMagicBytesSegmentDecorator<DECORATEE> assertMagicBytesSegment(String aAlias, DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
      Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and AssertMagicBytesSegmentDecorator.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created AssertMagicBytesSegmentDecorator.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(String aAlias, String aMagicBytes)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(String aAlias, String aMagicBytes, Charset aCharset)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(String aAlias, String aMagicBytes, TransmissionMetrics aTransmissionMetrics)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • assertMagicBytesSegment

      public static AssertMagicBytesSegment assertMagicBytesSegment(String aMagicBytes, TransmissionMetrics aTransmissionMetrics)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String). Enforces the configured magic bytes to match the received magic bytes (as of Segment.fromTransmission(Sequence) and Segment.SegmentMixin.receiveFrom(java.io.InputStream, java.io.OutputStream) or the like). In case the assertion of the configured magic bytes fails during receiving, then a BadMagicBytesException or BadMagicBytesSequenceException is thrown.
      Parameters:
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created AssertMagicBytesSegment.

    • booleanArraySection

      public static BooleanArraySection booleanArraySection()
      Constructs an empty BooleanArraySection.
      Returns:
      The empty BooleanArraySection.

    • booleanArraySection

      public static BooleanArraySection booleanArraySection(boolean... aValue)
      Constructs a BooleanArraySection with the given boolean array payload.
      Parameters:
      aValue - The array (payload) to be contained by the BooleanArraySection.
      Returns:
      The accordingly created BooleanArraySection.

    • booleanArraySection

      public static BooleanArraySection booleanArraySection(Boolean... aValue)
      Constructs a BooleanArraySection with the given boolean array payload.
      Parameters:
      aValue - The array (payload) to be contained by the BooleanArraySection.
      Returns:
      The accordingly created BooleanArraySection.

    • booleanArraySection

      public static BooleanArraySection booleanArraySection(String aAlias)
      Constructs an empty BooleanArraySection.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The empty BooleanArraySection.

    • booleanArraySection

      public static BooleanArraySection booleanArraySection(String aAlias, boolean... aValue)
      Constructs a BooleanArraySection with the given boolean array payload.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The array (payload) to be contained by the BooleanArraySection.
      Returns:
      The accordingly created BooleanArraySection.

    • booleanArraySection

      public static BooleanArraySection booleanArraySection(String aAlias, Boolean... aValue)
      Constructs a BooleanArraySection with the given boolean array payload.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The array (payload) to be contained by the BooleanArraySection.
      Returns:
      The accordingly created BooleanArraySection.

    • booleanSegment

      public static BooleanSegment booleanSegment()
      Constructs an empty BooleanSegment.
      Returns:
      The accordingly created BooleanSegment.

    • booleanSegment

      public static BooleanSegment booleanSegment(boolean aValue)
      Constructs a BooleanSegment with the given boolean payload.
      Parameters:
      aValue - The value (payload) to be contained by the BooleanSegment.
      Returns:
      The accordingly created BooleanSegment.

    • booleanSegment

      public static BooleanSegment booleanSegment(String aAlias)
      Constructs an empty BooleanSegment.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created BooleanSegment.

    • booleanSegment

      public static BooleanSegment booleanSegment(String aAlias, boolean aValue)
      Constructs a BooleanSegment with the given boolean payload.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the BooleanSegment.
      Returns:
      The accordingly created BooleanSegment.

    • breakerSection

      public static <DECORATEE extends Section> BreakerSectionDecorator<DECORATEE> breakerSection(DECORATEE aDecoratee, int aBreakNumber)
      Constructs a BreakerSectionDecorator instance with the given decoratee breaking deserialization of the decorated segments by the given number of times. After the total number of breaking the decoratee has been reached, the decorator behaves transparent (it just delegates without breaking the decoratee any more). This is good to see if a retry mechanism works when using some kind of error correction segment.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be contained by this facade.
      aBreakNumber - The number of times to break deserialization.
      Returns:
      The accordingly created BreakerSectionDecorator.

    • breakerSegment

      public static <DECORATEE extends Segment> BreakerSegmentDecorator<DECORATEE> breakerSegment(DECORATEE aDecoratee, int aBreakNumber)
      Constructs a BreakerSegmentDecorator instance with the given decoratee breaking deserialization of the decorated segments by the given number of times. After the total number of breaking the decoratee has been reached, the decorator behaves transparent (it just delegates without breaking the decoratee any more). This is good to see if a retry mechanism works when using some kind of error correction segment.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be contained by this facade.
      aBreakNumber - The number of times to break deserialization.
      Returns:
      The accordingly created BreakerSegmentDecorator.

    • byteArraySection

      public static ByteArraySection byteArraySection()
      Constructs an empty ByteArraySection.
      Returns:
      The empty ByteArraySection.

    • byteArraySection

      public static ByteArraySection byteArraySection(byte... aArray)
      Constructs a ByteArraySection with the given byte array payload.
      Parameters:
      aArray - The array (payload) to be contained by the ByteArraySection.
      Returns:
      The accordingly created ByteArraySection.

    • byteArraySection

      public static ByteArraySection byteArraySection(Byte... aArray)
      Constructs a ByteArraySection with the given byte array payload.
      Parameters:
      aArray - The array (payload) to be contained by the ByteArraySection.
      Returns:
      The accordingly created ByteArraySection.

    • byteArraySection

      public static ByteArraySection byteArraySection(String aAlias)
      Constructs an empty ByteArraySection.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The empty ByteArraySection.

    • byteArraySection

      public static ByteArraySection byteArraySection(String aAlias, byte... aArray)
      Constructs a ByteArraySection with the given byte array payload.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aArray - The array (payload) to be contained by the ByteArraySection.
      Returns:
      The accordingly created ByteArraySection.

    • byteArraySection

      public static ByteArraySection byteArraySection(String aAlias, Byte... aArray)
      Constructs a ByteArraySection with the given byte array payload.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aArray - The array (payload) to be contained by the ByteArraySection.
      Returns:
      The accordingly created ByteArraySection.

    • byteSegment

      public static ByteSegment byteSegment()
      Constructs an empty ByteSegment.
      Returns:
      The accordingly created ByteSegment.

    • byteSegment

      public static ByteSegment byteSegment(Byte aValue)
      Constructs a ByteSegment with the given byte payload.
      Parameters:
      aValue - The value (payload) to be contained by the ByteSegment.
      Returns:
      The accordingly created ByteSegment.

    • byteSegment

      public static ByteSegment byteSegment(String aAlias)
      Constructs an empty ByteSegment.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created ByteSegment.

    • byteSegment

      public static ByteSegment byteSegment(String aAlias, Byte aValue)
      Constructs a ByteSegment with the given byte payload.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the ByteSegment.
      Returns:
      The accordingly created ByteSegment.

    • charArraySection

      public static CharArraySection charArraySection()
      Constructs an empty CharArraySection. Uses UTF-16 by default for encoding.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(char[] aPayload)
      Constructs a CharArraySection with the given char array payload. Uses TransmissionMetrics.DEFAULT_ENCODING by default for encoding.
      Parameters:
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(Character[] aPayload)
      Constructs a CharArraySection with the given char array payload. Uses TransmissionMetrics.DEFAULT_ENCODING by default for encoding.
      Parameters:
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(Charset aCharset)
      Constructs an empty CharArraySection.
      Parameters:
      aCharset - The charset to be used for encoding.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(Charset aCharset, char... aPayload)
      Constructs a CharArraySection with the given char array payload. Uses TransmissionMetrics.DEFAULT_ENCODING by default for encoding.
      Parameters:
      aCharset - The charset to be used for encoding.
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(Charset aCharset, Character... aPayload)
      Constructs a CharArraySection with the given char array payload. Uses TransmissionMetrics.DEFAULT_ENCODING by default for encoding.
      Parameters:
      aCharset - The charset to be used for encoding.
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(String aAlias)
      Constructs an empty CharArraySection. Uses UTF-16 by default for encoding.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(String aAlias, char[] aPayload)
      Constructs a CharArraySection with the given char array payload. Uses TransmissionMetrics.DEFAULT_ENCODING by default for encoding.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(String aAlias, Character[] aPayload)
      Constructs a CharArraySection with the given char array payload. Uses TransmissionMetrics.DEFAULT_ENCODING by default for encoding.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(String aAlias, Charset aCharset)
      Constructs an empty CharArraySection.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aCharset - The charset to be used for encoding.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(String aAlias, Charset aCharset, char... aPayload)
      Constructs a CharArraySection with the given char array payload. Uses TransmissionMetrics.DEFAULT_ENCODING by default for encoding.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aCharset - The charset to be used for encoding.
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(String aAlias, Charset aCharset, Character... aPayload)
      Constructs a CharArraySection with the given char array payload. Uses TransmissionMetrics.DEFAULT_ENCODING by default for encoding.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aCharset - The charset to be used for encoding.
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, char... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the CharArraySection.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, Character... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the CharArraySection.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(TransmissionMetrics aTransmissionMetrics, char... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the CharArraySection.
      Returns:
      The accordingly created CharArraySection.

    • charArraySection

      public static CharArraySection charArraySection(TransmissionMetrics aTransmissionMetrics, Character... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the CharArraySection.
      Returns:
      The accordingly created CharArraySection.

    • charSection

      public static CharSection charSection()
      Constructs an empty CharSection.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(char aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the CharSection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(Character aPayload)
      Constructs a CharSection with the given char payload.
      Parameters:
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(Character aPayload, Charset aCharset)
      Constructs a CharSection with the given char payload and the given Charset.
      Parameters:
      aPayload - The payload to be contained by the Section.
      aCharset - The charset to be used for encoding.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(Character aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the CharSection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(Charset aCharset)
      Constructs an empty CharSection with the given Charset.
      Parameters:
      aCharset - The charset to be used for encoding.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(String aAlias)
      Constructs an empty CharSection.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(String aAlias, char aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the CharSection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(String aAlias, Character aPayload)
      Constructs a CharSection with the given char payload.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(String aAlias, Character aPayload, Charset aCharset)
      Constructs a CharSection with the given char payload and the given Charset.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aPayload - The payload to be contained by the Section.
      aCharset - The charset to be used for encoding.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(String aAlias, Character aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the CharSection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(String aAlias, Charset aCharset)
      Constructs an empty CharSection with the given Charset.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aCharset - The charset to be used for encoding.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CharSection.

    • charSection

      public static CharSection charSection(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CharSection.

    • cipherSection

      public static <DECORATEE extends Section> CipherSectionDecorator<DECORATEE> cipherSection(DECORATEE aDecoratee, Cipher aCipher)
      Constructs a Cipher transmission decorator applying bijective and inverse functions upon the delegated methods.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decorator having applied the Cipher's BijectiveFunction to encode and the Cipher's InverseFunction to decode any data being delegated.
      aCipher - The Cipher providing the BijectiveFunction to encode and the Cipher's InverseFunction to decode any data being delegated.
      Returns:
      The accordingly created CipherSectionDecorator.

    • cipherSegment

      public static <DECORATEE extends Segment> CipherSegmentDecorator<DECORATEE> cipherSegment(DECORATEE aDecoratee, Cipher aCipher)
      Constructs a Cipher transmission decorator applying bijective and inverse functions upon the delegated methods.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decorator having applied the Cipher's BijectiveFunction to encode and the Cipher's InverseFunction to decode any data being delegated.
      aCipher - The Cipher providing the BijectiveFunction to encode and the Cipher's InverseFunction to decode any data being delegated.
      Returns:
      The accordingly created CipherSegmentDecorator.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(Class<T> aType)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, String[]) instead!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aType - The data structure's type.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(Class<T> aType, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, String[]) instead!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aType - The data structure's type.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(Class<T> aType, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aAttributes)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed using the predefined set of attributes in their according order
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aType - The data structure's type.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(Class<T> aType, String... aAttributes)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed using the predefined set of attributes in their according order
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aType - The data structure's type.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(Class<T> aType, TransmissionMetrics aTransmissionMetrics)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, TransmissionMetrics, String[]) instead! The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aType - The data structure's type.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(Class<T> aType, TransmissionMetrics aTransmissionMetrics, String... aAttributes)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed using the predefined set of attributes in their according order The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aType - The data structure's type.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(String aAlias, Class<T> aType)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, String[]) instead!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aType - The data structure's type.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(String aAlias, Class<T> aType, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, String[]) instead!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aType - The data structure's type.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(String aAlias, Class<T> aType, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aAttributes)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed using the predefined set of attributes in their according order
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aType - The data structure's type.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(String aAlias, Class<T> aType, String... aAttributes)
      Constructs a ComplexTypeSegment from the given Class for the according type T. The attributes of the given data structure are processed using the predefined set of attributes in their according order
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aType - The data structure's type.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(String aAlias, T aValue)
      Constructs a ComplexTypeSegment from the given data structure instance. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, String[]) instead!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure instance.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a ComplexTypeSegment from the given data structure instance. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, String[]) instead!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure instance.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aAttributes)
      Constructs a ComplexTypeSegment from the given data structure instance.. The attributes of the given data structure are processed using the predefined set of attributes in their according order
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value from which to construct the complex type..
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(String aAlias, T aValue, String... aAttributes)
      Constructs a ComplexTypeSegment from the given data structure instance.. The attributes of the given data structure are processed using the predefined set of attributes in their according order
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value from which to construct the complex type..
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(T aValue)
      Constructs a ComplexTypeSegment from the given data structure instance. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, String[]) instead!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure instance.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a ComplexTypeSegment from the given data structure instance. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, String[]) instead!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure instance.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aAttributes)
      Constructs a ComplexTypeSegment from the given data structure instance.. The attributes of the given data structure are processed using the predefined set of attributes in their according order
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The value from which to construct the complex type..
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(T aValue, String... aAttributes)
      Constructs a ComplexTypeSegment from the given data structure instance.. The attributes of the given data structure are processed using the predefined set of attributes in their according order
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The value from which to construct the complex type..
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(T aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs a ComplexTypeSegment from the given data structure instance. The attributes of the given data structure are processed all and in alphabetical order. For specifying a predefined set of attributes and their order, please invoke complexTypeSegment(Class, TransmissionMetrics, String[]) instead! The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ComplexTypeSegment.

    • complexTypeSegment

      public static <T> ComplexTypeSegment<T> complexTypeSegment(T aValue, TransmissionMetrics aTransmissionMetrics, String... aAttributes)
      Constructs a ComplexTypeSegment from the given data structure instance.. The attributes of the given data structure are processed using the predefined set of attributes in their according order. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The value from which to construct the complex type..
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created ComplexTypeSegment.

    • crcPrefixSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcPrefixSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
      Constructs a CrcSectionDecorator wrapping the given Section (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcPrefixSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcPrefixSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs a CrcSectionDecorator wrapping the given Section (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcPrefixSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcPrefixSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSectionDecorator wrapping the given Section.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcPrefixSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcPrefixSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSectionDecorator wrapping the given Section.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcPrefixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcPrefixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
      Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcPrefixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcPrefixSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcPrefixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcPrefixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcPrefixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcPrefixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSegmentDecorator wrapping the given Segment.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcPrefixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcPrefixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSegmentDecorator wrapping the given Segment.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
      Constructs a CrcSectionDecorator wrapping the given Section (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs a CrcSectionDecorator wrapping the given Section (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSectionDecorator wrapping the given Section.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSectionDecorator wrapping the given Section.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcSection(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs a CrcSectionDecorator wrapping the given Section.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
      Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSegmentDecorator wrapping the given Segment.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSegmentDecorator wrapping the given Segment.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs a CrcSegmentDecorator wrapping the given Segment. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Parameters:
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence..
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum.
      Parameters:
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Parameters:
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Parameters:
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum.
      Parameters:
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Parameters:
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence..
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Parameters:
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence..
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum.
      Parameters:
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence..
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum.
      Parameters:
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum.
      Parameters:
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSegmentPackager

      public static CrcSegmentPackager crcSegmentPackager(TransmissionMetrics aTransmissionMetrics)
      Constructs an according CrcSegmentPackager for packaging and extracting of packets with a CRC checksum. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CrcSegmentPackager.

    • crcSuffixSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcSuffixSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
      Constructs a CrcSectionDecorator wrapping the given Section (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcSuffixSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcSuffixSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs a CrcSectionDecorator wrapping the given Section (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcSuffixSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcSuffixSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSectionDecorator wrapping the given Section.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcSuffixSection

      public static <DECORATEE extends Section> CrcSectionDecorator<DECORATEE> crcSuffixSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSectionDecorator wrapping the given Section.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The Section to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSectionDecorator.

    • crcSuffixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSuffixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
      Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSuffixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSuffixSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSuffixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSuffixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs a CrcSegmentDecorator wrapping the given Segment (using TransmissionMetrics.DEFAULT_ENDIANESS by default).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSuffixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSuffixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSegmentDecorator wrapping the given Segment.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • crcSuffixSegment

      public static <DECORATEE extends Segment> CrcSegmentDecorator<DECORATEE> crcSuffixSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs a CrcSegmentDecorator wrapping the given Segment.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment to be wrapped.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use when calculating the CRC checksum.
      Returns:
      The accordingly created CrcSegmentDecorator.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection()
      Constructs an empty DoubleArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(double... aValue)
      Constructs a DoubleArraySection with the given double array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the DoubleArraySection's value.
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(Double... aValue)
      Constructs a DoubleArraySection with the given double array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the DoubleArraySection's value.
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty DoubleArraySection with the given Endianess.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(org.refcodes.numerical.Endianess aEndianess, double... aValue)
      Constructs a DoubleArraySection with the given double array payload and the given Endianess for the representation of the DoubleArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(org.refcodes.numerical.Endianess aEndianess, Double... aValue)
      Constructs a DoubleArraySection with the given double array payload and the given Endianess for the representation of the DoubleArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(String aAlias)
      Constructs an empty DoubleArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(String aAlias, double... aValue)
      Constructs a DoubleArraySection with the given double array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the DoubleArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(String aAlias, Double... aValue)
      Constructs a DoubleArraySection with the given double array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the DoubleArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty DoubleArraySection with the given Endianess.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, double... aValue)
      Constructs a DoubleArraySection with the given double array payload and the given Endianess for the representation of the DoubleArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, Double... aValue)
      Constructs a DoubleArraySection with the given double array payload and the given Endianess for the representation of the DoubleArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, double... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, Double... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(TransmissionMetrics aTransmissionMetrics, double... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleArraySection

      public static DoubleArraySection doubleArraySection(TransmissionMetrics aTransmissionMetrics, Double... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      Returns:
      The accordingly created DoubleArraySection.

    • doubleSegment

      public static DoubleSegment doubleSegment()
      Constructs an empty DoubleSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the DoubleSegment's value.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(Double aValue)
      Constructs a DoubleSegment with the given double payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the DoubleSegment's value.
      Parameters:
      aValue - The value (payload) to be contained by the DoubleSegment.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(Double aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DoubleSegment with the given double payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aValue - The value (payload) to be contained by the DoubleSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(Double aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty DoubleSegment with the given Endianess endian representation of the DoubleSegment's value.
      Parameters:
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(String aAlias)
      Constructs an empty DoubleSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the DoubleSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(String aAlias, Double aValue)
      Constructs a DoubleSegment with the given double payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the DoubleSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the DoubleSegment.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(String aAlias, Double aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DoubleSegment with the given double payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the DoubleSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(String aAlias, Double aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty DoubleSegment with the given Endianess endian representation of the DoubleSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DoubleSegment.

    • doubleSegment

      public static DoubleSegment doubleSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DoubleSegment.

    • dummySegmentPackager

      public static SegmentPackager.DummySegmentPackager dummySegmentPackager()
      Constructs an according SegmentPackager.DummySegmentPackager.
      Returns:
      The accordingly created SegmentPackager.DummySegmentPackager.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection()
      Constructs a DynamicTypeSection with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING).
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection(Charset aCharset)
      Constructs a DynamicTypeSection with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS.
      Parameters:
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a DynamicTypeSection with the given properties.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection(String aAlias)
      Constructs a DynamicTypeSection with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING).
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection(String aAlias, Charset aCharset)
      Constructs a DynamicTypeSection with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection(String aAlias, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection(String aAlias, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a DynamicTypeSection with the given properties.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue)
      Constructs a DynamicTypeSection with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING). It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue, Charset aCharset)
      Constructs a DynamicTypeSection with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue, Charset aCharset, String... aAttributes)
      Constructs a DynamicTypeSection with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a DynamicTypeSection with the given properties. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aAttributes)
      Constructs a DynamicTypeSection with the given properties. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, String... aAttributes)
      Constructs a DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue, String... aAttributes)
      Constructs a DynamicTypeSection with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING). It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs a DynamicTypeSection with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(String aAlias, T aValue, TransmissionMetrics aTransmissionMetrics, String... aAttributes)
      Constructs a DynamicTypeSection with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs a DynamicTypeSection with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue)
      Constructs a DynamicTypeSection with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING). It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue, Charset aCharset)
      Constructs a DynamicTypeSection with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue, Charset aCharset, String... aAttributes)
      Constructs a DynamicTypeSection with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a DynamicTypeSection with the given properties. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aAttributes)
      Constructs a DynamicTypeSection with the given properties. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, String... aAttributes)
      Constructs a DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue, String... aAttributes)
      Constructs a DynamicTypeSection with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING). It is pre-initialized with the given value as of DynamicTypeSection.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs a DynamicTypeSection with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static <T> DynamicTypeSection dynamicTypeSection(T aValue, TransmissionMetrics aTransmissionMetrics, String... aAttributes)
      Constructs a DynamicTypeSection with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSection

      public static DynamicTypeSection dynamicTypeSection(TransmissionMetrics aTransmissionMetrics)
      Constructs a DynamicTypeSection with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DynamicTypeSection.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment()
      Constructs a DynamicTypeSegment with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING).
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment(Charset aCharset)
      Constructs a DynamicTypeSegment with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS.
      Parameters:
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DynamicTypeSegment with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a DynamicTypeSegment with the given properties.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment(String aAlias)
      Constructs a DynamicTypeSegment with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING).
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment(String aAlias, Charset aCharset)
      Constructs a DynamicTypeSegment with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment(String aAlias, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DynamicTypeSegment with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment(String aAlias, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a DynamicTypeSegment with the given properties.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue)
      Constructs a DynamicTypeSegment with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING). It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue, Charset aCharset)
      Constructs a DynamicTypeSegment with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue, Charset aCharset, String... aAttributes)
      Constructs a DynamicTypeSegment with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DynamicTypeSegment with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a DynamicTypeSegment with the given properties. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aAttributes)
      Constructs a DynamicTypeSegment with the given properties. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, String... aAttributes)
      Constructs a DynamicTypeSegment with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue, String... aAttributes)
      Constructs a DynamicTypeSegment with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING). It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs a DynamicTypeSegment with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(String aAlias, T aValue, TransmissionMetrics aTransmissionMetrics, String... aAttributes)
      Constructs a DynamicTypeSegment with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The data structure's value.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs a DynamicTypeSegment with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue)
      Constructs a DynamicTypeSegment with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING). It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue, Charset aCharset)
      Constructs a DynamicTypeSegment with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue, Charset aCharset, String... aAttributes)
      Constructs a DynamicTypeSegment with the given CharSection, as well as with the TransmissionMetrics.DEFAULT_LENGTH_WIDTH and the TransmissionMetrics.DEFAULT_ENDIANESS. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a DynamicTypeSegment with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset)
      Constructs a DynamicTypeSegment with the given properties. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aAttributes)
      Constructs a DynamicTypeSegment with the given properties. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aCharset - The Charset to be used for encoding and decoding String instances.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, String... aAttributes)
      Constructs a DynamicTypeSegment with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for (length) values.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue, String... aAttributes)
      Constructs a DynamicTypeSegment with the default properties (TransmissionMetrics.DEFAULT_LENGTH_WIDTH, TransmissionMetrics.DEFAULT_ENDIANESS as well as TransmissionMetrics.DEFAULT_ENCODING). It is pre-initialized with the given value as of DynamicTypeSegment.fromType(Object, String...).
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs a DynamicTypeSegment with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static <T> DynamicTypeSegment dynamicTypeSegment(T aValue, TransmissionMetrics aTransmissionMetrics, String... aAttributes)
      Constructs a DynamicTypeSegment with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      T - The type of the data structure representing the body.
      Parameters:
      aValue - The data structure's value.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aAttributes - The attributes or null if all attributes are to be processed in alphabetical order.
      Returns:
      The accordingly created DynamicTypeSegment.

    • dynamicTypeSegment

      public static DynamicTypeSegment dynamicTypeSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs a DynamicTypeSegment with the given properties. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created DynamicTypeSegment.

    • fileSection

      public static FileSection fileSection(File aFile)
      Constructs a FileSection.
      Parameters:
      aFile - The File representing the FileSection.
      Returns:
      The accordingly created FileSection.

    • fileSection

      public static FileSection fileSection(File aBasePath, Supplier<String> aFilePathSupplier)
      Constructs a FileSection, the underlying File is created on demand dynamically using the provided Supplier.
      Parameters:
      aBasePath - The File representing the base path for the path provided by the Supplier.
      aFilePathSupplier - The Supplier of the file path of File representing the FileSection. Whenever the underlying file is to be accessed, then the Supplier is called to construct the according File.
      Returns:
      The accordingly created FileSection.

    • fileSection

      public static FileSection fileSection(String aFilePath)
      Constructs a FileSection.
      Parameters:
      aFilePath - The file path of File representing the FileSection.
      Returns:
      The accordingly created FileSection.

    • fileSection

      public static FileSection fileSection(String aAlias, File aFile)
      Constructs a FileSection.
      Parameters:
      aAlias - The FileSection'S alias.
      aFile - The File representing the FileSection.
      Returns:
      The accordingly created FileSection.

    • fileSection

      public static FileSection fileSection(String aAlias, File aBasePath, Supplier<String> aFilePathSupplier)
      Constructs a FileSection, the underlying File is created on demand dynamically using the provided Supplier.
      Parameters:
      aAlias - The FileSection'S alias.
      aBasePath - The File representing the base path for the path provided by the Supplier.
      aFilePathSupplier - The Supplier of the file path of File representing the FileSection. Whenever the underlying file is to be accessed, then the Supplier is called to construct the according File.
      Returns:
      The accordingly created FileSection.

    • fileSection

      public static FileSection fileSection(String aAlias, String aFilePath)
      Constructs a FileSection.
      Parameters:
      aAlias - The FileSection'S alias.
      aFilePath - The file path of File representing the FileSection.
      Returns:
      The accordingly created FileSection.

    • fileSection

      public static FileSection fileSection(String aAlias, String aBasePath, Supplier<String> aFilePathSupplier)
      Constructs a FileSection, the underlying File is created on demand dynamically using the provided Supplier.
      Parameters:
      aAlias - The FileSection'S alias.
      aBasePath - The base path for the path provided by the Supplier.
      aFilePathSupplier - The Supplier of the file path of File representing the FileSection. Whenever the underlying file is to be accessed, then the Supplier is called to construct the according File.
      Returns:
      The accordingly created FileSection.

    • fileSection

      public static FileSection fileSection(String aBasePath, Supplier<String> aFilePathSupplier)
      Constructs a FileSection, the underlying File is created on demand dynamically using the provided Supplier.
      Parameters:
      aBasePath - The base path for the path provided by the Supplier.
      aFilePathSupplier - The Supplier of the file path of File representing the FileSection. Whenever the underlying file is to be accessed, then the Supplier is called to construct the according File.
      Returns:
      The accordingly created FileSection.

    • fileSection

      public static FileSection fileSection(Supplier<String> aFilePathSupplier)
      Constructs a FileSection, the underlying File is created on demand dynamically using the provided Supplier.
      Parameters:
      aFilePathSupplier - The Supplier of the file path of File representing the FileSection. Whenever the underlying file is to be accessed, then the Supplier is called to construct the according File.
      Returns:
      The accordingly created FileSection.

    • fixedLengthSequenceSegment

      public static FixedLengthSequenceSegment fixedLengthSequenceSegment(int aSequenceSize)
      Constructs a FixedLengthSequenceSegment.
      Parameters:
      aSequenceSize - The size of the Sequence.
      Returns:
      The accordingly created FixedLengthSequenceSegment.

    • fixedLengthSequenceSegment

      public static FixedLengthSequenceSegment fixedLengthSequenceSegment(Sequence aSequence)
      Constructs a FixedLengthSequenceSegment.
      Parameters:
      aSequence - The Sequence representing this FixedLengthSequenceSegment.
      Returns:
      The accordingly created FixedLengthSequenceSegment.

    • fixedLengthSequenceSegment

      public static FixedLengthSequenceSegment fixedLengthSequenceSegment(String aAlias, int aSequenceSize)
      Constructs a FixedLengthSequenceSegment.
      Parameters:
      aAlias - The alias which identifies the content of this Segment.
      aSequenceSize - The size of the Sequence.
      Returns:
      The accordingly created FixedLengthSequenceSegment.

    • fixedLengthSequenceSegment

      public static FixedLengthSequenceSegment fixedLengthSequenceSegment(String aAlias, Sequence aSequence)
      Constructs a FixedLengthSequenceSegment.
      Parameters:
      aAlias - The alias which identifies the content of this Segment.
      aSequence - The Sequence representing this FixedLengthSequenceSegment.
      Returns:
      The accordingly created FixedLengthSequenceSegment.

    • fixedSegmentArraySection

      public static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY> fixedSegmentArraySection(ARRAY... aSegmentArray)
      Constructs a FixedSegmentArraySection with the given Segment elements. Segment instances for the array are created using the provided array's component type.
      Type Parameters:
      ARRAY - The type of the Segment elements to be contained in this FixedSegmentArraySection.
      Parameters:
      aSegmentArray - The array containing the according Segment elements.
      Returns:
      The accordingly created Segment.

    • fixedSegmentArraySection

      public static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY> fixedSegmentArraySection(Class<ARRAY> aSegmentClass)
      Constructs a FixedSegmentArraySection with instances of the array being created using the provided Class instance.
      Type Parameters:
      ARRAY - The type of the Segment elements to be contained in this FixedSegmentArraySection.
      Parameters:
      aSegmentClass - The class from which to produce the the fixed length Segment elements.
      Returns:
      The accordingly created Segment.

    • fixedSegmentArraySection

      public static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY> fixedSegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory)
      Constructs a FixedSegmentArraySection with instances of the array being created using the provided TypeFactory instance.
      Type Parameters:
      ARRAY - The type of the Segment elements to be contained in this FixedSegmentArraySection.
      Parameters:
      aSegmentFactory - The factory producing the the fixed length Segment elements.
      Returns:
      The accordingly created Segment.

    • fixedSegmentArraySection

      public static <ARRAY extends Segment> FixedSegmentArraySection<ARRAY> fixedSegmentArraySection(org.refcodes.factory.TypeFactory<ARRAY> aSegmentFactory, ARRAY... aSegmentArray)
      Constructs a FixedSegmentArraySection with the given elements. Segment instances for the array are created using the provided TypeFactory instance.
      Type Parameters:
      ARRAY - The type of the Segment elements to be contained in this FixedSegmentArraySection.
      Parameters:
      aSegmentFactory - The factory producing the the fixed length Segment elements.
      aSegmentArray - The array containing the according Segment elements.
      Returns:
      The accordingly created Segment.

    • floatArraySection

      public static FloatArraySection floatArraySection()
      Constructs an empty FloatArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty FloatArraySection with the given Endianess.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(org.refcodes.numerical.Endianess aEndianess, float... aValue)
      Constructs a FloatArraySection with the given float array payload and the given Endianess for the representation of the FloatArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(org.refcodes.numerical.Endianess aEndianess, Float... aValue)
      Constructs a FloatArraySection with the given float array payload and the given Endianess for the representation of the FloatArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(float... aValue)
      Constructs a FloatArraySection with the given float array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatArraySection's value.
      Parameters:
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(Float... aValue)
      Constructs a FloatArraySection with the given float array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatArraySection's value.
      Parameters:
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(String aAlias)
      Constructs an empty FloatArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty FloatArraySection with the given Endianess.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, float... aValue)
      Constructs a FloatArraySection with the given float array payload and the given Endianess for the representation of the FloatArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, Float... aValue)
      Constructs a FloatArraySection with the given float array payload and the given Endianess for the representation of the FloatArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(String aAlias, float... aValue)
      Constructs a FloatArraySection with the given float array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(String aAlias, Float... aValue)
      Constructs a FloatArraySection with the given float array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, float... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, Float... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(TransmissionMetrics aTransmissionMetrics, float... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatArraySection

      public static FloatArraySection floatArraySection(TransmissionMetrics aTransmissionMetrics, Float... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the FloatArraySection.
      Returns:
      The accordingly created FloatArraySection.

    • floatSegment

      public static FloatSegment floatSegment()
      Constructs an empty FloatSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatSegment's value.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty FloatSegment with the given Endianess endian representation of the FloatSegment's value.
      Parameters:
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(Float aValue)
      Constructs a FloatSegment with the given float payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatSegment's value.
      Parameters:
      aValue - The value (payload) to be contained by the FloatSegment.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(Float aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a FloatSegment with the given float payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aValue - The value (payload) to be contained by the FloatSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(Float aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(String aAlias)
      Constructs an empty FloatSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty FloatSegment with the given Endianess endian representation of the FloatSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(String aAlias, Float aValue)
      Constructs a FloatSegment with the given float payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the FloatSegment.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(String aAlias, Float aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a FloatSegment with the given float payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the FloatSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(String aAlias, Float aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created FloatSegment.

    • floatSegment

      public static FloatSegment floatSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created FloatSegment.

    • intArraySection

      public static IntArraySection intArraySection()
      Constructs an empty IntArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty IntArraySection with the given Endianess.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(org.refcodes.numerical.Endianess aEndianess, int... aValue)
      Constructs a IntArraySection with the given int array payload and the given Endianess for the representation of the IntArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(org.refcodes.numerical.Endianess aEndianess, Integer... aValue)
      Constructs a IntArraySection with the given int array payload and the given Endianess for the representation of the IntArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(int... aValue)
      Constructs a IntArraySection with the given int array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the IntArraySection's value.
      Parameters:
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(Integer... aValue)
      Constructs a IntArraySection with the given int array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the IntArraySection's value.
      Parameters:
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(String aAlias)
      Constructs an empty IntArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty IntArraySection with the given Endianess.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, int... aValue)
      Constructs a IntArraySection with the given int array payload and the given Endianess for the representation of the IntArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, Integer... aValue)
      Constructs a IntArraySection with the given int array payload and the given Endianess for the representation of the IntArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(String aAlias, int... aValue)
      Constructs a IntArraySection with the given int array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the IntArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(String aAlias, Integer... aValue)
      Constructs a IntArraySection with the given int array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the IntArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, int... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, Integer... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(TransmissionMetrics aTransmissionMetrics, int... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intArraySection

      public static IntArraySection intArraySection(TransmissionMetrics aTransmissionMetrics, Integer... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the IntArraySection.
      Returns:
      The accordingly created IntArraySection.

    • intSegment

      public static IntSegment intSegment()
      Constructs an empty IntSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the IntSegment's value.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty IntSegment with the given Endianess endian representation of the IntSegment's value.
      Parameters:
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(Integer aValue)
      Constructs a IntSegment with the given int payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the IntSegment's value.
      Parameters:
      aValue - The value (payload) to be contained by the IntSegment.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(Integer aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a IntSegment with the given int payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aValue - The value (payload) to be contained by the IntSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(Integer aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(String aAlias)
      Constructs an empty IntSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the IntSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty IntSegment with the given Endianess endian representation of the IntSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(String aAlias, Integer aValue)
      Constructs a IntSegment with the given int payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the IntSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the IntSegment.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(String aAlias, Integer aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a IntSegment with the given int payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the IntSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(String aAlias, Integer aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created IntSegment.

    • intSegment

      public static IntSegment intSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created IntSegment.

    • invertibleSection

      public static <DECORATEE extends Section> InvertibleSectionDecorator<DECORATEE> invertibleSection(DECORATEE aDecoratee, org.refcodes.numerical.BijectiveFunction<Byte,Byte> aBijectiveFunction, org.refcodes.numerical.InverseFunction<Byte,Byte> aInverseFunction)
      Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decorator having applied the BijectiveFunction to encode and the InverseFunction to decode any data being delegated.
      aBijectiveFunction - The BijectiveFunction to encode any data being delegated.
      aInverseFunction - The InverseFunction to decode any data being delegated.
      Returns:
      The accordingly created InvertibleSectionDecorator.

    • invertibleSection

      public static <DECORATEE extends Section> InvertibleSectionDecorator<DECORATEE> invertibleSection(DECORATEE aDecoratee, org.refcodes.numerical.Invertible<Byte,Byte> aInvertible)
      Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decorator having applied the Invertible's BijectiveFunction to encode and the Invertible's InverseFunction to decode any data being delegated.
      aInvertible - The Invertible providing the BijectiveFunction to encode and the Invertible's InverseFunction to decode any data being delegated.
      Returns:
      The accordingly created InvertibleSectionDecorator.

    • invertibleSegment

      public static <DECORATEE extends Segment> InvertibleSegmentDecorator<DECORATEE> invertibleSegment(DECORATEE aDecoratee, org.refcodes.numerical.BijectiveFunction<Byte,Byte> aBijectiveFunction, org.refcodes.numerical.InverseFunction<Byte,Byte> aInverseFunction)
      Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decorator having applied the BijectiveFunction to encode and the InverseFunction to decode any data being delegated.
      aBijectiveFunction - The BijectiveFunction to encode any data being delegated.
      aInverseFunction - The InverseFunction to decode any data being delegated.
      Returns:
      The accordingly created InvertibleSegmentDecorator.

    • invertibleSegment

      public static <DECORATEE extends Segment> InvertibleSegmentDecorator<DECORATEE> invertibleSegment(DECORATEE aDecoratee, org.refcodes.numerical.Invertible<Byte,Byte> aInvertible)
      Constructs an invertible transmission decorator applying bijective and inverse functions upon the delegated methods.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decorator having applied the Invertible's BijectiveFunction to encode and the Invertible's InverseFunction to decode any data being delegated.
      aInvertible - The Invertible providing the BijectiveFunction to encode and the Invertible's InverseFunction to decode any data being delegated.
      Returns:
      The accordingly created InvertibleSegmentDecorator.

    • lengthSegment

      public static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE> lengthSegment(DECORATEE aSegment)
      Constructs a LengthSegmentDecoratorSegment with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aSegment - The decoratee used for this decorator.
      Returns:
      The accordingly created LengthSegmentDecoratorSegment.

    • lengthSegment

      public static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE> lengthSegment(DECORATEE aSegment, org.refcodes.numerical.Endianess aEndianess)
      Constructs a LengthSegmentDecoratorSegment with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length and the provided Endianess representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aSegment - The decoratee used for this decorator.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created LengthSegmentDecoratorSegment.

    • lengthSegment

      public static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE> lengthSegment(DECORATEE aSegment, int aLengthWidth)
      Constructs a LengthSegmentDecoratorSegment with the given decoratee and with the given number of bytes used to specify the decoratee's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aSegment - The decoratee used for this decorator.
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created LengthSegmentDecoratorSegment.

    • lengthSegment

      public static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE> lengthSegment(DECORATEE aSegment, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a LengthSegmentDecoratorSegment with the given decoratee and with the given number of bytes used to specify the decoratee's length and the provided Endianess representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aSegment - The decoratee used for this decorator.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created LengthSegmentDecoratorSegment.

    • lengthSegment

      public static <DECORATEE extends Segment> LengthSegmentDecoratorSegment<DECORATEE> lengthSegment(DECORATEE aSegment, TransmissionMetrics aTransmissionMetrics)
      Constructs a LengthSegmentDecoratorSegment with the given decoratee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aSegment - The decoratee used for this decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created LengthSegmentDecoratorSegment.

    • longArraySection

      public static LongArraySection longArraySection()
      Constructs an empty LongArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty LongArraySection with the given Endianess.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(org.refcodes.numerical.Endianess aEndianess, long... aValue)
      Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(org.refcodes.numerical.Endianess aEndianess, Long... aValue)
      Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(long... aValue)
      Constructs a LongArraySection with the given long array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
      Parameters:
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(Long... aValue)
      Constructs a LongArraySection with the given long array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
      Parameters:
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(String aAlias)
      Constructs an empty LongArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty LongArraySection with the given Endianess.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, long... aValue)
      Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, Long... aValue)
      Constructs a LongArraySection with the given long array payload and the given Endianess for the representation of the LongArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(String aAlias, long... aValue)
      Constructs a LongArraySection with the given long array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(String aAlias, Long... aValue)
      Constructs a LongArraySection with the given long array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, long... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, Long... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(TransmissionMetrics aTransmissionMetrics, long... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longArraySection

      public static LongArraySection longArraySection(TransmissionMetrics aTransmissionMetrics, Long... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the LongArraySection.
      Returns:
      The accordingly created LongArraySection.

    • longSegment

      public static LongSegment longSegment()
      Constructs an empty LongSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongSegment's value.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty LongSegment with the given Endianess endian representation of the LongSegment's value.
      Parameters:
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(Long aValue)
      Constructs a LongSegment with the given long payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongSegment's value.
      Parameters:
      aValue - The value (payload) to be contained by the LongSegment.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(Long aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a LongSegment with the given long payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aValue - The value (payload) to be contained by the LongSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(Long aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(String aAlias)
      Constructs an empty LongSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty LongSegment with the given Endianess endian representation of the LongSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(String aAlias, Long aValue)
      Constructs a LongSegment with the given long payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the LongSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the LongSegment.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(String aAlias, Long aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a LongSegment with the given long payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the LongSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(String aAlias, Long aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created LongSegment.

    • longSegment

      public static LongSegment longSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created LongSegment.

    • magicBytesSection

      public static <DECORATEE extends Section> MagicBytesSectionDecorator<DECORATEE> magicBytesSection(DECORATEE aDecoratee, byte... aMagicBytes)
      Enriches the provided Section with the given magic bytes being prefixed.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The magic bytes to be prefixed.
      Returns:
      The accordingly created MagicBytesSectionDecorator.

    • magicBytesSection

      public static <DECORATEE extends Section> MagicBytesSectionDecorator<DECORATEE> magicBytesSection(DECORATEE aDecoratee, int aMagicBytesLength)
      Enriches the provided Section with magic bytes of the given length to be prefixed.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytesLength - The length of the magic bytes sequence.
      Returns:
      The accordingly created MagicBytesSectionDecorator.

    • magicBytesSection

      public static <DECORATEE extends Section> MagicBytesSectionDecorator<DECORATEE> magicBytesSection(DECORATEE aDecoratee, String aMagicBytes)
      Enriches the provided Section with magic bytes being prefixed (retrieved from the given String).
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created MagicBytesSectionDecorator.

    • magicBytesSection

      public static <DECORATEE extends Section> MagicBytesSectionDecorator<DECORATEE> magicBytesSection(DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
      Enriches the provided Section with magic bytes being prefixed (retrieved from the given String).
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created MagicBytesSectionDecorator.

    • magicBytesSection

      public static <DECORATEE extends Section> MagicBytesSectionDecorator<DECORATEE> magicBytesSection(String aAlias, DECORATEE aDecoratee, byte... aMagicBytes)
      Enriches the provided Section with the given magic bytes being prefixed.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The magic bytes to be prefixed.
      Returns:
      The accordingly created MagicBytesSectionDecorator.

    • magicBytesSection

      public static <DECORATEE extends Section> MagicBytesSectionDecorator<DECORATEE> magicBytesSection(String aAlias, DECORATEE aDecoratee, int aMagicBytesLength)
      Enriches the provided Section with magic bytes of the given length to be prefixed.
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytesLength - The length of the magic bytes sequence.
      Returns:
      The accordingly created MagicBytesSectionDecorator.

    • magicBytesSection

      public static <DECORATEE extends Section> MagicBytesSectionDecorator<DECORATEE> magicBytesSection(String aAlias, DECORATEE aDecoratee, String aMagicBytes)
      Enriches the provided Section with magic bytes being prefixed (retrieved from the given String).
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created MagicBytesSectionDecorator.

    • magicBytesSection

      public static <DECORATEE extends Section> MagicBytesSectionDecorator<DECORATEE> magicBytesSection(String aAlias, DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
      Enriches the provided Section with magic bytes being prefixed (retrieved from the given String).
      Type Parameters:
      DECORATEE - The Section type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Section which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created MagicBytesSectionDecorator.

    • magicBytesSectionMultiplexer

      public static MagicBytesSectionMultiplexer magicBytesSectionMultiplexer(Collection<Section> aSections)
      Constructs a MagicBytesSectionMultiplexer containing the provided Section elements.
      Parameters:
      aSections - The Section elements being contained in this instance.
      Returns:
      The accordingly created MagicBytesSectionMultiplexer.

    • magicBytesSectionMultiplexer

      public static MagicBytesSectionMultiplexer magicBytesSectionMultiplexer(Collection<Section> aSections, int aReadLimit)
      Constructs a MagicBytesSectionMultiplexer containing the provided Section elements.
      Parameters:
      aSections - The Section elements being contained in this instance.
      aReadLimit - the maximum limit of bytes that can be read from a given InputStream before the InputStream cannot be rolled back.
      Returns:
      The accordingly created MagicBytesSectionMultiplexer.

    • magicBytesSectionMultiplexer

      public static MagicBytesSectionMultiplexer magicBytesSectionMultiplexer(int aReadLimit, Section... aSections)
      Constructs a MagicBytesSectionMultiplexer containing the provided Section elements.
      Parameters:
      aReadLimit - the maximum limit of bytes that can be read from a given InputStream before the InputStream cannot be rolled back.
      aSections - The Section elements being contained in this instance.
      Returns:
      The accordingly created MagicBytesSectionMultiplexer.

    • magicBytesSectionMultiplexer

      public static MagicBytesSectionMultiplexer magicBytesSectionMultiplexer(Section... aSections)
      Constructs a MagicBytesSectionMultiplexer containing the provided Section elements.
      Parameters:
      aSections - The Section elements being contained in this instance.
      Returns:
      The accordingly created MagicBytesSectionMultiplexer.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(byte... aMagicBytes)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes.
      Parameters:
      aMagicBytes - The magic bytes to be stored by this instance.
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(byte[] aMagicBytes, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aMagicBytes - The bytes to be stored by this instance as magic bytes.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(DECORATEE aDecoratee, byte... aMagicBytes)
      Enriches the provided Segment with the given magic bytes being prefixed.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The magic bytes to be prefixed.
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(DECORATEE aDecoratee, int aMagicBytesLength)
      Enriches the provided Segment with magic bytes of the given length to be prefixed.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytesLength - The length of the magic bytes sequence.
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(DECORATEE aDecoratee, String aMagicBytes)
      Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
      Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Enriches the provided decoratee with magic bytes of the given length to be prefixed. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee which to be prefixed with magic bytes.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(int aMagicBytesLength)
      Constructs an AbstractMagicBytesTransmission with magic bytes of the given length.
      Parameters:
      aMagicBytesLength - The length of the magic bytes sequence..
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(String aMagicBytes)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String).
      Parameters:
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(String aAlias, byte... aMagicBytes)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The magic bytes to be stored by this instance.
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(String aAlias, byte[] aMagicBytes, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The bytes to be stored by this instance as magic bytes.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(String aMagicBytes, Charset aCharset)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String).
      Parameters:
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(String aAlias, DECORATEE aDecoratee, byte... aMagicBytes)
      Enriches the provided Segment with the given magic bytes being prefixed.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The magic bytes to be prefixed.
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(String aAlias, DECORATEE aDecoratee, int aMagicBytesLength)
      Enriches the provided Segment with magic bytes of the given length to be prefixed.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytesLength - The length of the magic bytes sequence.
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(String aAlias, DECORATEE aDecoratee, String aMagicBytes)
      Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(String aAlias, DECORATEE aDecoratee, String aMagicBytes, Charset aCharset)
      Enriches the provided Segment with magic bytes being prefixed (retrieved from the given String).
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The Segment which is to be prefixed with magic bytes.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static <DECORATEE extends Segment> MagicBytesSegmentDecorator<DECORATEE> magicBytesSegment(String aAlias, DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Enriches the provided decoratee with magic bytes of the given length to be prefixed. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aDecoratee - The decoratee which to be prefixed with magic bytes.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created MagicBytesSegmentDecorator.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(String aAlias, int aMagicBytesLength)
      Constructs an AbstractMagicBytesTransmission with magic bytes of the given length.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytesLength - The length of the magic bytes sequence..
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(String aAlias, String aMagicBytes)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String).
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The String to be stored by this instance as magic bytes (uses the TransmissionMetrics.DEFAULT_ENCODING) for byte conversion).
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(String aAlias, String aMagicBytes, Charset aCharset)
      Constructs an AbstractMagicBytesTransmission with the according magic bytes (retrieved from the given String).
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aCharset - The Charset to use when converting the String to a byte array.
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(String aAlias, String aMagicBytes, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegment

      public static MagicBytesSegment magicBytesSegment(TransmissionMetrics aTransmissionMetrics, String aMagicBytes)
      Constructs an according instance for magic bytes of the given length. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aMagicBytes - The String to be stored by this instance as magic bytes.
      Returns:
      The accordingly created MagicBytesSegment.

    • magicBytesSegmentMultiplexer

      public static MagicBytesSegmentMultiplexer magicBytesSegmentMultiplexer(Collection<Segment> aSegments)
      Constructs a MagicBytesSegmentMultiplexer containing the provided Segment elements.
      Parameters:
      aSegments - The Segment elements being contained in this instance.
      Returns:
      The accordingly created MagicBytesSegmentMultiplexer.

    • magicBytesSegmentMultiplexer

      public static MagicBytesSegmentMultiplexer magicBytesSegmentMultiplexer(Collection<Segment> aSegments, int aReadLimit)
      Constructs a MagicBytesSegmentMultiplexer containing the provided Segment elements.
      Parameters:
      aSegments - The Segment elements being contained in this instance.
      aReadLimit - the maximum limit of bytes that can be read from a given InputStream before the InputStream cannot be rolled back.
      Returns:
      The accordingly created MagicBytesSegmentMultiplexer.

    • magicBytesSegmentMultiplexer

      public static MagicBytesSegmentMultiplexer magicBytesSegmentMultiplexer(int aReadLimit, Segment... aSegments)
      Constructs a MagicBytesSegmentMultiplexer containing the provided Segment elements.
      Parameters:
      aReadLimit - the maximum limit of bytes that can be read from a given InputStream before the InputStream cannot be rolled back.
      aSegments - The Segment elements being contained in this instance.
      Returns:
      The accordingly created MagicBytesSegmentMultiplexer.

    • magicBytesSegmentMultiplexer

      public static MagicBytesSegmentMultiplexer magicBytesSegmentMultiplexer(Segment... aSegments)
      Constructs a MagicBytesSegmentMultiplexer containing the provided Segment elements.
      Parameters:
      aSegments - The Segment elements being contained in this instance.
      Returns:
      The accordingly created MagicBytesSegmentMultiplexer.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth)
      Constructs an empty NumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty NumberSegment with the given Endianess.
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, Long aValue)
      Constructs a NumberSegment with the given long payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aValue - The payload to be contained by the NumberSegment.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, Long aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a NumberSegment with the given long payload and the given Endianess for the representation of the NumberSegment's value (payload).
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aValue - The value (payload) to be contained by the NumberSegment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, Long aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, String aAlias)
      Constructs an empty NumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty NumberSegment with the given Endianess.
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, String aAlias, Long aValue)
      Constructs a NumberSegment with the given long payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the NumberSegment's value.
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the NumberSegment.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, String aAlias, Long aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a NumberSegment with the given long payload and the given Endianess for the representation of the NumberSegment's value (payload).
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the NumberSegment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, String aAlias, Long aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created NumberSegment.

    • numberSegment

      public static NumberSegment numberSegment(int aNumberWidth, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aNumberWidth - The number of bytes to be occupied by the number.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created NumberSegment.

    • propertiesSection

      public static PropertiesSection propertiesSection()
      Constructs an empty PropertiesSection using UTF-8 encoding for the payload.
      Returns:
      The accordingly created PropertiesSection.

    • propertiesSection

      public static PropertiesSection propertiesSection(Charset aCharset)
      Constructs a PropertiesSection with a payload expected to be encoded with the given Charset.
      Parameters:
      aCharset - The Charset to be used for encoding the String.
      Returns:
      The accordingly created PropertiesSection.

    • propertiesSection

      public static PropertiesSection propertiesSection(org.refcodes.properties.Properties aPayload)
      Constructs a PropertiesSection with the given Properties payload being UTF-8 encoded. The properties from the payload are copied into the PropertiesSection.
      Parameters:
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created PropertiesSection.

    • propertiesSection

      public static PropertiesSection propertiesSection(org.refcodes.properties.Properties aPayload, Charset aCharset)
      Constructs a PropertiesSection with the given Properties payload being encoded with the given Charset. The properties from the payload are copied into the PropertiesSection.
      Parameters:
      aPayload - The payload to be contained by the Section.
      aCharset - The Charset to be used for encoding the String.
      Returns:
      The accordingly created PropertiesSection.

    • propertiesSection

      public static PropertiesSection propertiesSection(org.refcodes.properties.Properties aPayload, TransmissionMetrics aTransmissionMetrics)
      Constructs a PropertiesSection with the given Properties payload being encoded with the given Charset. The properties from the payload are copied into the PropertiesSection. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aPayload - The payload to be contained by the Section.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created PropertiesSection.

    • propertiesSection

      public static PropertiesSection propertiesSection(String aAlias)
      Constructs an empty PropertiesSection using UTF-8 encoding for the payload.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created PropertiesSection.

    • propertiesSection

      public static PropertiesSection propertiesSection(String aAlias, Charset aCharset)
      Constructs a PropertiesSection with a payload expected to be encoded with the given Charset.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aCharset - The Charset to be used for encoding the String.
      Returns:
      The accordingly created PropertiesSection.

    • propertiesSection

      public static PropertiesSection propertiesSection(String aAlias, org.refcodes.properties.Properties aPayload)
      Constructs a PropertiesSection with the given Properties payload being UTF-8 encoded. The properties from the payload are copied into the PropertiesSection.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aPayload - The payload to be contained by the Section.
      Returns:
      The accordingly created PropertiesSection.

    • propertiesSection

      public static PropertiesSection propertiesSection(String aAlias, org.refcodes.properties.Properties aPayload, Charset aCharset)
      Constructs a PropertiesSection with the given Properties payload being encoded with the given Charset. The properties from the payload are copied into the PropertiesSection.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aPayload - The payload to be contained by the Section.
      aCharset - The Charset to be used for encoding the String.
      Returns:
      The accordingly created PropertiesSection.

    • propertiesSection

      public static PropertiesSection propertiesSection(String aAlias, org.refcodes.properties.Properties aPayload, TransmissionMetrics aTransmissionMetrics)
      Constructs a PropertiesSection with the given Properties payload being encoded with the given Charset. The properties from the payload are copied into the PropertiesSection. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aPayload - The payload to be contained by the Section.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created PropertiesSection.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aCtsTimeoutInMs, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSection

      public static <DECORATEE extends Section> ReadyToReceiveSectionDecorator<DECORATEE> readyToReceiveSection(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according control-flow decorator instance wrapping the given decoratee. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the control-flow decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ReadyToReceiveSectionDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, byte aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte aReadyToReceiveMagicBytes, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, byte[] aReadyToReceiveMagicBytes, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveMagicBytes - The RTR magic bytes to be used to signal a RTR.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, int aReadyToReceiveRetryNumber, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveRetryNumber - The number of retries sending an RTR over the return channel.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, long aReadyToReceiveTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aCtsTimeoutInMs, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aCtsTimeoutInMs - The timeout in milliseconds to wait for an RTR request (transmitter) from the receiver.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, long aReadyToReceiveTimeoutInMs, SegmentPackager aReadyToReceiveSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToReceiveTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTR ("ready-to-send") to the transmitter.
      aReadyToReceiveSegmentPackager - The RTR SegmentPackager for packaging RTR responses.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToReceiveSegment

      public static <DECORATEE extends Segment> ReadyToReceiveSegmentDecorator<DECORATEE> readyToReceiveSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according control-flow decorator instance wrapping the given decoratee. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the control-flow decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ReadyToReceiveSegmentDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSectionPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSectionPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSectionPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSectionPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSectionPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes no timeout (blocking mode).
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSectionPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a CTS response (transmitter) from the receiver after signaling a RTS ("ready-to-send") to the receiver.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSectionPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSectionPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSectionPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSectionPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSectionPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSectionPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSectionPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSectionPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSectionPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSection

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator<DECORATEE> readyToSendSection(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according control-flow decorator instance wrapping the given decoratee. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the control-flow decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.

    • readyToSendSectionBuilder

      public static <DECORATEE extends Section> ReadyToSendSectionDecorator.Builder<DECORATEE> readyToSendSectionBuilder()
      Constructs a builder to build an according ReadyToSendSectionDecorator instance.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Returns:
      The accordingly created ReadyToSendSectionDecorator.Builder.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes no timeout (blocking mode).
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, byte[] aClearToSendMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, byte[] aClearToSendMagicBytes)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a CTS response (transmitter) from the receiver after signaling a RTS ("ready-to-send") to the receiver.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, int aReadyToSendRetryNumber, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, byte[] aReadyToSendMagicBytes, SegmentPackager aReadyToSendSegmentPackager, byte[] aClearToSendMagicBytes, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendMagicBytes - The RTS characters to be used to signal a RTS.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendMagicBytes - The CTS characters to be used to signal a CTS.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, int aReadyToSendRetryNumber, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendRetryNumber - The number of retries sending an RTS over the payload (data) channel.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, long aClearToSendTimeoutInMs)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aEnquiryStandbyTimeInMs, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aEnquiryStandbyTimeInMs - The timeout in milliseconds to wait for an RTS request (receiver) from the transmitter. A value of -1 denotes the timeout being disabled.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, long aReadyToSendTimeoutInMs, SegmentPackager aReadyToSendSegmentPackager, long aClearToSendTimeoutInMs, SegmentPackager aClearToSendSegmentPackager)
      Constructs an according flow-control decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the flow-control decorator.
      aReadyToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a RTS ("ready-to-receive") to the transmitter.
      aReadyToSendSegmentPackager - The RTS SegmentPackager for packaging RTS responses.
      aClearToSendTimeoutInMs - The timeout in milliseconds to wait for a payload response (receiver) from the transmitter after signaling a CTS ("ready-to-receive") to the transmitter.
      aClearToSendSegmentPackager - The CTS SegmentPackager for packaging CTS responses.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegment

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator<DECORATEE> readyToSendSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according control-flow decorator instance wrapping the given decoratee. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the control-flow decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.

    • readyToSendSegmentBuilder

      public static <DECORATEE extends Segment> ReadyToSendSegmentDecorator.Builder<DECORATEE> readyToSendSegmentBuilder()
      Constructs a builder to build an according ReadyToSendSegmentDecorator instance.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be wrapped by the according decorator.
      Returns:
      The accordingly created ReadyToSendSegmentDecorator.Builder.

    • segmentComposite

      @SafeVarargs public static <CHILD extends Segment> SegmentComposite<CHILD> segmentComposite(CHILD... aChildren)
      Constructs a SegmentComposite containing the provided Segment elements.
      Type Parameters:
      CHILD - The Segment type describing the composite's Segment children.
      Parameters:
      aChildren - The Segment elements being contained in this instance.
      Returns:
      The accordingly created SegmentComposite.

    • segmentComposite

      public static <CHILD extends Segment> SegmentComposite<CHILD> segmentComposite(Collection<CHILD> aChildren)
      Constructs a SegmentComposite containing the provided Segment elements.
      Type Parameters:
      CHILD - The Segment type describing the composite's Segment children.
      Parameters:
      aChildren - The Segment elements being contained in this instance.
      Returns:
      The accordingly created SegmentComposite.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength()
      Constructs an empty allocation value with a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the referencee's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the referencee's length.
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Returns:
      The accordingly created LengthSegment.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty allocation value with a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the referencee's length and the provided Endianess representation of the referencee's length.
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Parameters:
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created LengthSegment.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength(int aLengthWidth)
      Constructs an empty allocation value with the given number of bytes used to specify the referencee's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the referencee's length.
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created LengthSegment.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty allocation value with the given number of bytes used to specify the referencee's length and the provided Endianess representation of the referencee's length.
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created LengthSegment.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength(REFERENCEE aReferencee)
      Constructs the allocation value with the given referencee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the referencee's length a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the referencee's length.
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Parameters:
      aReferencee - The referencee used for this allocation value.
      Returns:
      The accordingly created LengthSegment.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength(REFERENCEE aReferencee, org.refcodes.numerical.Endianess aEndianess)
      Constructs the allocation value with the given referencee and a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the referencee's length and the provided Endianess representation of the referencee's length.
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Parameters:
      aReferencee - The referencee used for this allocation value.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created LengthSegment.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength(REFERENCEE aReferencee, int aLengthWidth)
      Constructs the allocation value with the given referencee and with the given number of bytes used to specify the referencee's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the referencee's length.
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Parameters:
      aReferencee - The referencee used for this allocation value.
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created LengthSegment.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength(REFERENCEE aReferencee, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs the allocation value with the given referencee and with the given number of bytes used to specify the referencee's length and the provided Endianess representation of the referencee's length.
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Parameters:
      aReferencee - The referencee used for this allocation value.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created LengthSegment.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength(REFERENCEE aReferencee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Parameters:
      aReferencee - The referencee used for this allocation value.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created LengthSegment.

    • segmentLength

      public static <REFERENCEE extends Transmission> LengthSegment<REFERENCEE> segmentLength(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      REFERENCEE - The type of the Segment referencee.
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created LengthSegment.

    • sequenceNumberSegment

      public static SequenceNumberSegment sequenceNumberSegment(int aSequenceNumberWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.
      Parameters:
      aSequenceNumberWidth - The number of bytes to be occupied by the number.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created SequenceNumberSegment.

    • sequenceNumberSegment

      public static SequenceNumberSegment sequenceNumberSegment(int aSequenceNumberWidth, Long aSequenceNumberInitValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.
      Parameters:
      aSequenceNumberWidth - The number of bytes to be occupied by the number.
      aSequenceNumberInitValue - The value (payload) to be contained by the NumberSegment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created SequenceNumberSegment.

    • sequenceNumberSegment

      public static SequenceNumberSegment sequenceNumberSegment(long aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an empty SequenceNumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the SequenceNumberSegment's value.
      Parameters:
      aValue - The payload to be contained by the SequenceNumberSegment.
      aTransmissionMetrics - The TransmissionMetrics used to configure the SequenceNumberSegment.
      Returns:
      The accordingly created SequenceNumberSegment.

    • sequenceNumberSegment

      public static SequenceNumberSegment sequenceNumberSegment(String aAlias, int aSequenceNumberWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aSequenceNumberWidth - The number of bytes to be occupied by the number.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created SequenceNumberSegment.

    • sequenceNumberSegment

      public static SequenceNumberSegment sequenceNumberSegment(String aAlias, int aSequenceNumberWidth, Long aSequenceNumberInitValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a SequenceNumberSegment with the given TransmissionMetrics. Only those properties of the TransmissionMetrics are considered which are also supported by the other constructors.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aSequenceNumberWidth - The number of bytes to be occupied by the number.
      aSequenceNumberInitValue - The value (payload) to be contained by the NumberSegment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created SequenceNumberSegment.

    • sequenceNumberSegment

      public static SequenceNumberSegment sequenceNumberSegment(String aAlias, long aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an empty SequenceNumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the SequenceNumberSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the SequenceNumberSegment.
      aTransmissionMetrics - The TransmissionMetrics used to configure the SequenceNumberSegment.
      Returns:
      The accordingly created SequenceNumberSegment.

    • sequenceNumberSegment

      public static SequenceNumberSegment sequenceNumberSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an empty SequenceNumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the SequenceNumberSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aTransmissionMetrics - The TransmissionMetrics used to configure the SequenceNumberSegment.
      Returns:
      The accordingly created SequenceNumberSegment.

    • sequenceNumberSegment

      public static SequenceNumberSegment sequenceNumberSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an empty SequenceNumberSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the SequenceNumberSegment's value.
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics used to configure the SequenceNumberSegment.
      Returns:
      The accordingly created SequenceNumberSegment.

    • sequenceSection

      public static SequenceSection sequenceSection()
      Constructs a SequenceSection.
      Returns:
      The accordingly created SequenceSection.

    • sequenceSection

      public static SequenceSection sequenceSection(int aSequenceSize)
      Constructs a SequenceSection.
      Parameters:
      aSequenceSize - The size of the Sequence.
      Returns:
      The accordingly created SequenceSection.

    • sequenceSection

      public static SequenceSection sequenceSection(Sequence aSequence)
      Constructs a SequenceSection.
      Parameters:
      aSequence - The Sequence representing this SequenceSection.
      Returns:
      The accordingly created SequenceSection.

    • sequenceSection

      public static SequenceSection sequenceSection(String aAlias)
      Constructs a SequenceSection.
      Parameters:
      aAlias - The alias which identifies the content of this Section.
      Returns:
      The accordingly created SequenceSection.

    • sequenceSection

      public static SequenceSection sequenceSection(String aAlias, int aSequenceSize)
      Constructs a SequenceSection.
      Parameters:
      aAlias - The alias which identifies the content of this Segment.
      aSequenceSize - The size of the Sequence.
      Returns:
      The accordingly created SequenceSection.

    • sequenceSection

      public static SequenceSection sequenceSection(String aAlias, Sequence aSequence)
      Constructs a SequenceSection.
      Parameters:
      aAlias - The alias which identifies the content of this Segment.
      aSequence - The Sequence representing this SequenceSection.
      Returns:
      The accordingly created SequenceSection.

    • shortArraySection

      public static ShortArraySection shortArraySection()
      Constructs an empty ShortArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty ShortArraySection with the given Endianess.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(org.refcodes.numerical.Endianess aEndianess, short... aValue)
      Constructs a ShortArraySection with the given short array payload and the given Endianess for the representation of the ShortArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(org.refcodes.numerical.Endianess aEndianess, Short... aValue)
      Constructs a ShortArraySection with the given short array payload and the given Endianess for the representation of the ShortArraySection's value.
      Parameters:
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(short... aValue)
      Constructs a ShortArraySection with the given short array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortArraySection's value.
      Parameters:
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(Short... aValue)
      Constructs a ShortArraySection with the given short array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortArraySection's value.
      Parameters:
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(String aAlias)
      Constructs an empty ShortArraySection with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the Section's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty ShortArraySection with the given Endianess.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, short... aValue)
      Constructs a ShortArraySection with the given short array payload and the given Endianess for the representation of the ShortArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, Short... aValue)
      Constructs a ShortArraySection with the given short array payload and the given Endianess for the representation of the ShortArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(String aAlias, short... aValue)
      Constructs a ShortArraySection with the given short array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(String aAlias, Short... aValue)
      Constructs a ShortArraySection with the given short array payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortArraySection's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, short... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, Short... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(TransmissionMetrics aTransmissionMetrics, short... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortArraySection

      public static ShortArraySection shortArraySection(TransmissionMetrics aTransmissionMetrics, Short... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the ShortArraySection.
      Returns:
      The accordingly created ShortArraySection.

    • shortSegment

      public static ShortSegment shortSegment()
      Constructs an empty ShortSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortSegment's value.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty ShortSegment with the given Endianess endian representation of the ShortSegment's value.
      Parameters:
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(Short aValue)
      Constructs a ShortSegment with the given short payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortSegment's value.
      Parameters:
      aValue - The value (payload) to be contained by the ShortSegment.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(Short aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a ShortSegment with the given short payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aValue - The value (payload) to be contained by the ShortSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(Short aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(String aAlias)
      Constructs an empty ShortSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty ShortSegment with the given Endianess endian representation of the ShortSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(String aAlias, Short aValue)
      Constructs a ShortSegment with the given short payload and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the ShortSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the ShortSegment.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(String aAlias, Short aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a ShortSegment with the given short payload and the given Endianess for the representation of the Segment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the ShortSegment.
      aEndianess - The Endianess to be used for the payload values.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(String aAlias, Short aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ShortSegment.

    • shortSegment

      public static ShortSegment shortSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created ShortSegment.

    • stopAndWaitPacketStreamSection

      public static <DECORATEE extends Section> StopAndWaitPacketStreamSectionDecorator<DECORATEE> stopAndWaitPacketStreamSection(DECORATEE aDecoratee, int aBlockSize, int aPacketLengthWidth, byte[] aPacketMagicBytes, byte[] aLastPacketMagicBytes, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, SegmentPackager aPacketSegmentPackager, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according packet-stream decorator instance wrapping the given OutputStream.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be chunked into blocks and enriched with a CRC checksum and a sequence number.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the packet-stream decorator.
      aBlockSize - The block size of a data block for each packet.
      aPacketLengthWidth - The width (bytes) for declaring the (max) length of a package.
      aPacketMagicBytes - The magic bytes identifying a packet and distinguishing a packet from a last package.
      aLastPacketMagicBytes - the a last packet magic bytes
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aPacketSegmentPackager - An (optional) SegmentPackager used to modify a packet's data e.g. with a CRC checksum.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aAckSegmentPackager - An (optional) SegmentPackager used to modify a ACK response data e.g. with a CRC checksum.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitPacketStreamSectionDecorator.

    • stopAndWaitPacketStreamSection

      public static <DECORATEE extends Section> StopAndWaitPacketStreamSectionDecorator<DECORATEE> stopAndWaitPacketStreamSection(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according packet-stream decorator instance wrapping the given OutputStream. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be chunked into blocks and enriched with a CRC checksum and a sequence number.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the packet-stream decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StopAndWaitPacketStreamSectionDecorator.

    • stopAndWaitPacketStreamSectionBuilder

      public static <DECORATEE extends Section> StopAndWaitPacketStreamSectionDecorator.Builder<DECORATEE> stopAndWaitPacketStreamSectionBuilder()
      Constructs a builder to build an according StopAndWaitPacketStreamSectionDecorator instance.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Returns:
      The StopAndWaitPacketStreamSectionDecorator.Builder to build a StopAndWaitPacketStreamSectionDecorator.

    • stopAndWaitPacketStreamSegment

      public static <DECORATEE extends Segment> StopAndWaitPacketStreamSegmentDecorator<DECORATEE> stopAndWaitPacketStreamSegment(DECORATEE aDecoratee, int aBlockSize, int aPacketLengthWidth, byte[] aPacketMagicBytes, byte[] aLastPacketMagicBytes, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, SegmentPackager aPacketSegmentPackager, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according packet-stream decorator instance wrapping the given OutputStream.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be chunked into blocks and enriched with a CRC checksum and a sequence number.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the packet-stream decorator.
      aBlockSize - The block size of a data block for each packet.
      aPacketLengthWidth - The width (bytes) for declaring the (max) length of a package.
      aPacketMagicBytes - The magic bytes identifying a packet and distinguishing a packet from a last package.
      aLastPacketMagicBytes - the a last packet magic bytes
      aSequenceNumberInitValue - the a sequence number init value
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aPacketSegmentPackager - An (optional) SegmentPackager used to modify a packet's data e.g. with a CRC checksum.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aAckSegmentPackager - An (optional) SegmentPackager used to modify a ACK response data e.g. with a CRC checksum.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitPacketStreamSegmentDecorator.

    • stopAndWaitPacketStreamSegment

      public static <DECORATEE extends Segment> StopAndWaitPacketStreamSegmentDecorator<DECORATEE> stopAndWaitPacketStreamSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according packet-stream decorator instance wrapping the given OutputStream. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be chunked into blocks and enriched with a CRC checksum and a sequence number.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the packet-stream decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StopAndWaitPacketStreamSegmentDecorator.

    • stopAndWaitPacketStreamSegmentBuilder

      public static <DECORATEE extends Segment> StopAndWaitPacketStreamSegmentDecorator.Builder<DECORATEE> stopAndWaitPacketStreamSegmentBuilder()
      Constructs a builder to build an according StopAndWaitPacketStreamSegmentDecorator instance.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Returns:
      The StopAndWaitPacketStreamSegmentDecorator.Builder to build a StopAndWaitPacketStreamSegmentDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aAckSegmentPackager - the ack segment packager
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aAckSegmentPackager - the ack segment packager
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aAckSegmentPackager - the ack segment packager
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, SegmentPackager aAckSegmentPackager)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAckSegmentPackager - the ack segment packager
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSection

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator<DECORATEE> stopAndWaitSection(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The Section type describing the Section subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSectionBuilder

      public static <DECORATEE extends Section> StopAndWaitSectionDecorator.Builder<DECORATEE> stopAndWaitSectionBuilder()
      Constructs a builder to build an according StopAndWaitSectionDecorator instance.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Returns:
      The StopAndWaitSectionDecorator.Builder to build a StopAndWaitSectionDecorator. The accordingly created StopAndWaitSectionDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aAckSegmentPackager - the ack segment packager
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aAckSegmentPackager - the ack segment packager
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.ChecksumValidationMode aChecksumValidationMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aChecksumValidationMode - The mode of operation when validating provided CRC checksums against calculated ones.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.mixin.ConcatenateMode aCrcChecksumConcatenateMode, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aCrcChecksumConcatenateMode - The mode of concatenation to use when concatenating the CRC checksum with the transmission's Sequence.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.CrcAlgorithm aCrcAlgorithm, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aCrcAlgorithm - The CrcAlgorithm to be used for CRC checksum calculation.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, int aSequenceNumberInitValue, int aSequenceNumberWidth, org.refcodes.mixin.ConcatenateMode aSequenceNumberConcatenateMode, byte[] aAcknowledgeMagicBytes, int aAckRetryNumber, long aAckTimeoutInMs, SegmentPackager aAckSegmentPackager, org.refcodes.numerical.Endianess aEndianess)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aSequenceNumberInitValue - The initial sequence number from where to start counting the blocks.
      aSequenceNumberWidth - The width (in bytes) to be used for sequence number values.
      aSequenceNumberConcatenateMode - The mode of concatenation to use when creating a Sequence from this Transmission and the decorated Transmission.
      aAcknowledgeMagicBytes - The ACK character(s) to be used by the return channel to transmit an ACK (acknowledge) response after successful receiving a transmission.
      aAckRetryNumber - The number of retries waiting for an ACK from the return channel.
      aAckTimeoutInMs - The timeout in milliseconds to pend till the next retry.
      aAckSegmentPackager - the ack segment packager
      aEndianess - The Endianess to use for integer (double) numbers and the like.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, SegmentPackager aAckSegmentPackager)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee.
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aAckSegmentPackager - the ack segment packager
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegment

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator<DECORATEE> stopAndWaitSegment(DECORATEE aDecoratee, TransmissionMetrics aTransmissionMetrics)
      Constructs an according stop-and-wait decorator instance wrapping the given decoratee. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Type Parameters:
      DECORATEE - The Segment type describing the Segment subclass decoratee.
      Parameters:
      aDecoratee - The decoratee to be wrapped by the stop-and-wait decorator.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StopAndWaitSegmentDecorator.

    • stopAndWaitSegmentBuilder

      public static <DECORATEE extends Segment> StopAndWaitSegmentDecorator.Builder<DECORATEE> stopAndWaitSegmentBuilder()
      Constructs a builder to build an according StopAndWaitSegmentDecorator instance.
      Type Parameters:
      DECORATEE - The decoratee type describing the according subclass to be enriched.
      Returns:
      The StopAndWaitSegmentDecorator.Builder to build a StopAndWaitSegmentDecorator. The accordingly created StopAndWaitSegmentDecorator.

    • stringArraySection

      public static StringArraySection stringArraySection()
      Constructs an empty StringArraySection using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(Charset aCharset, String... aValue)
      Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, as well as the TransmissionMetrics.DEFAULT_ENDIANESS.
      Parameters:
      aCharset - The Charset to use when encoding or decoding the String instances.
      aValue - The String elements being contained in this instance.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aValue)
      Constructs a StringArraySection using containing the provided StringSection elements and using the provided Segment class for creating Segment instances.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for size values.
      aEndianess - The Endianess to be used for size values.
      aCharset - The Charset to use when encoding or decoding the String instances.
      aValue - The String elements being contained in this instance.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(String... aValue)
      Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aValue - The String elements being contained in this instance.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(String aAlias)
      Constructs an empty StringArraySection using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(String aAlias, Charset aCharset, String... aValue)
      Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, as well as the TransmissionMetrics.DEFAULT_ENDIANESS.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aCharset - The Charset to use when encoding or decoding the String instances.
      aValue - The String elements being contained in this instance.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(String aAlias, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess, Charset aCharset, String... aValue)
      Constructs a StringArraySection using containing the provided StringSection elements and using the provided Segment class for creating Segment instances.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aLengthWidth - The width (in bytes) to be used for size values.
      aEndianess - The Endianess to be used for size values.
      aCharset - The Charset to use when encoding or decoding the String instances.
      aValue - The String elements being contained in this instance.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(String aAlias, String[] aValue)
      Constructs a StringArraySection containing the provided payload and using the TransmissionMetrics.DEFAULT_LENGTH_WIDTH, the TransmissionMetrics.DEFAULT_ENDIANESS as well as the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The String elements being contained in this instance.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(String aAlias, TransmissionMetrics aTransmissionMetrics, String... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the StringArraySection.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StringArraySection.

    • stringArraySection

      public static StringArraySection stringArraySection(TransmissionMetrics aTransmissionMetrics, String... aValue)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      aValue - The payload to be contained by the StringArraySection.
      Returns:
      The accordingly created StringArraySection.

    • stringSection

      public static StringSection stringSection()
      Constructs an empty StringSection using the TransmissionMetrics.DEFAULT_ENCODING encoding for the payload.
      Returns:
      The accordingly created StringSection.

    • stringSection

      public static StringSection stringSection(Charset aCharset)
      Constructs a StringSection with a payload expected to be encoded with the given Charset.
      Parameters:
      aCharset - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created StringSection.

    • stringSection

      public static StringSection stringSection(String aValue)
      Constructs a StringSection with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aValue - The payload to be contained by this StringSection.
      Returns:
      The accordingly created StringSection.

    • stringSection

      public static StringSection stringSection(String aValue, Charset aCharset)
      Constructs a StringSection with the given String payload being encoded with the given Charset.
      Parameters:
      aValue - The payload to be contained by this StringSection.
      aCharset - The Charset to be used for encoding the String.
      Returns:
      The accordingly created StringSection.

    • stringSection

      public static StringSection stringSection(String aAlias, String aValue)
      Constructs a StringSection with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSection.
      Returns:
      The accordingly created StringSection.

    • stringSection

      public static StringSection stringSection(String aAlias, String aValue, Charset aCharset)
      Constructs a StringSection with the given String payload being encoded with the given Charset.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSection.
      aCharset - The Charset to be used for encoding the String.
      Returns:
      The accordingly created StringSection.

    • stringSection

      public static StringSection stringSection(String aAlias, String aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the StringSection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StringSection.

    • stringSection

      public static StringSection stringSection(String aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the StringSection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StringSection.

    • stringSection

      public static StringSection stringSection(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StringSection.

    • stringSegment

      public static StringSegment stringSegment()
      Constructs a StringSegment.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(Charset aEncoding)
      Constructs a StringSegment with a payload expected to be encoded with the given Charset.
      Parameters:
      aEncoding - The Charset to be used for encoding and decoding String instances.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(Charset aEncoding, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with a payload expected to be encoded with the given Charset.
      Parameters:
      aEncoding - The Charset to be used for encoding and decoding String instances.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(Charset aEncoding, int aLengthWidth)
      Constructs a StringSegment with a payload expected to be encoded with the given Charset.
      Parameters:
      aEncoding - The Charset to be used for encoding and decoding String instances.
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(Charset aEncoding, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with a payload expected to be encoded with the given Charset.
      Parameters:
      aEncoding - The Charset to be used for encoding and decoding String instances.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty allocation value with a width of TransmissionMetrics.DEFAULT_LENGTH_WIDTH bytes used to specify the decoratee's length and the provided Endianess representation of the decoratee's length.
      Parameters:
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(int aLengthWidth)
      Constructs an empty allocation value with the given number of bytes used to specify the decoratee's length and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the decoratee's length.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty allocation value with the given number of bytes used to specify the decoratee's length and the provided Endianess representation of the decoratee's length.
      Parameters:
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aValue)
      Constructs a StringSegment with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aValue - The payload to be contained by this StringSegment.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aValue, Charset aEncoding)
      Constructs a StringSegment with the given String payload being encoded with the given Charset.
      Parameters:
      aValue - The payload to be contained by this StringSegment.
      aEncoding - The Charset to be used for encoding the String.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aValue, Charset aEncoding, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with the given String payload being encoded with the given Charset.
      Parameters:
      aValue - The payload to be contained by this StringSegment.
      aEncoding - The Charset to be used for encoding the String.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aValue, Charset aEncoding, int aLengthWidth)
      Constructs a StringSegment with the given String payload being encoded with the given Charset.
      Parameters:
      aValue - The payload to be contained by this StringSegment.
      aEncoding - The Charset to be used for encoding the String.
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aValue, Charset aEncoding, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with the given String payload being encoded with the given Charset.
      Parameters:
      aValue - The payload to be contained by this StringSegment.
      aEncoding - The Charset to be used for encoding the String.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aValue - The payload to be contained by this StringSegment.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aValue, int aLengthWidth)
      Constructs a StringSegment with the given Stringpayload* being encoded with the TransmissionMetrics.DEFAULT_ENCODING.**
      Parameters:
      aValue - The payload to be contained by this StringSegment.
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aValue - The payload to be contained by this StringSegment.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aAlias, String aValue)
      Constructs a StringSegment with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSegment.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aAlias, String aValue, Charset aEncoding)
      Constructs a StringSegment with the given String payload being encoded with the given Charset.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSegment.
      aEncoding - The Charset to be used for encoding the String.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aAlias, String aValue, Charset aEncoding, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with the given String payload being encoded with the given Charset.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSegment.
      aEncoding - The Charset to be used for encoding the String.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aAlias, String aValue, Charset aEncoding, int aLengthWidth)
      Constructs a StringSegment with the given String payload being encoded with the given Charset.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSegment.
      aEncoding - The Charset to be used for encoding the String.
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aAlias, String aValue, Charset aEncoding, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with the given String payload being encoded with the given Charset.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSegment.
      aEncoding - The Charset to be used for encoding the String.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aAlias, String aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSegment.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aAlias, String aValue, int aLengthWidth)
      Constructs a StringSegment with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSegment.
      aLengthWidth - The width (in bytes) to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aAlias, String aValue, int aLengthWidth, org.refcodes.numerical.Endianess aEndianess)
      Constructs a StringSegment with the given String payload being encoded with the TransmissionMetrics.DEFAULT_ENCODING.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The payload to be contained by this StringSegment.
      aLengthWidth - The width (in bytes) to be used for length values.
      aEndianess - The Endianess to be used for length values.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aAlias, String aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the StringSegment.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(String aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the StringSegment.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StringSegment.

    • stringSegment

      public static StringSegment stringSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.
      Returns:
      The accordingly created StringSegment.

    • stringSegmentBuilder

      public static StringSegment.Builder stringSegmentBuilder()
      Constructs a builder to build an according StringSegment instance.
      Returns:
      The accordingly created StringSegment.Builder.