the factory for ranges, it is used for custom ranges type. For example IntRange is more convenient than ClosedRange<BoundType> for equality checks outside the interface or class.

step

override val step: LengthType

the minimal non-zero length of a subrange and distance between two neighbour subranges. Usually it has a value of 1 for integer types of BoundType.

Functions

getColor

open override fun getColor(bound: BoundType): RedGreenColor

Looks for a subrange containing bound and returns its color.

getGreenSubrange

@JvmOverloads

fun getGreenSubrange(maxLength: LengthType = step, limitByRange: ClosedRange<BoundType> = range): ClosedRange<BoundType>?

Requests subrange of RedGreenColor.Green color, see TwoColoredRange.getSubrangeOfColor for details.

getGreenSubranges

fun getGreenSubranges(): List<ClosedRange<BoundType>>

Returns subranges of RedGreenColor.Green color.

getRedSubrange

@JvmOverloads

fun getRedSubrange(maxLength: LengthType = step, limitByRange: ClosedRange<BoundType> = range): ClosedRange<BoundType>?

Requests subrange of RedGreenColor.Red color, see TwoColoredRange.getSubrangeOfColor for details.

getRedSubranges

fun getRedSubranges(): List<ClosedRange<BoundType>>

Returns subranges of RedGreenColor.Red color.

getSubrangeOfColor

open override fun getSubrangeOfColor(color: RedGreenColor): ClosedRange<BoundType>?

getSubrangeOfColor called with maxLength = step and limitByRange = range.

open override fun getSubrangeOfColor(color: RedGreenColor, maxLength: LengthType): ClosedRange<BoundType>?

getSubrangeOfColor called with limitByRange = range.

open override fun getSubrangeOfColor(color: RedGreenColor, limitByRange: ClosedRange<BoundType>): ClosedRange<BoundType>?

getSubrangeOfColor called with maxLength = step.

open override fun getSubrangeOfColor(color: RedGreenColor, maxLength: LengthType, limitByRange: ClosedRange<BoundType>): ClosedRange<BoundType>?

Performs a search for a subrange with color color limited by limitByRange. If a subrange with length >= maxLength was found then returns a subrange from foundSubrange.start to foundSubrange.start + maxLength (involving math and rangeFactory). Otherwise returns first non-empty subrange with color color inside limitByRange or null.

getSubrangesOfColor

open override fun getSubrangesOfColor(color: RedGreenColor): List<ClosedRange<BoundType>>

Returns list of subranges colored with color.

getSubrangesOfDefaultColor

open override fun getSubrangesOfDefaultColor(): List<ClosedRange<BoundType>>

Returns list of subranges colored with defaultColor.

getSubrangesOfOtherColor

open override fun getSubrangesOfOtherColor(): List<ClosedRange<BoundType>>

Returns list of subranges colored with otherColor.

iterator

open operator override fun iterator(): Iterator<Pair<ClosedRange<BoundType>, RedGreenColor>>

setSubrangeColor

open override fun setSubrangeColor(subrange: ClosedRange<BoundType>, color: RedGreenColor)

Paints subrange with color overriding any previous colors the subrange contained.

setSubrangeDefaultColor

open override fun setSubrangeDefaultColor(subrange: ClosedRange<BoundType>)

Paints subrange with defaultColor overriding any previous colors the subrange contained.

setSubrangeGreen

fun setSubrangeGreen(subrange: ClosedRange<BoundType>)

Paints subrange with RedGreenColor.Green color.

setSubrangeOtherColor

open override fun setSubrangeOtherColor(subrange: ClosedRange<BoundType>)

Paints subrange with otherColor overriding any previous colors the subrange contained.

setSubrangeRed

fun setSubrangeRed(subrange: ClosedRange<BoundType>)

Paints subrange with RedGreenColor.Red color.

subrangesIterator

open override fun subrangesIterator(limitByRange: ClosedRange<BoundType>): Iterator<Pair<ClosedRange<BoundType>, RedGreenColor>>

Iterator limited by limitByRange.