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

Class DynamicTypeSection

    • Constructor Detail

      • DynamicTypeSection

        public DynamicTypeSection​(int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess)
        Constructs the 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.

      • DynamicTypeSection

        public DynamicTypeSection​(int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          Charset aCharset)
        Constructs the 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.

      • DynamicTypeSection

        public DynamicTypeSection​(String aAlias,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess)
        Constructs the 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.

      • DynamicTypeSection

        public DynamicTypeSection​(String aAlias,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          Charset aCharset)
        Constructs the 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.

      • DynamicTypeSection

        public DynamicTypeSection​(String aAlias,
                          T aValue,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess)
        Constructs the DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of 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.

      • DynamicTypeSection

        public DynamicTypeSection​(String aAlias,
                          T aValue,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          Charset aCharset)
        Constructs the DynamicTypeSection with the given properties. It is pre-initialized with the given value as of 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.

      • DynamicTypeSection

        public DynamicTypeSection​(String aAlias,
                          T aValue,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          Charset aCharset,
                          String... aAttributes)
        Constructs the DynamicTypeSection with the given properties. It is pre-initialized with the given value as of 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.

      • DynamicTypeSection

        public DynamicTypeSection​(String aAlias,
                          T aValue,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          String... aAttributes)
        Constructs the DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of 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.

      • DynamicTypeSection

        public DynamicTypeSection​(String aAlias,
                          T aValue,
                          TransmissionMetrics aTransmissionMetrics)
        Constructs the DynamicTypeSection with the given properties. It is pre-initialized with the given value as of fromType(Object). 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.

      • DynamicTypeSection

        public DynamicTypeSection​(String aAlias,
                          T aValue,
                          TransmissionMetrics aTransmissionMetrics,
                          String... aAttributes)
        Constructs the DynamicTypeSection with the given properties. It is pre-initialized with the given value as of fromType(Object, String...). 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.

      • DynamicTypeSection

        public DynamicTypeSection​(String aAlias,
                          TransmissionMetrics aTransmissionMetrics)
        Constructs the 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.

      • DynamicTypeSection

        public DynamicTypeSection​(T aValue,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess)
        Constructs the DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of 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.

      • DynamicTypeSection

        public DynamicTypeSection​(T aValue,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          Charset aCharset)
        Constructs the DynamicTypeSection with the given properties. It is pre-initialized with the given value as of 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.

      • DynamicTypeSection

        public DynamicTypeSection​(T aValue,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          Charset aCharset,
                          String... aAttributes)
        Constructs the DynamicTypeSection with the given properties. It is pre-initialized with the given value as of 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.

      • DynamicTypeSection

        public DynamicTypeSection​(T aValue,
                          int aLengthWidth,
                          org.refcodes.numerical.Endianess aEndianess,
                          String... aAttributes)
        Constructs the DynamicTypeSection with the given properties as well as with the TransmissionMetrics.DEFAULT_ENCODING. It is pre-initialized with the given value as of 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.

      • DynamicTypeSection

        public DynamicTypeSection​(T aValue,
                          TransmissionMetrics aTransmissionMetrics)
        Constructs the DynamicTypeSection with the given properties. It is pre-initialized with the given value as of fromType(Object). 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.

      • DynamicTypeSection

        public DynamicTypeSection​(T aValue,
                          TransmissionMetrics aTransmissionMetrics,
                          String... aAttributes)
        Constructs the DynamicTypeSection with the given properties. It is pre-initialized with the given value as of fromType(Object, String...). 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.

      • DynamicTypeSection

        public DynamicTypeSection​(TransmissionMetrics aTransmissionMetrics)
        Constructs the 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.

    • Method Detail

      • fromType

        public <T> void fromType​(T aValue)
        Constructs the DynamicTypeSection's Sequence from the given type's 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 DynamicTypeTransmission.fromType(Object, String[]) instead!
        Specified by:
        fromType in interface DynamicTypeTransmission
        Type Parameters:
        T - The type of the data structure representing the body.
        Parameters:
        aValue - The data structure's value.

      • fromType

        public <T> void fromType​(T aValue,
                         String... aAttributes)
        Constructs an instance for the given type T. . The attributes of the given data structure are processed using the predefined set of attributes in their according order.
        Specified by:
        fromType in interface DynamicTypeTransmission
        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.

      • getEncoding

        public Charset getEncoding()
        Specified by:
        getEncoding in interface org.refcodes.mixin.EncodingAccessor<Charset>

      • getEndianess

        public org.refcodes.numerical.Endianess getEndianess()
        Specified by:
        getEndianess in interface org.refcodes.numerical.EndianessAccessor

      • getLengthWidth

        public int getLengthWidth()
        Retrieves the length width (in bytes) from the length width (in bytes) property.
        Specified by:
        getLengthWidth in interface LengthWidthAccessor
        Returns:
        The length width (in bytes) stored by the length width (in bytes) property.

      • toSimpleTypeMap

        public org.refcodes.struct.SimpleTypeMap toSimpleTypeMap()
        Returns the SimpleTypeMap representation of this Transmission. In case this Transmission has Transmission children, then the children are queried as well and contained in the resulting SimpleTypeMap. The aliases of the according Transmission instances represent the resulting path to a Transmission's final simple type.
        Specified by:
        toSimpleTypeMap in interface Transmission
        Overrides:
        toSimpleTypeMap in class SequenceSection
        Returns:
        The SimpleTypeMap representing this Transmission and (if any) its children, with the according aliases forming the paths to the Transmission's values.

      • toType

        public <T> T toType​(Class<T> aType,
                    String... aAttributes)
             throws IllegalArgumentException
        Constructs an instance for the given type T. . The attributes of the given data structure are processed using the predefined set of attributes in their according order
        Specified by:
        toType in interface DynamicTypeTransmission
        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 according type constructed from the DynamicTypeSection's Sequence.
        Throws:
        IllegalArgumentException - thrown in case the DynamicTypeSection's Sequence does not match the provided type.