Class RangeLocation

  • All Implemented Interfaces:
    java.io.Serializable, Location
    Direct Known Subclasses:
    MergeLocation

    public class RangeLocation
    extends AbstractRangeLocation
    implements java.io.Serializable
    A simple implementation of Location that contains all points between getMin and getMax inclusive.

    This will in practice be the most commonly used pure-java implementation.

    Author:
    Matthew Pocock
    See Also:
    Serialized Form
    • Constructor Detail

      • RangeLocation

        public RangeLocation​(int min,
                             int max)
                      throws java.lang.IndexOutOfBoundsException
        Construct a new RangeLocation from min to max.
        Throws:
        java.lang.IndexOutOfBoundsException
    • Method Detail

      • getMin

        public int getMin()
        Description copied from interface: Location
        The minimum position contained.

        WARNING: The location will not contain every point between getMin() and getMax() if isContiguous() is false. If isContiguous() does return false you should use the Iterator returned by blockIterator() to iterate over the minimum set of contiguous blocks that make up this Location

        Specified by:
        getMin in interface Location
        Returns:
        the minimum position contained
      • getMax

        public int getMax()
        Description copied from interface: Location
        The maximum position contained.

        WARNING: The location will not contain every point between getMin() and getMax() if isContiguous() is false. If isContiguous() does return false you should use the Iterator returned by blockIterator() to iterate over the minimum set of contiguous blocks that make up this Location

        Specified by:
        getMax in interface Location
        Returns:
        the maximum position contained
      • translate

        public Location translate​(int dist)
        Description copied from interface: Location
        Create a location that is a translation of this location.
        Specified by:
        translate in interface Location
        Parameters:
        dist - the distance to translate (to the right)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object