dev.dejvokep.boostedyaml.dvs.versioning

Interface Versioning

All Known Implementing Classes:

AutomaticVersioning, BasicVersioning, ManualVersioning

public interface Versioning

Represents versioning information supplier.

Method Summary

Modifier and Type	Method and Description
Version	getDocumentVersion(Section document, boolean defaults) Returns version of the given document (section).
Version	getFirstVersion() Returns the first version specified by the used pattern.
default void	updateVersionID(Section updated, Section def) Sets version ID of the default section into the updated section content.

Method Detail

getDocumentVersion

@Nullable
Version getDocumentVersion(@NotNull
                                      Section document,
                                      boolean defaults)

Returns version of the given document (section).

If obtaining version of the defaults (parameter is set to true), returning null is considered illegal and will throw a NullPointerException. Otherwise, for the document itself, if the version returned is null, the updater assigns getFirstVersion() to it.

Parameters:

document - the document

defaults - if getting version of the defaults

Returns:

the version corresponding to the document, or null if it could not be obtained/parsed

getFirstVersion

@NotNull
Version getFirstVersion()

Returns the first version specified by the used pattern.

Returns:

the first version

See Also:

Pattern.getFirstVersion()

updateVersionID

default void updateVersionID(@NotNull
                             Section updated,
                             @NotNull
                             Section def)

Sets version ID of the default section into the updated section content. Called only after successful update.

Should be used only if the underlying versioning implementation supports file manipulation (AutomaticVersioning).

Parameters:

updated - the updated section

def - the default section equivalent