Package space.arim.dazzleconf.backend

Interface Backend.Document

Enclosing interface:
Backend
public static interface Backend.Document
A document loaded from, or writable to, a backend.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull CommentData
    comments()
    The document-level comments.
    @NonNull DataTree
    data()
    The data itself, in the form of a navigable tree
    static @NonNull Backend.Document
    simple(@NonNull DataTree dataTree)
    Returns a document consisting of the following data, without commments

  • Method Details

    • comments

      @NonNull CommentData comments()
      The document-level comments.

      These comments exist at the top-level of the document, and they are not attached to any particular entry.

      Returns:
      the document-level comments, or CommentData.empty() for none

    • data

      @NonNull DataTree data()
      The data itself, in the form of a navigable tree
      Returns:
      the data

    • simple

      static @NonNull Backend.Document simple(@NonNull DataTree dataTree)
      Returns a document consisting of the following data, without commments
      Parameters:
      dataTree - the data
      Returns:
      a document containing the data