dev.dejvokep.boostedyaml.dvs.segment

Interface Segment

All Known Implementing Classes:

LiteralSegment, RangeSegment

public interface Segment

Represents a segment (= part) in definition of a Pattern.

Method Summary

Modifier and Type	Method and Description
String	getElement(int index) Returns i-th element in the segment's definition (1st element being represented by 0).
int	getElementLength(int index) Returns length (in characters) of the i-th element in the segment's definition (1st element being represented by 0).
int	length() The length of the segment - amount of elements in the segment's definition.
static Segment	literal(String... elements) Creates a segment with the given elements.
int	parse(String versionId, int index) Parses the given version ID from the given index and returns which element (represented by the index) was matched.
static Segment	range(int start, int end) Creates a segment from the given range.
static Segment	range(int start, int end, int step) Creates a segment from the given range.
static Segment	range(int start, int end, int step, int fill) Creates a segment from the given range.

Method Detail

range

static Segment range(int start,
                     int end,
                     int step,
                     int fill)

Creates a segment from the given range.

The range is defined by start (inclusive) and end (exclusive) boundaries and difference between each element called step. To get i-th element of the range, we can use this formula:

start + step*i

Filling defines how long (in digits) must each element (= integer) in the range be. If an element in the range has fewer digits than defined by the parameter, additional zeros (0) are appended in front of the number to fulfill the requirement. It must, however, be guaranteed that no number from the range has more digits than defined by the parameter. Set to non-positive (<= 0) integer to disable.

Please mind following:

• step must not be equal to 0,
• start cannot be equal to end,
• step must be specified accordingly to the boundaries, if start < end it must be positive (and vice-versa),
• all elements in the range must be >= 0, meaning the same for start, but not for end, which can be negative,
• if fill > 0, no element must in it's base representation have more digits than defined by the parameter.

If any of the conditions above is not met, an IllegalArgumentException is thrown.

Parameters:

start - starting boundary (inclusive) of the range, also the 1st element in the range

end - ending boundary (exclusive) of the range

step - difference between each 2 elements in the range (step needed to make to get from element i to i+1)

fill - filling parameter (or <= 0 to disable)

Returns:

the created segment

range

static Segment range(int start,
                     int end,
                     int step)

Creates a segment from the given range.

The range is defined by start (inclusive) and end (exclusive) boundaries and difference between each element called step. To get i-th element of the range, we can use this formula:

start + step*i

Filling is disabled.

Please mind following:

• step must not be equal to 0,
• start cannot be equal to end,
• step must be specified accordingly to the boundaries, if start < end it must be positive (and vice-versa),
• all elements in the range must be >= 0, meaning the same for start, but not for end, which can be negative.

If any of the conditions above is not met, an IllegalArgumentException is thrown.

Parameters:

start - starting boundary (inclusive) of the range, also the 1st element in the range

end - ending boundary (exclusive) of the range

step - difference between each 2 elements in the range (step needed to make to get from element i to i+1)

Returns:

the created segment

See Also:

range(int, int, int, int)

range

static Segment range(int start,
                     int end)

Creates a segment from the given range.

The range is defined by start (inclusive) and end (exclusive) boundaries. Step is equal to 1 if start < end, -1 otherwise. Filling is disabled.

Please mind following:

• start cannot be equal to end,
• all elements in the range must be >= 0, meaning the same for start, but not for end, which can be negative.

If any of the conditions above is not met, an IllegalArgumentException is thrown.

Parameters:

start - starting boundary (inclusive) of the range, also the 1st element in the range

end - ending boundary (exclusive) of the range

Returns:

the created segment

See Also:

range(int, int, int, int)

literal

static Segment literal(String... elements)

Creates a segment with the given elements.

Parameters:

elements - the elements

Returns:

the created segment

parse

int parse(String versionId,
          int index)

Parses the given version ID from the given index and returns which element (represented by the index) was matched.

For LiteralSegment, this is the first element to which String.startsWith(String) returns true. For RangeSegment, this is the shortest sequence of characters at the start which represent a number within this range.

If no element in the segment matches the start of the ID, returns -1. This might be the case if the ID is malformed, or if the individual parts overlapping each other.

Parameters:

versionId - the version ID to parse

index - the index in the ID from which to parse

Returns:

index of the first matched element at the start of the version ID

getElement

String getElement(int index)

Returns i-th element in the segment's definition (1st element being represented by 0).

It must apply that 0 <= i < length(), otherwise, an IndexOutOfBoundsException will be thrown.

Parameters:

index - the index

Returns:

the element at that index

getElementLength

int getElementLength(int index)

Returns length (in characters) of the i-th element in the segment's definition (1st element being represented by 0).

It must apply that 0 <= i < length(), otherwise, an IndexOutOfBoundsException will be thrown.

Parameters:

index - the index

Returns:

the length of the element at the given index

length

int length()

The length of the segment - amount of elements in the segment's definition.

Returns:

the length of the segment