dev.dejvokep.boostedyaml.dvs

Class Pattern

java.lang.Object

dev.dejvokep.boostedyaml.dvs.Pattern

public class Pattern
extends Object

Represents an immutable pattern using which version IDs can be parsed into versions.

Constructor Summary

Constructors

Constructor and Description
Pattern(Segment... segments) Initializes the pattern with the given segments.

Method Summary

Modifier and Type	Method and Description
Version	getFirstVersion() Builds and returns the first version specified by this pattern.
Segment	getPart(int index) Returns segment at the given index (from the most significant one on the left).
Version	getVersion(String versionId) Parses the given version ID.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Pattern

public Pattern(@NotNull
               Segment... segments)

Initializes the pattern with the given segments.

The given segments should be ordered from the most significant to the least significant (left to right). Please make sure that no segments are overlapping. There are 2 common solutions to that:

1. RECOMMENDED: Reserve a character (e.g. '.') and create a static segment with it. Define the pattern so each segment is differentiated from another with this static segment and make sure no segment contains the reserved character in any of its elements. This way you can prevent overlapping and simultaneously keep standard version specification (e.g. 1.2). Same applies if you would like to use character sequence instead of only one character.
2. Ensure all elements within all segments are of the same length in characters. For range segments, you can use filling.

Please note that patterns and segments are immutable, and therefore, you can reuse them.

For more information please visit the wiki.

Parameters:

segments - the segments, ordered from left (most-significant) to right (least-significant)

Method Detail

getPart

@NotNull
public Segment getPart(int index)

Returns segment at the given index (from the most significant one on the left).

Parameters:

index - the index

Returns:

the segment at the given index

getVersion

@Nullable
public Version getVersion(@NotNull
                                     String versionId)

Parses the given version ID. If the ID does not match this pattern, returns null.

Parameters:

versionId - the version ID

Returns:

the version

getFirstVersion

public Version getFirstVersion()

Builds and returns the first version specified by this pattern.

More formally, returns version represented by all cursors set to the lowest index - 0.

Returns:

the first version

toString

public String toString()

Overrides:

toString in class Object