dev.dejvokep.boostedyaml.dvs.versioning

Class AutomaticVersioning

java.lang.Object

dev.dejvokep.boostedyaml.dvs.versioning.AutomaticVersioning

All Implemented Interfaces:

Versioning

Direct Known Subclasses:

BasicVersioning

public class AutomaticVersioning
extends Object
implements Versioning

Represents automatically supplied versioning information.

Constructor Summary

Constructors

Constructor and Description
AutomaticVersioning(Pattern pattern, Route route) Creates automatically supplied versioning information.
AutomaticVersioning(Pattern pattern, String route) Creates automatically 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()
void	updateVersionID(Section updated, Section def) Sets version ID of the default section into the updated section content.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutomaticVersioning

public AutomaticVersioning(@NotNull
                           Pattern pattern,
                           @NotNull
                           Route route)

Creates automatically supplied versioning information.

The versions of the respective documents will be obtained and parsed at runtime. Please note that version ID of the defaults must be present and valid, otherwise, a NullPointerException will be thrown. For the document itself, if the version ID is missing or invalid, the updater assigns getFirstVersion() to it.

Parameters:

pattern - the pattern used to parse the IDs

route - the route at which the IDs are

AutomaticVersioning

public AutomaticVersioning(@NotNull
                           Pattern pattern,
                           @NotNull
                           String route)

Creates automatically supplied versioning information.

The versions of the respective documents will be obtained and parsed at runtime. Please note that version ID of the defaults must be present and valid, otherwise, a NullPointerException will be thrown. For the document itself, if the version ID is missing or invalid, the updater assigns getFirstVersion() to it.

Parameters:

pattern - the pattern used to parse the IDs

route - the route at which the IDs are

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()

updateVersionID

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

Description copied from interface: Versioning

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).

Specified by:

updateVersionID in interface Versioning

Parameters:

updated - the updated section

def - the default section equivalent

toString

public String toString()

Overrides:

toString in class Object