org.apache.poi.hssf.record

## Class MMSRecord

- java.lang.Object
- - org.apache.poi.hssf.record.RecordBase
  - - org.apache.poi.hssf.record.Record
    - - org.apache.poi.hssf.record.StandardRecord
      - - org.apache.poi.hssf.record.MMSRecord

- All Implemented Interfaces:
    Duplicatable

      public final class MMSRecord
      extends StandardRecord

  defines how many add menu and del menu options are stored in the file. Should always be set to 0 for HSSF workbooks.
  Version:
    2.0-pre

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static short` | `sid`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MMSRecord()`
    `MMSRecord(MMSRecord other)`
    `MMSRecord(RecordInputStream in)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `MMSRecord` | `copy()`
    `byte` | `getAddMenuCount()` get number of add menu options (should be 0)
    `protected int` | `getDataSize()`
    `byte` | `getDelMenuCount()` get number of add del options (should be 0)
    `short` | `getSid()` return the non static version of the id for this record.
    `void` | `serialize(LittleEndianOutput out)` Write the data content of this BIFF record.
    `void` | `setAddMenuCount(byte am)` set number of add menu options (set to 0)
    `void` | `setDelMenuCount(byte dm)` set number of del menu options (set to 0)
    `java.lang.String` | `toString()` get a string representation of the record (for biffview/debugging)

    - ### Methods inherited from class org.apache.poi.hssf.record.StandardRecord

      `getRecordSize, serialize`

    - ### Methods inherited from class org.apache.poi.hssf.record.Record

      `cloneViaReserialise, serialize`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### sid

          public static final short sid

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### MMSRecord

          public MMSRecord()

    - #### MMSRecord

          public MMSRecord(MMSRecord other)

    - #### MMSRecord

          public MMSRecord(RecordInputStream in)

  - ### Method Detail

    - #### setAddMenuCount

          public void setAddMenuCount(byte am)

      set number of add menu options (set to 0)
      Parameters:
        `am` - number of add menu options

    - #### setDelMenuCount

          public void setDelMenuCount(byte dm)

      set number of del menu options (set to 0)
      Parameters:
        `dm` - number of del menu options

    - #### getAddMenuCount

          public byte getAddMenuCount()

      get number of add menu options (should be 0)
      Returns:
        number of add menu options

    - #### getDelMenuCount

          public byte getDelMenuCount()

      get number of add del options (should be 0)
      Returns:
        number of add menu options

    - #### toString

          public java.lang.String toString()

      Description copied from class: `Record`
      get a string representation of the record (for biffview/debugging)
      Overrides:
        `toString` in class `Record`

    - #### serialize

          public void serialize(LittleEndianOutput out)

      Description copied from class: `StandardRecord`
      Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

      The number of bytes written must equal the record size reported by `RecordBase.getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

      Specified by:
        `serialize` in class `StandardRecord`
      Parameters:
        `out` - the output object

    - #### getDataSize

          protected int getDataSize()

      Specified by:
        `getDataSize` in class `StandardRecord`

    - #### getSid

          public short getSid()

      Description copied from class: `Record`
      return the non static version of the id for this record.
      Specified by:
        `getSid` in class `Record`
      Returns:
        he id for this record

    - #### copy

          public MMSRecord copy()

      Specified by:
        `copy` in interface `Duplicatable`
      Specified by:
        `copy` in class `StandardRecord`
      Returns:
        a deep copy of the implementing class / instance

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.