Package eu.simuline.util

Enum TwoSidedList.Direction

java.lang.Object

java.lang.Enum<TwoSidedList.Direction>

eu.simuline.util.TwoSidedList.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TwoSidedList.Direction>

Enclosing class:

TwoSidedList<E>

public static enum TwoSidedList.Direction
extends java.lang.Enum<TwoSidedList.Direction>

Used as an argument for methods adding or removing elements from this list to determine in which direction this list has to shrink or grow.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Left2Right
Right2Left

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Direction()

Method Summary

Modifier and Type	Method	Description
(package private) abstract void	checkAdd1(TwoSidedList<?> list)	Checks in TwoSidedList.add(int, Object, Direction) whether by adding elements causes underrun in TwoSidedList.firstIndex() or overrun in TwoSidedList.minFreeIndex().
(package private) abstract void	checkAddAll(int size, TwoSidedList<?> list)	Checks in TwoSidedList.addAll(int, Collection, Direction) whether by adding elements causes underrun in TwoSidedList.firstIndex() or overrun in TwoSidedList.minFreeIndex().
(package private) abstract void	checkRange(int ind, TwoSidedList<?> list)	Checks whether index ind is in the range of list and throws an appropriate exception if not.
static TwoSidedList.Direction	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static TwoSidedList.Direction[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Left2Right

public static final TwoSidedList.Direction Left2Right

Right2Left

public static final TwoSidedList.Direction Right2Left

Constructor Detail

Direction

private Direction()

Method Detail

values

public static TwoSidedList.Direction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TwoSidedList.Direction c : TwoSidedList.Direction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TwoSidedList.Direction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

checkRange

abstract void checkRange(int ind,
                         TwoSidedList<?> list)

Checks whether index ind is in the range of list and throws an appropriate exception if not.

Parameters:

ind - the index to be checked.

list - the twosided list under consideration.

Throws:

java.lang.IndexOutOfBoundsException -

• for this == Left2Rightif not list.firstIndex() <= ind<list.minFreeIndex()+1.
• for this == Right2Leftif not list.firstIndex()-1 <= ind<list.minFreeIndex() .

The message is always the same: "Index: <ind> Range: <firstIndex> - <minFreeIndex()> exclusively. " .

See Also:

(int, Object, Direction), TwoSidedList.addAll(int, Collection, Direction)

checkAdd1

abstract void checkAdd1(TwoSidedList<?> list)

Checks in TwoSidedList.add(int, Object, Direction) whether by adding elements causes underrun in TwoSidedList.firstIndex() or overrun in TwoSidedList.minFreeIndex().

Parameters:

list - the twosided list under consideration.

Throws:

java.lang.IllegalStateException - if adding an object to this list would cause underrun in TwoSidedList.firstIndex() or overrun in TwoSidedList.minFreeIndex() depending on this direction.

See Also:

TwoSidedList.decFirstIndex(), TwoSidedList.checkIncMinFreeIndex()

checkAddAll

abstract void checkAddAll(int size,
                          TwoSidedList<?> list)

Checks in TwoSidedList.addAll(int, Collection, Direction) whether by adding elements causes underrun in TwoSidedList.firstIndex() or overrun in TwoSidedList.minFreeIndex().

Parameters:

size - the number of elements to be added.

list - the twosided list under consideration.

Throws:

java.lang.IllegalStateException - if adding size objects to this list would cause underrun in TwoSidedList.firstIndex() or overrun in TwoSidedList.minFreeIndex() depending on this direction.