io.scif.img

Class Range

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Long>

io.scif.img.Range

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Long>, Collection<Long>, List<Long>, RandomAccess

public class Range
extends ArrayList<Long>

A list of Long values with extra convenience functionality. Values can be parsed from a properly formatted string.

A head() and tail() convenience method are provided. Additionally, a hash index is maintained over all values, for faster contains(Object) performance.

Practically, ranges are ","-separated list of selected values. For each selection specified, a start value is mandatory. An (inclusive) end value can be specified using a "-". If an end is specified, a step can also be provided using a ":". So, 5,6-10:2 would select planes 5, 6, 8 and 10 from the dimension associated with this Range.

Ranges must match the pattern: \d*(-\d*(:\d*)?)?(,\d*(-\d*(:\d)?*)?)* Valid patterns:

• 5,10,15
• 5-10,7,10-25:3
• 1-100:1,1-50:2,15-20

NB: index order is preserved, so if indices are provided out of order, they will remain out of order.

Author:

Mark Hiner

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
Range(Long index) Creates a singleton DimRange.
Range(long[] values) Constructs a DimRange that includes only the values contained in the provided array.
Range(Long start, Long end) Creates the DimRange: [start, end]
Range(String range)

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object l)
Long	head()
Long	tail()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

Range

public Range(String range)

Range

public Range(Long index)

Creates a singleton DimRange.

Parameters:

index - single index for this DimRange.

Range

public Range(Long start,
             Long end)

Creates the DimRange: [start, end]

Parameters:

start - inclusive start value

end - inclusive end value

Range

public Range(long[] values)

Constructs a DimRange that includes only the values contained in the provided array.

Parameters:

values - explicit list of values in this range

Method Detail

contains

public boolean contains(Object l)

Specified by:

contains in interface Collection<Long>

Specified by:

contains in interface List<Long>

Overrides:

contains in class ArrayList<Long>

head

public Long head()

Returns:

The first value in this range.

tail

public Long tail()

Returns:

The last value in this range.