SubRecord (The Adobe Experience Manager SDK 2022.11.9850.20221116T162329Z-220900)

java.lang.Object
- org.apache.poi.hssf.record.SubRecord

Direct Known Subclasses:

CommonObjectDataSubRecord, EmbeddedObjectRefSubRecord, EndSubRecord, FtCblsSubRecord, FtCfSubRecord, FtPioGrbitSubRecord, GroupMarkerSubRecord, LbsDataSubRecord, NoteStructureSubRecord
```
public abstract class SubRecord
extends java.lang.Object
```
Subrecords are part of the OBJ class.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract SubRecord`	`clone()`
`static SubRecord`	`createSubRecord(LittleEndianInput in, int cmoOt)`	read a sub-record from the supplied stream
`boolean`	`isTerminating()`	Whether this record terminates the sub-record stream.
`byte[]`	`serialize()`
`abstract void`	`serialize(LittleEndianOutput out)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createSubRecord
```
public static SubRecord createSubRecord(LittleEndianInput in,
                                        int cmoOt)
```
    read a sub-record from the supplied stream
    
    Parameters:
    
    in - the stream to read from
    
    cmoOt - the objectType field of the containing CommonObjectDataSubRecord, we need it to propagate to next sub-records as it defines what data follows
    
    Returns:
    
    the created sub-record
  - serialize
```
public byte[] serialize()
```
  - serialize
```
public abstract void serialize(LittleEndianOutput out)
```
  - clone
```
public abstract SubRecord clone()
```
  - isTerminating
```
public boolean isTerminating()
```
    Whether this record terminates the sub-record stream. There are two cases when this method must be overridden and return true - EndSubRecord (sid = 0x00) - LbsDataSubRecord (sid = 0x12)
    
    Returns:
    
    whether this record is the last in the sub-record stream