net.jxta.impl.document
Class LiteXMLElement.charRange

java.lang.Object
  net.jxta.impl.document.LiteXMLElement.charRange

All Implemented Interfaces:

Comparable

Enclosing class:

LiteXMLElement

protected static class LiteXMLElement.charRange
extends Object
implements Comparable

Defines a range of characters, probably within a string. The range is deemed to be invalid if 'start' is -1. A zero length range is, by convention, described by an 'end' value of 'start' - 1.

start

public int start

Contains the start position of this range.

end

public int end

Contains the end position of this range. one weird thing: if end == start -1, then the item is of zero length begining at start.

LiteXMLElement.charRange

public LiteXMLElement.charRange()

Constructor for a null charRange.

LiteXMLElement.charRange

public LiteXMLElement.charRange(int start,
                                int end)

Constructor for which the bounds are specified.

equals

public boolean equals(Object aRange)

Overrides:

equals in class Object

compareTo

public int compareTo(Object aRange)

Specified by:

compareTo in interface Comparable

toString

public String toString()

Overrides:

toString in class Object

contains

public boolean contains(LiteXMLElement.charRange someRange)

Returns true if the charRange specified by someRange is contained within this range.

Parameters:

someRange - The range which must be contained within this range.

Returns:

true if the specified range is contained with this range otherwise false.

contains

public boolean contains(LiteXMLElement.tagRange someRange)

Returns true if the tagRange specified by someRange is contained within this range.

Parameters:

someRange - The range which must be contained within this range.

Returns:

true if the specified range is contained with this range otherwise false.

contains

public boolean contains(int someLoc)

Returns true if the location specified is contained in this range.

Parameters:

someLoc - the location which is to be tested.

Returns:

true if the location is in this range, otherwise false.

isValid

public boolean isValid()

Returns true if the range is both non-null and has a length of greater than or equal to zero.

Returns:

true if the range is a valid one, otherwise false.

length

public int length()

Returns the length of this range.

Returns:

The length of the range or -1 if the range is null.