Interface ArrayStringable

    • Method Detail

      • hasStringValue

        boolean hasStringValue​(Settings settings)
        For cases where an array of this type exists, determines if a String value will be returned.

        Parameters:
        settings -
        Returns:
        true if array of this type with the specified settings will return a String value.
      • getArrayString

        default java.lang.String getArrayString​(MemBuffer buf,
                                                Settings settings,
                                                int length)
        For cases where an array of this type exists, get the array value as a String. When data corresponds to character data it should generally be expressed as a string. A null value is returned if not supported or memory is uninitialized.
        Parameters:
        buf - data buffer
        settings - data settings
        length - length of array
        Returns:
        array value expressed as a string or null if data is not character data
      • getArrayDefaultLabelPrefix

        java.lang.String getArrayDefaultLabelPrefix​(MemBuffer buf,
                                                    Settings settings,
                                                    int len,
                                                    DataTypeDisplayOptions options)
        For cases where an array of this type exists, get the appropriate string to use as the default label prefix for the array.
        Parameters:
        buf - memory buffer containing the bytes.
        settings - the Settings object
        len - the length of the data.
        options - options for how to format the default label prefix.
        Returns:
        the default label prefix or null if none specified.
      • getArrayDefaultOffcutLabelPrefix

        java.lang.String getArrayDefaultOffcutLabelPrefix​(MemBuffer buf,
                                                          Settings settings,
                                                          int len,
                                                          DataTypeDisplayOptions options,
                                                          int offcutLength)
        For cases where an array of this type exists, get the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that references offcutLength bytes into this type
        Parameters:
        buf - memory buffer containing the bytes.
        settings - the Settings object.
        len - the length of the data.
        options - options for how to format the default label prefix.
        offcutLength - the length of the offcut label prefix.
        Returns:
        the default label prefix or null if none specified.
      • getArrayStringable

        static ArrayStringable getArrayStringable​(DataType dt)
        Get the ArrayStringable for a specified data type. Not used on an Array DataType, but on Array's element's type.

        Parameters:
        dt - data type
        Returns:
        ArrayStringable object, or null.