Package space.arim.dazzleconf

Interface ConfigurationDefinition.WriteOptions

All Known Subinterfaces:
ConfigurationDefinition.ReadWithUpdateOptions, SerializeContext, SerializeOutput
Enclosing interface:
ConfigurationDefinition<C>
public static interface ConfigurationDefinition.WriteOptions
Parameters for writing a configuration to a tree

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull KeyMapper
    keyMapper()
    The key mapper to use
    default boolean
    writeEntryComments(@NonNull CommentLocation location)
    Controls whether comments are written to data entries.

  • Method Details

    • keyMapper

      @NonNull KeyMapper keyMapper()
      The key mapper to use
      Returns:
      the key mapper

    • writeEntryComments

      @API(status=EXPERIMENTAL) default boolean writeEntryComments(@NonNull CommentLocation location)
      Controls whether comments are written to data entries.

      If enabled (the default), comment data is copied from the configuration definition to entries in the output data tree. If disabled, written DataEntrys will be without comments.

      Backend support

      Note that even if this function returns true, the backend is not guaranteed to support writing comments. Please consult the documentation of the Backend regarding comment support.

      Parameters:
      location - the location of the entry comments being written
      Returns:
      whether data entries should be written with comments here, default true