dev.dejvokep.boostedyaml.dvs

Class Pattern

java.lang.Object

dev.dejvokep.boostedyaml.dvs.Pattern

public class Pattern
extends Object

Pattern which defines the format of version IDs.

Each pattern is composed of segments, using whose elements IDs can be parsed. Learn more about version IDs, segments and patterns on the wiki.

Patterns are immutable - it is recommended to create individual objects only once and reuse them.

Constructor Summary

Constructors

Constructor and Description
Pattern(Segment... segments) Creates a pattern composed of the given segments, ordered from the most significant to the least significant (left to right).

Method Summary

Modifier and Type	Method and Description
Version	getFirstVersion() Builds and returns the first version specified by this pattern, being the version with all cursors set to 0.
Segment	getPart(int index) Deprecated. Method with confusing name, use getSegment(int) instead. Subject for removal.
Segment	getSegment(int index) Returns segment at the given index (index 0 refers to 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)

Creates a pattern composed of the given segments, ordered from the most significant to the least significant (left to right).

To avoid any parsing conflicts, make sure that no neighboring segments are overlapping. Here are the two common solutions to that:

1. Reserve a character/sequence (e.g. ".") and create it's own segment: Segment.literal("."). Make sure the reserved sequence does not appear anywhere else. Then, separate each changing segment (range with 2+ numbers, literal segment with 2+ elements) with this segment, for example:
   new Pattern(Segment.range(0, Integer.MAX_VALUE), Segment.literal("."), Segment.range(0, 10))
   This way you will still be able to maintain great version ID semantics: 1.0 -> 1.1...
2. Ensure all elements within all segments are of the same length in characters. For range segments, you can use filling.

Parameters:

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

Method Detail

getPart

@Deprecated
 @NotNull
public Segment getPart(int index)

Deprecated. Method with confusing name, use getSegment(int) instead. Subject for removal.

getSegment

@NotNull
public Segment getSegment(int index)

Returns segment at the given index (index 0 refers to the most significant one on the left).

Parameters:

index - the index

Returns:

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 to parse

Returns:

the version, or null if cannot parse

getFirstVersion

public Version getFirstVersion()

Builds and returns the first version specified by this pattern, being the version with all cursors set to 0.

Returns:

the first version

toString

public String toString()

Overrides:

toString in class Object