RiffFileWriterChunkDescriptionType (com.io7m.jspiel.documentation 0.0.2 API)

public interface RiffFileWriterChunkDescriptionType

A description of a RIFF chunk to be built.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.Optional<RiffChunkDataWriterType>`	`dataWriter()`
`java.util.OptionalLong`	`declaredSize()`
`RiffFileWriterDescriptionType`	`file()`
`java.util.Optional<java.lang.String>`	`form()`
`RiffChunkID`	`id()`
`long`	`ordinal()`	Retrieve the ordinal number of the chunk.
`java.util.Optional<RiffFileWriterChunkDescriptionType>`	`parent()`
`java.util.List<RiffFileWriterChunkDescriptionType>`	`subChunks()`

- Method Detail
  - ordinal
```
long ordinal()
```
    Retrieve the ordinal number of the chunk. The ordinal number is essentially a number that indicates in what order the chunk will appear in the output file. For any given chunk, the ordinal number is guaranteed to be greater than that of the parent chunk's ordinal, and is guaranteed to be greater than that of any previous sibling chunks. The ordinal number is also guaranteed to be unique within a file.
    
    Returns:
    
    The ordinal number of the chunk
  - file
```
RiffFileWriterDescriptionType file()
```
    Returns:
    
    The file to which this chunk belongs
  - parent
```
java.util.Optional<RiffFileWriterChunkDescriptionType> parent()
```
    Returns:
    
    The parent chunk of this chunk, if any
  - id
```
RiffChunkID id()
```
    Returns:
    
    The ID of the chunk
  - declaredSize
```
java.util.OptionalLong declaredSize()
```
    Returns:
    
    The declared size of the chunk, if any
  - subChunks
```
java.util.List<RiffFileWriterChunkDescriptionType> subChunks()
```
    Returns:
    
    The list of subchunks of this chunk
  - form
```
java.util.Optional<java.lang.String> form()
```
    Returns:
    
    The chunk form, if any
  - dataWriter
```
java.util.Optional<RiffChunkDataWriterType> dataWriter()
```
    Returns:
    
    The supplier of data for the chunk