javax.media.j3d

Class IndexedUnorderSet

java.lang.Object

javax.media.j3d.IndexedUnorderSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

 class IndexedUnorderSet
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

A strongly type indexed unorder set. All operations remove(IndexedObject, ListType), add(IndexedObject, ListType), contains(IndexedObject, ListType) etc. take O(1) time. The class is designed to optimize speed. So many reductance procedures call and range check as found in ArrayList are removed.

Use the following code to iterate through an array.

  IndexedUnorderSet  IUset =
      new IndexedUnorderSet(YourClass.class, listType);
  // add element here

  YourClass[] arr = (YourClass []) IUset.toArray();
  int size = IUset.arraySize();
  for (int i=0; i < size; i++) {
      YourClass obj = arr[i];
      ....
  }
 

Note:

1) The array return is a copied of internal array.
2) Don't use arr.length , use IUset.arraySize();
3) IndexedObject contains an array of listIndex, the number of array elements depends on the number of different types of IndexedUnorderSet that use it.
4) No need to do casting for individual element as in ArrayList.
5) IndexedUnorderSet is thread safe.
6) Object implement this interface MUST initialize the index to -1.

Limitation:

1) Order of IndexedObject in list is not important
2) Can't modify the clone() copy.
3) IndexedObject can't be null

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.Object[]	cloneData Clone copy of elementData return by toArray(true);
(package private) int	cloneSize
(package private) java.lang.Class	componentType Component Type of individual array element entry
(package private) static boolean	debug
(package private) IndexedObject[]	elementData The array buffer into which the elements of the ArrayList are stored.
(package private) boolean	isDirty
(package private) int	listType
(package private) int	size The size of the ArrayList (the number of elements it contains).
(package private) VirtualUniverse	univ

Constructor Summary

Constructors

Constructor and Description
IndexedUnorderSet(java.lang.Class componentType, int listType, VirtualUniverse univ) Constructs an empty list.
IndexedUnorderSet(int initialCapacity, java.lang.Class componentType, int listType, VirtualUniverse univ) Constructs an empty list with the specified initial capacity.
IndexedUnorderSet(int initialCapacity, int listType, VirtualUniverse univ) Constructs an empty list with the specified initial capacity.
IndexedUnorderSet(int listType, VirtualUniverse univ) Constructs an empty list.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	add(IndexedObject o) Appends the specified element to the end of this list.
(package private) int	arraySize() Returns the size of entry use in toArray() number of elements in this list.
(package private) void	clear() Removes all of the elements from this list.
(package private) void	clearMirror()
protected java.lang.Object	clone() Returns a shallow copy of this ArrayList instance.
(package private) boolean	contains(IndexedObject o) Returns true if this list contains the specified element.
(package private) java.lang.Object	get(int index) Returns the element at the specified position in this list.
(package private) java.lang.Class	getComponentType()
(package private) int	indexOf(IndexedObject o) Searches for the last occurence of the given argument, testing for equality using the equals method.
(package private) static void	init(IndexedObject obj, int len) Initialize all indexes to -1
(package private) boolean	isEmpty() Tests if this list has no elements.
private void	readObject(java.io.ObjectInputStream s) Reconstitute the ArrayList instance from a stream (that is, deserialize it).
(package private) boolean	remove(IndexedObject o) Removes the specified element in this list.
(package private) void	remove(int index) Removes the element at the specified position in this list.
(package private) java.lang.Object	removeLastElement() Removes the element at the last position in this list.
(package private) void	set(int index, IndexedObject o) Replaces the element at the specified position in this list with the specified element.
(package private) int	size() Returns the number of elements in this list.
(package private) java.lang.Object[]	toArray() Returns an array containing all of the elements in this list.
(package private) java.lang.Object[]	toArray(boolean copy) Returns an array containing all of the elements in this list.
(package private) java.lang.Object[]	toArray(IndexedObject startElement) Returns an array containing elements starting from startElement all of the elements in this list.
(package private) void	trimToSize() Trims the capacity of this ArrayList instance to be the list's current size.
private void	writeObject(java.io.ObjectOutputStream s) Save the state of the ArrayList instance to a stream (that is, serialize it).

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

debug

static final boolean debug

See Also:

Constant Field Values

elementData

transient IndexedObject[] elementData

The array buffer into which the elements of the ArrayList are stored. The capacity of the ArrayList is the length of this array buffer. It is non-private to enable compiler do inlining for get(), set(), remove() when -O flag turn on.

cloneData

transient java.lang.Object[] cloneData

Clone copy of elementData return by toArray(true);

cloneSize

transient int cloneSize

isDirty

transient boolean isDirty

componentType

java.lang.Class componentType

Component Type of individual array element entry

size

int size

The size of the ArrayList (the number of elements it contains). We make it non-private to enable compiler do inlining for getSize() when -O flag turn on.

listType

int listType

univ

VirtualUniverse univ

Constructor Detail

IndexedUnorderSet

IndexedUnorderSet(int initialCapacity,
                 java.lang.Class componentType,
                 int listType,
                 VirtualUniverse univ)

Constructs an empty list with the specified initial capacity. and the class data Type

Parameters:

initialCapacity - the initial capacity of the list.

componentType - class type of element in the list.

IndexedUnorderSet

IndexedUnorderSet(java.lang.Class componentType,
                 int listType,
                 VirtualUniverse univ)

Constructs an empty list.

Parameters:

componentType - class type of element in the list.

IndexedUnorderSet

IndexedUnorderSet(int initialCapacity,
                 int listType,
                 VirtualUniverse univ)

Constructs an empty list with the specified initial capacity.

Parameters:

initialCapacity - the initial capacity of the list.

IndexedUnorderSet

IndexedUnorderSet(int listType,
                 VirtualUniverse univ)

Constructs an empty list.

Parameters:

listType - default to Object.

Method Detail

init

static final void init(IndexedObject obj,
        int len)

Initialize all indexes to -1

size

final int size()

Returns the number of elements in this list.

Returns:

the number of elements in this list.

arraySize

final int arraySize()

Returns the size of entry use in toArray() number of elements in this list.

Returns:

the number of elements in this list.

isEmpty

final boolean isEmpty()

Tests if this list has no elements.

Returns:

true if this list has no elements; false otherwise.

contains

final boolean contains(IndexedObject o)

Returns true if this list contains the specified element.

Parameters:

o - element whose presence in this List is to be tested.

indexOf

final int indexOf(IndexedObject o)

Searches for the last occurence of the given argument, testing for equality using the equals method.

Parameters:

o - an object.

Returns:

the index of the first occurrence of the argument in this list; returns -1 if the object is not found.

See Also:

Object.equals(Object)

clone

protected final java.lang.Object clone()

Returns a shallow copy of this ArrayList instance. (The elements themselves are not copied.)

Overrides:

clone in class java.lang.Object

Returns:

a clone of this ArrayList instance.

toArray

final java.lang.Object[] toArray(boolean copy)

Returns an array containing all of the elements in this list. The size of the array may longer than the actual size. Use arraySize() to retrieve the size. The array return is a copied of internal array. if copy is true.

Returns:

an array containing all of the elements in this list

toArray

final java.lang.Object[] toArray()

Returns an array containing all of the elements in this list. The size of the array may longer than the actual size. Use arraySize() to retrieve the size. The array return is a copied of internal array. So another thread can continue add/delete the current list. However, it should be noticed that two call to toArray() may return the same copy.

Returns:

an array containing all of the elements in this list

toArray

final java.lang.Object[] toArray(IndexedObject startElement)

Returns an array containing elements starting from startElement all of the elements in this list. A new array of exact size is always allocated.

Parameters:

startElement - starting element to copy

Returns:

an array containing elements starting from startElement, null if element not found.

trimToSize

final void trimToSize()

Trims the capacity of this ArrayList instance to be the list's current size. An application can use this operation to minimize the storage of an ArrayList instance.

get

final java.lang.Object get(int index)

Returns the element at the specified position in this list.

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

Throws:

java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= size()).

set

final void set(int index,
       IndexedObject o)

Replaces the element at the specified position in this list with the specified element.

Parameters:

index - index of element to replace.

o - element to be stored at the specified position.

Throws:

java.lang.IndexOutOfBoundsException - if index out of range (index < 0 || index >= size()).

add

final void add(IndexedObject o)

Appends the specified element to the end of this list. It is the user responsible to ensure that the element add is of the same type as array componentType.

Parameters:

o - element to be appended to this list.

remove

final void remove(int index)

Removes the element at the specified position in this list. Replace the removed element by the last one.

Parameters:

index - the index of the element to removed.

Throws:

java.lang.IndexOutOfBoundsException - if index out of range (index < 0 || index >= size()).

removeLastElement

final java.lang.Object removeLastElement()

Removes the element at the last position in this list.

Returns:

The element remove

Throws:

java.lang.IndexOutOfBoundsException - if array is empty

remove

final boolean remove(IndexedObject o)

Removes the specified element in this list. Replace the removed element by the last one.

Parameters:

o - the element to removed.

Returns:

true if object remove

Throws:

java.lang.IndexOutOfBoundsException - if index out of range (index < 0 || index >= size()).

clear

final void clear()

Removes all of the elements from this list. The list will be empty after this call returns.

clearMirror

final void clearMirror()

getComponentType

final java.lang.Class getComponentType()

writeObject

private void writeObject(java.io.ObjectOutputStream s)
                  throws java.io.IOException

Save the state of the ArrayList instance to a stream (that is, serialize it).

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream s)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Reconstitute the ArrayList instance from a stream (that is, deserialize it).

Throws:

java.io.IOException

java.lang.ClassNotFoundException