# Class LCaptionFiles

java.lang.Object
com.io7m.laurel.filemodel.internal.LCaptionFiles

public final class LCaptionFiles extends Object
Functions to parse and serialize caption files.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static List<LCaptionName>`
  `parse(Map<String,Object> attributes, Path file)`
  Parse a caption file.
  `static void`
  `serialize(Map<String,Object> attributes, List<LGlobalCaption> globalCaptions, List<LCaption> captions, Path outputFile)`
  Serialize captions.

  ### Methods inherited from class Object

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

- ## Method Details

  - ### parse

    public static List<LCaptionName> parse(Map<String,Object> attributes, Path file) throws Exception
    Parse a caption file.
    Parameters:
      `attributes` - The error attributes
      `file` - The file
    Returns:
      The parsed caption names
    Throws:
      `Exception` - On errors

  - ### serialize

    public static void serialize(Map<String,Object> attributes, List<LGlobalCaption> globalCaptions, List<LCaption> captions, Path outputFile) throws Exception
    Serialize captions.
    Parameters:
      `attributes` - The error attributes
      `globalCaptions` - The global captions
      `captions` - The captions
      `outputFile` - The output file
    Throws:
      `Exception` - On errors