Package space.arim.dazzleconf

Interface ConfigurationDefinition.ReadWithUpdateOptions

All Superinterfaces:

ConfigurationDefinition.ReadOptions, ConfigurationDefinition.WriteOptions, UpdateListener

Enclosing interface:

ConfigurationDefinition<C>

public static interface ConfigurationDefinition.ReadWithUpdateOptions
extends ConfigurationDefinition.ReadOptions, ConfigurationDefinition.WriteOptions

Parameters for reading a configuration and updating it in-place

Method Summary

Modifier and Type	Method	Description
default boolean	writeEntryComments(@NonNull CommentLocation location)	Controls whether comments on existing data entries are refreshed.

Methods inherited from interface space.arim.dazzleconf.ConfigurationDefinition.ReadOptions

keyMapper, keyPath, maximumErrorCollect

Methods inherited from interface space.arim.dazzleconf.ConfigurationDefinition.WriteOptions

keyMapper

Methods inherited from interface space.arim.dazzleconf.engine.UpdateListener

notifyUpdate

Method Details

writeEntryComments

@API(status=EXPERIMENTAL)
default boolean writeEntryComments(@NonNull CommentLocation location)

Controls whether comments on existing data entries are refreshed.

Newly-added entries (due to missing values) will always have comments set. This setting controls whether existing entries in the data tree will have their comments refreshed at the given location: i.e., by setting the comments anew on the entry.

This function can be used, for example, to continually write comments on entries, if the backend supports writing but not reading comments. Use Backend.Meta.supportsComments(boolean, boolean, CommentLocation) to check the extent of backend support.

Specified by:

writeEntryComments in interface ConfigurationDefinition.WriteOptions

Parameters:

location - the location of comments with respect to the entry

Returns:

whether refreshing should take place for entry comments there