com.davidbracewell.hermes

Class Span

java.lang.Object

com.davidbracewell.hermes.Span

All Implemented Interfaces:

Serializable, Comparable<Span>

Direct Known Subclasses:

HString

public class Span
extends Object
implements Serializable, Comparable<Span>

Represents a starting (inclusive) and ending (exclusive) portion of a CharSequence.

Author:

David B. Bracewell

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Span(int start, int end) Instantiates a new Span.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Span o)
boolean	encloses(Span other) Returns true if the bounds of the other text do not extend outside the bounds of this text.
int	end() The ending offset
boolean	equals(Object other)
int	hashCode()
boolean	isEmpty() Checks if the span is empty (start == end)
int	length() The length of the span
boolean	overlaps(Span other) Returns true if the bounds of other text are connected with the bounds of this text.
int	start() The starting offset
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Span

public Span(int start,
            int end)

Instantiates a new Span.

Parameters:

start - the start

end - the end

Method Detail

start

public int start()

The starting offset

Returns:

The start offset (inclusive).

end

public int end()

The ending offset

Returns:

The ending offset (exclusive).

length

public int length()

The length of the span

Returns:

The length of the span

isEmpty

public boolean isEmpty()

Checks if the span is empty (start == end)

Returns:

True if the span is empty, False if not

overlaps

public boolean overlaps(Span other)

Returns true if the bounds of other text are connected with the bounds of this text.

Parameters:

other - The other text to check if this one overlaps

Returns:

True if the two texts are in the same document and overlap, False otherwise

encloses

public boolean encloses(Span other)

Returns true if the bounds of the other text do not extend outside the bounds of this text.

Parameters:

other - The other text to check if this one encloses

Returns:

True if the two texts are in the same document and this text encloses the other, False otherwise

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

compareTo

public int compareTo(Span o)

Specified by:

compareTo in interface Comparable<Span>