pl.netanel.swt.matrix

Interface NumberSet<N extends java.lang.Number>

public interface NumberSet<N extends java.lang.Number>

Set of number extents that don't overlap. They don't have to be sorted.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NumberSet.Query<N extends java.lang.Number> Specifies options for iteration over extent set.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Extent<N> extent) Adds the given extent of numbers to the set.
boolean	add(N number) Adds the given number to the set.
boolean	add(N start, N end) Adds an extent of numbers between start end end to the set.
boolean	addAll(NumberSet<N> set) Adds the content of the given set to this set.
void	clear() Removes all of the numbers from this set.
boolean	contains(Extent<N> extent) Returns true if this set contains all the numbers from the given range inclusively.
boolean	contains(N number) Returns true if this set contains the given number.
boolean	contains(N start, N end) Returns true if this set contains all the numbers from the given range inclusively.
NumberSet<N>	copy() Returns a copy of this set.
void	delete(Extent<N> extent) Removes a range of numbers decreasing the following numbers by the amount of the removed items.
void	delete(N number) Removes a range of numbers decreasing the following numbers by 1.
void	delete(N start, N end) Removes a range of numbers decreasing the following numbers by the amount of the removed items.
java.util.Iterator<Extent<N>>	extentIterator(NumberSet.Query<N> query) Returns an extent iterator according to the given query.
N	getCount() Returns the number of items in the receiver.
N	getCount(N start, N end) Returns the number of items in the receiver between the values start and end inclusively.
NumberSet<N>	getUnchecked() Returns a better performing but less user friendly implementation for this number set that is more loop efficient: does not check validity of the method arguments does not mark the layout as required computing on every method call, instead relying on the client to call Matrix.refresh()
void	insert(N target, N count) Inserts numbers before the given target number increasing the following numbers by the amount of the inserted numbers.
boolean	isEmpty() Returns true if the receiver contains no items.
java.util.Iterator<N>	numberIterator(NumberSet.Query<N> query) Returns an number iterator according to the given query.
boolean	remove(Extent<N> extent) Removes the given extent of numbers from this set.
boolean	remove(N number) Removes the given number from this set.
boolean	remove(N start, N end) Removes an extent of numbers between start end end from this set.
boolean	removeAll(NumberSet<N> set) Removes the content of the given set from this set.

Method Detail

isEmpty

boolean isEmpty()

Returns true if the receiver contains no items. Otherwise false is returned.

Returns:

true if this contains contains no items

getCount

N getCount()

Returns the number of items in the receiver.

Returns:

the number of items in the receiver

getCount

N getCount(N start,
         N end)

Returns the number of items in the receiver between the values start and end inclusively.

Returns:

the number of items in the receiver between the values start and end

add

boolean add(N start,
          N end)

Adds an extent of numbers between start end end to the set. Adding extents performs better then adding single numbers.

Parameters:

start - first index of the range of items

end - last index of the range of items

Returns:

true if this operation has changed the set content.

add

boolean add(N number)

Adds the given number to the set.

Parameters:

number - to be added

Returns:

true if this operation has changed the set content.

add

boolean add(Extent<N> extent)

Adds the given extent of numbers to the set. Adding extents performs better then adding single numbers.

Parameters:

start - first index of the range of items

end - last index of the range of items

Returns:

true if this operation has changed the set content.

addAll

boolean addAll(NumberSet<N> set)

Adds the content of the given set to this set.

Parameters:

set - to be added

Returns:

true if this operation has changed the set content.

remove

boolean remove(N start,
             N end)

Removes an extent of numbers between start end end from this set. Removing extents performs better then adding single numbers.

Parameters:

start - first index of the range of items

end - last index of the range of items

Returns:

true if this operation has changed the set content.

remove

boolean remove(N number)

Removes the given number from this set.

Parameters:

number - to remove.

Returns:

true if this operation has changed the set content.

remove

boolean remove(Extent<N> extent)

Removes the given extent of numbers from this set. Removing extents performs better then adding single numbers.

Parameters:

start - first index of the range of items

end - last index of the range of items

Returns:

true if this operation has changed the set content.

removeAll

boolean removeAll(NumberSet<N> set)

Removes the content of the given set from this set.

Parameters:

set - to remove

Returns:

true if this operation has changed the set content.

insert

void insert(N target,
          N count)

Inserts numbers before the given target number increasing the following numbers by the amount of the inserted numbers.

Numbers are inserted before the given target number or at the end if the target equals to the (last number in the set) + 1.

Parameters:

target - the number before which the new numbers are inserted

count - the number of items to insert

Throws:

java.lang.IndexOutOfBoundsException - if target or count is null

java.lang.IndexOutOfBoundsException - if target is out of 0 ... getCount() bounds

java.lang.IllegalArgumentException - if start is greater then end

delete

void delete(N start,
          N end)

Removes a range of numbers decreasing the following numbers by the amount of the removed items.

Parameters:

start - first index of the range of items

end - last index of the range of items

Throws:

java.lang.IndexOutOfBoundsException - if start or end is null

java.lang.IndexOutOfBoundsException - if start or end is negative

java.lang.IllegalArgumentException - if start is greater then end

delete

void delete(N number)

Removes a range of numbers decreasing the following numbers by 1.

Parameters:

number - number to be deleted

Throws:

java.lang.IndexOutOfBoundsException - if number is null

java.lang.IndexOutOfBoundsException - if number is negative

java.lang.IllegalArgumentException - if start is greater then end

delete

void delete(Extent<N> extent)

Removes a range of numbers decreasing the following numbers by the amount of the removed items.

Parameters:

extent - first index of the range of items to remove

Throws:

java.lang.IndexOutOfBoundsException - if extent is null

clear

void clear()

Removes all of the numbers from this set. The set will be empty after this call returns.

contains

boolean contains(N number)

Returns true if this set contains the given number.

Parameters:

number - number whose presence in this set is to be tested

Returns:

true if this set contains the given number

contains

boolean contains(N start,
               N end)

Returns true if this set contains all the numbers from the given range inclusively.

Parameters:

start - first index of the range of items

end - last index of the range of items

Returns:

true if this set contains the given range of numbers

contains

boolean contains(Extent<N> extent)

Returns true if this set contains all the numbers from the given range inclusively.

Parameters:

extent - extent of numbers whose presence in this set is to be tested

Returns:

true if this set contains the given range of numbers

extentIterator

java.util.Iterator<Extent<N>> extentIterator(NumberSet.Query<N> query)

Returns an extent iterator according to the given query.

Parameters:

query - parameters changing the default iteration which is forward over all items. See NumberSet.Query. null value means the default query.

Returns:

extent iterator according to the given query

numberIterator

java.util.Iterator<N> numberIterator(NumberSet.Query<N> query)

Returns an number iterator according to the given query.

Parameters:

query - parameters changing the default iteration which is forward over all items. See NumberSet.Query. null value means the default query.

Returns:

number iterator according to the given query

copy

NumberSet<N> copy()

Returns a copy of this set.

Returns:

copy of this set

getUnchecked

NumberSet<N> getUnchecked()

Returns a better performing but less user friendly implementation for this number set that is more loop efficient:

• does not check validity of the method arguments
• does not mark the layout as required computing on every method call, instead relying on the client to call Matrix.refresh()

Returns:

a better performing but less user friendly implementation for this set