com.io7m.smfj.format.binary

## Interface SMFBSectionType

- All Known Implementing Classes:
    SMFBSection

      public interface SMFBSectionType

  A parsed section.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `SECTION_ALIGNMENT` The required natural alignment of sections.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `default void` | `checkPreconditions()` Check preconditions for the type.
    `long` | `id()`
    `long` | `offset()`
    `long` | `sizeOfData()` The size of the section data, not including the magic number or this size value.
    `default long` | `sizeTotal()`

- - ### Field Detail

    - #### SECTION_ALIGNMENT

          static final int SECTION_ALIGNMENT

      The required natural alignment of sections.
      See Also:
        Constant Field Values

  - ### Method Detail

    - #### id

          long id()

      Returns:
        The identifier of this section

    - #### sizeOfData

          long sizeOfData()

      The size of the section data, not including the magic number or this size value.

      `sizeOfData() + 8 + 8` must be a multiple of `SECTION_ALIGNMENT`

      Returns:
        The size of this section

    - #### offset

          long offset()

      Returns:
        The absolute offset of the start of the section

    - #### sizeTotal

          default long sizeTotal()

      Returns:
        The total size of the section: The size of the data plus the header

    - #### checkPreconditions

          default void checkPreconditions()

      Check preconditions for the type.

Copyright © 2017 <code@io7m.com> http://io7m.com