org.conqat.lib.commons.region

Class Region

java.lang.Object

org.conqat.lib.commons.region.SimpleRegion

org.conqat.lib.commons.region.Region

All Implemented Interfaces:

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

public final class Region
extends SimpleRegion

Regions represent intervals. Both the start and the end position are considered to be part of the region. Regions can i.e. be used to represent fragments of files.

This class is immutable.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNKNOWN_ORIGIN Name that is used if region is created without name

Fields inherited from class org.conqat.lib.commons.region.SimpleRegion

END_PROPERTY, START_AND_END_COMPARATOR, START_PROPERTY

Constructor Summary

Constructors

Constructor and Description
Region(int start, int end) Creates a region with an unknown origin
Region(int start, int end, java.lang.String origin) Creates a region with an origin.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOrigin() Get origin.

Methods inherited from class org.conqat.lib.commons.region.SimpleRegion

adjacent, compareTo, containsPosition, equals, equalsStartEnd, getEnd, getLength, getStart, hashCode, isEmpty, overlaps, toString

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_ORIGIN

public static final java.lang.String UNKNOWN_ORIGIN

Name that is used if region is created without name

See Also:

Constant Field Values

Constructor Detail

Region

public Region(int start,
              int end,
              java.lang.String origin)

Creates a region with an origin. An empty region can be denoted with and end position smaller than start.

Parameters:

start - Inclusive start position of the region

end - Inclusive end position of the region

origin - Region origin. (i.e. region producer)

Region

public Region(int start,
              int end)

Creates a region with an unknown origin

Parameters:

start - Inclusive start position of the region

end - Inclusive end position of the region

Method Detail

getOrigin

public java.lang.String getOrigin()

Get origin.