dev.dejvokep.boostedyaml.dvs.segment

Class RangeSegment

java.lang.Object

dev.dejvokep.boostedyaml.dvs.segment.RangeSegment

All Implemented Interfaces:

Segment

public class RangeSegment
extends Object
implements Segment

Represents an immutable segment constructed from an integer range.

Constructor Summary

Constructors

Constructor and Description
RangeSegment(int start, int end) Deprecated. Duplicated internal method subject for removal.
RangeSegment(int start, int end, int step) Deprecated. Duplicated internal method subject for removal.
RangeSegment(int start, int end, int step, int fill) Creates a segment from the given range properties.

Method Summary

Modifier and Type	Method and Description
String	getElement(int index) Returns i-th element in the segment's definition (the first element having index 0).
int	getElementLength(int index) Returns length (in characters) of the i-th element in the segment's definition (the first element having index 0).
int	length() Returns the length of the segment - amount of elements in the segment's definition.
int	parse(String versionId, int index) Parses the given version ID, starting from the provided index and returns the index of element that was matched.
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.segment.Segment

literal, range, range, range

Constructor Detail

RangeSegment

public RangeSegment(int start,
                    int end,
                    int step,
                    int fill)

Creates a segment from the given range properties.

The range is defined by start (inclusive) and end (exclusive) boundaries and difference between each integer 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 integer in the range be. If an integer in the range has fewer digits than defined by the parameter, additional zeros (0) are prepended to fulfill the requirement (5 -> 005 for fill=3). Set to non-positive (<= 0) value 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, which implies the same for start, but not necessarily for end (which may be negative),
• if fill > 0, each integer in the range must have at most fill digits (e.g. no 3 digit integer for fill=2); mathematical notation: 0 <= each range integer <= 10fill - 1.

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

Parameters:

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

end - ending boundary (exclusive) of the range

step - difference between each neighboring elements in the range (value needed to add to get from element i to i+1)

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

RangeSegment

@Deprecated
public RangeSegment(int start,
                                 int end)

Deprecated. Duplicated internal method subject for removal.

RangeSegment

@Deprecated
public RangeSegment(int start,
                                 int end,
                                 int step)

Deprecated. Duplicated internal method subject for removal.

Method Detail

parse

public int parse(String versionId,
                 int index)

Description copied from interface: Segment

Parses the given version ID, starting from the provided index and returns the index of element that 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 is matched, returns -1. This might be the case if the ID is malformed, or if the individual segments overlap each other.

Specified by:

parse in interface Segment

Parameters:

versionId - the version ID to parse

index - starting index from which to parse the ID

Returns:

index of the first matched element (which appears at the provided index of the version ID)

getElement

public String getElement(int index)

Description copied from interface: Segment

Returns i-th element in the segment's definition (the first element having index 0).

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

Specified by:

getElement in interface Segment

Parameters:

index - the index

Returns:

the element at that index

getElementLength

public int getElementLength(int index)

Description copied from interface: Segment

Returns length (in characters) of the i-th element in the segment's definition (the first element having index 0).

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

Specified by:

getElementLength in interface Segment

Parameters:

index - the index

Returns:

the length of the element at the given index

length

public int length()

Description copied from interface: Segment

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

Specified by:

length in interface Segment

Returns:

the length of the segment

toString

public String toString()

Overrides:

toString in class Object