com.ibm.bluej.util.common

Class Span

java.lang.Object

com.ibm.bluej.util.common.Span

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Span.LengthComparator

Field Summary

Fields

Modifier and Type	Field and Description
int	end
static java.lang.String	FORMAT
static char	INTERVAL_CLOSE_SYMBOL
static char	INTERVAL_OPEN_SYMBOL
static char	INTERVAL_SEP_SYMBOL
int	start

Constructor Summary

Constructors

Constructor and Description
Span(int first, int last)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOffset(int offset)
Span	clone()
int	compareTo(Span s)
static java.lang.String	compressSpace(java.lang.String source, java.util.Collection<Span> spans)
boolean	contains(int ndx)
boolean	contains(int otherStart, int otherEnd)
boolean	contains(Span s) true if this span contains (or is equal to) s
boolean	crosses(Span s) neither span contains the other, but they do overlap
int	distanceTo(Span s)
boolean	equals(java.lang.Object obj)
static int	firstStart(java.lang.Iterable<Span> spans)
boolean	fix(int minStart, int maxEnd)
static Span	fromString(java.lang.String str) creates a span from interval notation
int	hashCode()
static java.lang.String	highlight(java.lang.String source, Span span, java.lang.String begin, java.lang.String end)
static java.lang.String	highlightAll(java.lang.String source, java.util.List<Span> spans, FunST<Span,Pair<java.lang.String,java.lang.String>> beginEndMaker)
static java.lang.String	highlightAll(java.lang.String source, java.util.List<Span> spans, java.lang.String begin, java.lang.String end)
boolean	isValid(java.lang.String str)
static int	lastEnd(java.lang.Iterable<Span> spans)
int	length()
int	overlapLength(Span other)
double	overlapPercent(int otherStart, int otherEnd)
double	overlapPercent(Span other)
boolean	overlaps(int s, int e) true if the spans overlap at all
boolean	overlaps(Span s) true if the spans overlap at all
boolean	properContains(Span s)
static java.lang.String	replaceAll(java.lang.String source, java.util.Map<Span,java.lang.String> replacements)
java.lang.String	substring(java.lang.String text) returns the String indicated by the Span from text
java.lang.String	substringLimit(java.lang.String whole)
static int	sumLength(Span s1, Span s2)
java.lang.String	toString() the span in interval notation http://en.wikipedia.org/wiki/Interval_(mathematics)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

INTERVAL_OPEN_SYMBOL

public static final char INTERVAL_OPEN_SYMBOL

See Also:

Constant Field Values

INTERVAL_CLOSE_SYMBOL

public static final char INTERVAL_CLOSE_SYMBOL

See Also:

Constant Field Values

INTERVAL_SEP_SYMBOL

public static final char INTERVAL_SEP_SYMBOL

See Also:

Constant Field Values

FORMAT

public static final java.lang.String FORMAT

See Also:

Constant Field Values

start

public int start

end

public int end

Constructor Detail

Span

public Span(int first,
    int last)

Method Detail

substring

public java.lang.String substring(java.lang.String text)

returns the String indicated by the Span from text

Parameters:

text -

Returns:

substringLimit

public java.lang.String substringLimit(java.lang.String whole)

overlaps

public boolean overlaps(Span s)

true if the spans overlap at all

Parameters:

s -

Returns:

overlaps

public boolean overlaps(int s,
               int e)

true if the spans overlap at all

Parameters:

s -

Returns:

contains

public boolean contains(Span s)

true if this span contains (or is equal to) s

Parameters:

s -

Returns:

boolean

contains

public boolean contains(int ndx)

contains

public boolean contains(int otherStart,
               int otherEnd)

properContains

public boolean properContains(Span s)

crosses

public boolean crosses(Span s)

neither span contains the other, but they do overlap

Parameters:

s -

Returns:

toString

public java.lang.String toString()

the span in interval notation http://en.wikipedia.org/wiki/Interval_(mathematics)

Overrides:

toString in class java.lang.Object

fromString

public static Span fromString(java.lang.String str)

creates a span from interval notation

Parameters:

str -

Returns:

span

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

sumLength

public static int sumLength(Span s1,
            Span s2)

distanceTo

public int distanceTo(Span s)

fix

public boolean fix(int minStart,
          int maxEnd)

replaceAll

public static java.lang.String replaceAll(java.lang.String source,
                          java.util.Map<Span,java.lang.String> replacements)

addOffset

public void addOffset(int offset)

firstStart

public static int firstStart(java.lang.Iterable<Span> spans)

lastEnd

public static int lastEnd(java.lang.Iterable<Span> spans)

compressSpace

public static java.lang.String compressSpace(java.lang.String source,
                             java.util.Collection<Span> spans)

Parameters:

source -

spans -

Returns:

highlight

public static java.lang.String highlight(java.lang.String source,
                         Span span,
                         java.lang.String begin,
                         java.lang.String end)

highlightAll

public static java.lang.String highlightAll(java.lang.String source,
                            java.util.List<Span> spans,
                            java.lang.String begin,
                            java.lang.String end)

highlightAll

public static java.lang.String highlightAll(java.lang.String source,
                            java.util.List<Span> spans,
                            FunST<Span,Pair<java.lang.String,java.lang.String>> beginEndMaker)

isValid

public boolean isValid(java.lang.String str)

clone

public Span clone()

Overrides:

clone in class java.lang.Object

overlapLength

public int overlapLength(Span other)

overlapPercent

public double overlapPercent(int otherStart,
                    int otherEnd)

overlapPercent

public double overlapPercent(Span other)

length

public int length()

compareTo

public int compareTo(Span s)

Specified by:

compareTo in interface java.lang.Comparable<Span>