org.conqat.lib.commons.region

Class SimpleRegion

java.lang.Object

org.conqat.lib.commons.region.SimpleRegion

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SimpleRegion>

Direct Known Subclasses:

LineBasedRegion, OffsetBasedRegion, Region

public class SimpleRegion
extends java.lang.Object
implements java.lang.Comparable<SimpleRegion>, java.io.Serializable

A simple region with only start and end. If you also need a description string (origin), use Region. Both start and end positions are inclusive.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	END_PROPERTY The name of the JSON property name for end.
static java.util.Comparator<SimpleRegion>	START_AND_END_COMPARATOR Compares SimpleRegions first by their start and then by their end.
protected static java.lang.String	START_PROPERTY The name of the JSON property name for start.

Constructor Summary

Constructors

Constructor and Description
SimpleRegion(int start, int end) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	adjacent(SimpleRegion r) Checks if two regions are adjacent
int	compareTo(SimpleRegion other) Compares regions by their start position
boolean	containsPosition(int position) Checks if the region contains a position
boolean	equals(java.lang.Object other)
boolean	equalsStartEnd(SimpleRegion other) Returns whether start and end of the region is the same as for this region.
int	getEnd() Gets the end position of the region.
int	getLength() Gets the length of the region.
int	getStart() Gets the start position of the region
int	hashCode()
boolean	isEmpty() Returns whether this region is empty.
boolean	overlaps(SimpleRegion r) Checks if two regions are overlapping
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

START_PROPERTY

protected static final java.lang.String START_PROPERTY

The name of the JSON property name for start.

See Also:

Constant Field Values

END_PROPERTY

protected static final java.lang.String END_PROPERTY

The name of the JSON property name for end.

See Also:

Constant Field Values

START_AND_END_COMPARATOR

public static final java.util.Comparator<SimpleRegion> START_AND_END_COMPARATOR

Compares SimpleRegions first by their start and then by their end.

Constructor Detail

SimpleRegion

public SimpleRegion(int start,
                    int end)

Constructor.

Method Detail

containsPosition

public boolean containsPosition(int position)

Checks if the region contains a position

overlaps

public boolean overlaps(SimpleRegion r)

Checks if two regions are overlapping

adjacent

public boolean adjacent(SimpleRegion r)

Checks if two regions are adjacent

getEnd

public int getEnd()

Gets the end position of the region. This may be less than start for an empty region (see also isEmpty()).

getStart

public int getStart()

Gets the start position of the region

getLength

public int getLength()

Gets the length of the region. Empty regions have a length of 0.

isEmpty

public boolean isEmpty()

Returns whether this region is empty.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(SimpleRegion other)

Compares regions by their start position

Specified by:

compareTo in interface java.lang.Comparable<SimpleRegion>

equalsStartEnd

public boolean equalsStartEnd(SimpleRegion other)

Returns whether start and end of the region is the same as for this region.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object