Class MAPLCSCodeword

    • Constructor Detail

      • MAPLCSCodeword

        public MAPLCSCodeword()
        Constructs an object with uninitialised state.
      • MAPLCSCodeword

        public MAPLCSCodeword​(byte[] DataCodingScheme_param,
                              byte[] LcsCodewordString_param)
        Constructs an object from given values for all fields.
        Parameters:
        DataCodingScheme_param - value for that field
        LcsCodewordString_param - value for that field
    • Method Detail

      • copyOf

        public static MAPLCSCodeword copyOf​(MAPLCSCodeword from)
        Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
        Parameters:
        from - the object from which to copy
        Returns:
        MAPLCSCodeword
      • getDataCodingScheme

        public byte[] getDataCodingScheme()
        Gets the value of the field dataCodingScheme.
        Returns:
        value of field dataCodingScheme, or null if not present
      • getFieldAccessors

        public static FieldAccessor[] getFieldAccessors()
        Gets a new array of the accessors for fields of this type.
        Returns:
        FieldAccessor[]
      • getFieldsMap

        public Map<String,​Object> getFieldsMap​(boolean withAbsents)
        Gets a Map from field-name to field-value. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an unitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED.
        Specified by:
        getFieldsMap in class AbstractFieldsObject
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value
      • getLcsCodewordString

        public byte[] getLcsCodewordString()
        Gets the value of the field lcsCodewordString.
        Returns:
        value of field lcsCodewordString, or null if not present
      • hasDataCodingScheme

        public boolean hasDataCodingScheme()
        Tests whether the field dataCodingScheme has a value.
        Returns:
        whether the field dataCodingScheme has a value
      • hasLcsCodewordString

        public boolean hasLcsCodewordString()
        Tests whether the field lcsCodewordString has a value.
        Returns:
        whether the field lcsCodewordString has a value
      • setDataCodingScheme

        public MAPLCSCodeword setDataCodingScheme​(byte[] value)
                                           throws IllegalStateException
        Sets the value of the field dataCodingScheme.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only
      • setLcsCodewordString

        public MAPLCSCodeword setLcsCodewordString​(byte[] value)
                                            throws IllegalStateException
        Sets the value of the field lcsCodewordString.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only