dev.dejvokep.boostedyaml.dvs.segment

Class LiteralSegment

java.lang.Object

dev.dejvokep.boostedyaml.dvs.segment.LiteralSegment

All Implemented Interfaces:

Segment

public class LiteralSegment
extends Object
implements Segment

Represents an immutable segment constructed directly from an array of elements.

Constructor Summary

Constructors

Constructor and Description
LiteralSegment(String... elements) Creates a segment with the given elements.

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

LiteralSegment

public LiteralSegment(String... elements)

Creates a segment with the given elements.

Parameters:

elements - the elements

Method Detail

parse

public int parse(String versionId,
                 int index)

Description copied from interface: Segment

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.

Specified by:

parse in interface Segment

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

public String getElement(int index)

Description copied from interface: Segment

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.

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 (1st element being represented by 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

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