dev.dejvokep.boostedyaml.dvs.versioning

Class ManualVersioning

java.lang.Object

dev.dejvokep.boostedyaml.dvs.versioning.ManualVersioning

All Implemented Interfaces:

Versioning

public class ManualVersioning
extends Object
implements Versioning

Represents manually supplied versioning information.

Constructor Summary

Constructors

Constructor and Description
ManualVersioning(Pattern pattern, String documentVersionId, String defaultsVersionId) Creates manually supplied versioning information.

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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.dejvokep.boostedyaml.dvs.versioning.Versioning

updateVersionID

Constructor Detail

ManualVersioning

public ManualVersioning(@NotNull
                        Pattern pattern,
                        @Nullable
                        String documentVersionId,
                        @NotNull
                        String defaultsVersionId)

Creates manually supplied versioning information.

The given IDs are parsed immediately using the pattern; then supplied by the appropriate method implementations.

If the version ID of the defaults is invalid, it is considered illegal and will throw a NullPointerException. For the document itself, if the version returned is null, the updater assigns getFirstVersion() to it.

Parameters:

pattern - the pattern

documentVersionId - the version ID of the document

defaultsVersionId - the version ID of the defaults

Method Detail

getDocumentVersion

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

Description copied from interface: Versioning

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 Versioning.getFirstVersion() to it.

Specified by:

getDocumentVersion in interface Versioning

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
public Version getFirstVersion()

Description copied from interface: Versioning

Returns the first version specified by the used pattern.

Specified by:

getFirstVersion in interface Versioning

Returns:

the first version

See Also:

Pattern.getFirstVersion()

toString

public String toString()

Overrides:

toString in class Object