Package space.arim.dazzleconf.engine

Interface SerializeContext

All Superinterfaces:

ConfigurationDefinition.WriteOptions

All Known Subinterfaces:

SerializeOutput

public interface SerializeContext
extends ConfigurationDefinition.WriteOptions

A context for serialization.

Method Summary

Modifier and Type	Method	Description
@NonNull KeyMapper	keyMapper()	Gets the key mapper being used
boolean	writeEntryComments(@NonNull CommentLocation location)	Checks whether comments are being written on entries, and if so, where.

Method Details

keyMapper

@NonNull KeyMapper keyMapper()

Gets the key mapper being used

Specified by:

keyMapper in interface ConfigurationDefinition.WriteOptions

Returns:

the key mapper

writeEntryComments

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

Checks whether comments are being written on entries, and if so, where.

This method helps the serializer decide to attach comments to entries in written data trees. The result of this method is a hint, and it does not have to be followed.

This function is analogous to ConfigurationDefinition.WriteOptions.writeEntryComments(CommentLocation). However, this function may not necessarily call that one (responses may be cached, or other settings might influence behavior).

Specified by:

writeEntryComments in interface ConfigurationDefinition.WriteOptions

Parameters:

location - the location of the entry comments in question

Returns:

whether comments at this location are being written