net.junaraki.annobase.util

Class Span

java.lang.Object

net.junaraki.annobase.util.Span

All Implemented Interfaces:

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

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

A generic span with a begin offset and an end one.

Author:

Jun Araki

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Span(int begin, int end) Public constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Span that) A span precedes another one if the former's beginning precedes the latter's, or the former's end precedes the latter's if the former's beginning is equal to the latter's.
boolean	coveredBy(Span that) Returns true if this span is covered by the given span completely.
boolean	covers(Span that) Returns true if this span covers the given span completely.
boolean	equals(java.lang.Object obj)
int	getBegin()
int	getEnd()
int	hashCode()
boolean	isEmpty()
boolean	overlap(Span that) Returns if this span overlaps the given span to some degree.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Span

public Span(int begin,
            int end)

Public constructor.

Parameters:

begin -

end -

Method Detail

isEmpty

public boolean isEmpty()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

covers

public boolean covers(Span that)

Returns true if this span covers the given span completely.

Parameters:

that -

Returns:

coveredBy

public boolean coveredBy(Span that)

Returns true if this span is covered by the given span completely.

Parameters:

that -

Returns:

overlap

public boolean overlap(Span that)

Returns if this span overlaps the given span to some degree.

Parameters:

that -

Returns:

compareTo

public int compareTo(Span that)

A span precedes another one if the former's beginning precedes the latter's, or the former's end precedes the latter's if the former's beginning is equal to the latter's.

Specified by:

compareTo in interface java.lang.Comparable<Span>

Parameters:

that -

getBegin

public int getBegin()

getEnd

public int getEnd()