ecommons.waltable/org.eclipse.statet.ecommons.waltable.core/src/org/eclipse/statet/ecommons/waltable/coordinate/LRange.java

/*=============================================================================#
 # Copyright (c) 2012, 2021 Original NatTable authors and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0
 # 
 # Contributors:
 #     Original NatTable authors and others - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.ecommons.waltable.coordinate;

import java.util.ArrayList;
import java.util.List;


/**
 * Represents an LRange of numbers.
 * Example a LRange of selected rows: 1 - 100
 * Ranges are inclusive of their start value and not inclusive of their end value, i.e. start <= x < end
 */
public final class LRange implements Comparable<LRange> {
	
	
	public long start;
	public long end;
	
	
	/**
	 * Creates a new range with the specified start and end values.
	 */
	public LRange(final long start, final long end) {
		this.start= start;
		this.end= end;
	}
	
	/**
	 * Creates a new range which contains the specified single value.
	 */
	public LRange(final long value) {
		this.start= value;
		this.end= value + 1;
	}
	
	
	public long size() {
		return this.end - this.start;
	}
	
	
	@Override
	public int compareTo(final LRange o) {
		if (this.start < o.start) {
			return -1;
		}
		if (this.start > o.start) {
			return 1;
		}
		if (this.end < o.end) {
			return -1;
		}
		if (this.end > o.end) {
			return 1;
		}
		return 0;
	}
	
	/**
	 * @return <code>true</code> if the range contains the given row position
	 */
	public boolean contains(final long position) {
		return ((position >= this.start) && (position < this.end));
	}

	public boolean overlap(final LRange lRange) {
		return ((this.start < this.end) &&  // this is a non-empty range
				(lRange.start < lRange.end) &&  // range parameter is non-empty
				(contains(lRange.start) || contains(lRange.end - 1) || lRange.contains(this.start) || lRange.contains(this.end - 1)) );
	}

	public List<Long> getMembers() {
		final long l= size();
		if (l > Integer.MAX_VALUE) {
			throw new RuntimeException("too long: " + l);
		}
		final List<Long> members= new ArrayList<>((int) l);
		for (long i= this.start; i < this.end; i++) {
			members.add(Long.valueOf(i));
		}
		return members;
	}


	@Override
	public int hashCode() {
		int h= (int) (this.start ^ (this.start >>> 32));
		h= Integer.rotateRight(h, 15);
		h ^= (int) (this.end ^ (this.end >>> 32));
		return h ^ (h >>> 7);
	}

	@Override
	public boolean equals(final Object obj) {
		if (this == obj) {
			return true;
		}
		if (!(obj instanceof LRange)) {
			return false;
		}
		final LRange other= (LRange) obj;
		return ((this.start == other.start) && (this.end == other.end));
	}
	
	@Override
	public String toString() {
		return "LRange {" + this.start + ", " + this.end + "}"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	}
	
}