com.cedarsoftware.ncube

Class Range

java.lang.Object

com.cedarsoftware.ncube.Range

All Implemented Interfaces:

Comparable<Range>

public class Range
extends Object
implements Comparable<Range>

This class is used to represent a 'band' or 'range' of values (numeric, date, etc.)

Author:

John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
Range()
Range(Comparable low, Comparable high)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Range that)
boolean	equals(Object other)
Comparable	getHigh()
Comparable	getLow()
int	hashCode()
int	isWithin(Comparable value)
boolean	overlap(Range that)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Range

public Range()

Range

public Range(Comparable low,
             Comparable high)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Range that)

Specified by:

compareTo in interface Comparable<Range>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isWithin

public int isWithin(Comparable value)

Parameters:

value - to compare with Range to determine if the value is within the Range [low, high).

Returns:

-1 if the value is less than the range low point, 0 if the value is within the range, and 1 if the value is greater than or equal to the range high point.

overlap

public boolean overlap(Range that)

Returns:

boolean true if the line segments represented by these two ranges overlap. Assumption that the Range objects 'low' value is less than the 'high' value.

getLow

public Comparable getLow()

getHigh

public Comparable getHigh()