All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.objectspace.jgl.adapters.ByteBuffer

java.lang.Object
   |
   +----COM.objectspace.jgl.adapters.ByteBuffer

public class ByteBuffer

extends Object

implements Sequence

The implementation store elements in a contiguous linear memory space so that index-based access is very quick. When an ByteBuffer's originally allocated memory space is exceeded, its elements are copied into a new memory space that is large enough to accomodate everything.

If an insertion causes reallocation, all iterators and references are invalidated; otherwise, only the iterators and references after the insertion point are invalidated.

A remove invalidates all of the iterators and references after the point of the remove.

See Also:

ByteArray, ByteIterator

ByteBuffer()

Construct myself to be an empty ByteBuffer.

ByteBuffer(byte[])

Construct myself to use a specified array as my initial storage.

ByteBuffer(ByteBuffer)

Construct myself to be a copy of an existing ByteBuffer.

ByteBuffer(int)

Construct myself to contain a specified number of null elements.

ByteBuffer(int, byte)

Construct myself to contain a specified number of elements set to a particular object.

add(byte)

Add a byte after my last element.

add(Object)

Add an object after my last element.

at(int)

Return the element at the specified index.

back()

Return my last element.

begin()

Return an iterator positioned at my first item.

byteAt(int)

Return the byte at the specified index.

capacity()

Return the number of elements that I contain without allocating more internal storage.

clear()

Remove all of my elements.

clone()

Return a shallow copy of myself.

contains(byte)

Return true if I contain a particular byte.

contains(Object)

Return true if I contain a particular object using .equals()

copy(ByteBuffer)

Become a shallow copy of an existing ByteBuffer.

copyTo(byte[])

Copy my elements into the specified array.

count(byte)

Return the number of objects that equal a particular value.

count(int, int, byte)

Return the number of objects within a particular range of indices that match a particular byte.

count(int, int, Object)

Return the number of objects within a particular range of indices that match a particular value.

count(Object)

Return the number of objects that match a particular value.

elements()

Return an Enumeration of my components.

end()

Return an iterator positioned immediately after my last item.

ensureCapacity(int)

Pre-allocate enough space to hold a specified number of elements.

equals(byte[])

Return true if I contain the same items in the same order as a native array of bytes.

equals(ByteArray)

Return true if I contain the same items in the same order as a ByteArray.

equals(ByteBuffer)

Return true if I contain the same items in the same order as another ByteBuffer.

equals(Object)

Return true if I'm equal to another object.

finish()

Return an iterator positioned immediately after my last item.

front()

Return my first element.

get()

Retrieve the underlying primitive array.

hashCode()

Return my hash code for support of hashing containers

indexOf(byte)

Return the index of the first byte that matches a particular value, or -1 if the value is not found.

indexOf(int, int, byte)

Return the index of the first byte within a range of indices that match a particular value, or -1 if the byte is not found.

indexOf(int, int, Object)

Return the index of the first object within a range of indices that match a particular object, or -1 if the object is not found.

indexOf(Object)

Return the index of the first object that matches a particular value, or -1 if the object is not found.

insert(ByteIterator, byte)

Insert a value at a particular position and return an iterator positioned at the new element.

insert(ByteIterator, ForwardIterator, ForwardIterator)

Insert a sequence of objects at a particular location.

insert(ByteIterator, int, byte)

Insert multiple values at a particular position.

insert(ByteIterator, int, Object)

Insert multiple objects at a particular position.

insert(ByteIterator, Object)

Insert an object at a particular position and return an iterator positioned at the new element.

insert(int, byte)

Insert a value at a particular index.

insert(int, ForwardIterator, ForwardIterator)

Insert a sequence of objects at a particular index.

insert(int, int, byte)

Insert multiple objects at a particular index.

insert(int, int, Object)

Insert multiple objects at a particular index.

insert(int, Object)

Insert an object at a particular index.

isEmpty()

Return true if I contain no objects.

maxSize()

Return the maximum number of entries that I can contain.

popBack()

Remove and return my last element.

popFront()

Remove and return my first element.

pushBack(byte)

Add a byte after my last element.

pushBack(Object)

Add an object after my last element.

pushFront(byte)

Insert a value in front of my first element.

pushFront(Object)

Insert an object in front of my first element.

put(int, byte)

Set the byte at the specified index to a particular value.

put(int, Object)

Set the element at the specified index to a particular object.

remove(Enumeration)

Remove the element at a particular position.

remove(Enumeration, Enumeration)

Remove the elements in the specified range.

remove(int)

Remove the element at a particular index.

remove(int, int)

Remove the elements within a range of indices.

remove(int, int, Object)

Remove all elements within a range of indices that match a particular object and return the number of objects that were removed.

remove(Object)

Remove all elements that match a particular object and return the number of objects that were removed.

remove(Object, int)

Remove at most a given number of elements that match a particular object and return the number of objects that were removed.

replace(byte, byte)

Replace all bytes that match a particular object with a new value and return the number of objects that were replaced.

replace(int, int, byte, byte)

Replace all values within a range of indices that match a particular byte with a new value and return the number of objects that were replaced.

replace(int, int, Object, Object)

Replace all elements within a range of indices that match a particular object with a new value and return the number of objects that were replaced.

replace(Object, Object)

Replace all elements that match a particular object with a new value and return the number of objects that were replaced.

setSize(int)

Sets the size of the ByteBuffer.

size()

Return the number of entries that I contain.

start()

Return an iterator positioned at my first item.

swap(ByteBuffer)

Swap my contents with another ByteBuffer.

toString()

Return a string that describes me.

trimToSize()

If my storage space is currently larger than my total number of elements, reallocate the elements into a storage space that is exactly the right size.

 public ByteBuffer()

Construct myself to be an empty ByteBuffer.

 public ByteBuffer(int size)

Construct myself to contain a specified number of null elements.

Parameters:

size - The number of elements to contain.

Throws: IllegalArgumentException

If size is negative.

 public ByteBuffer(int size,
                   byte object)

Construct myself to contain a specified number of elements set to a particular object.

Parameters:

size - The number of elements to contain.

object - The initial value of each element.

Throws: IllegalArgumentException

If size is negative.

 public ByteBuffer(byte array[])

Construct myself to use a specified array as my initial storage.

Parameters:

The - array to use as initial storage.

 public ByteBuffer(ByteBuffer array)

Construct myself to be a copy of an existing ByteBuffer.

Parameters:

array - The ByteBuffer to copy.

 public synchronized Object clone()

Return a shallow copy of myself.

Overrides:

clone in class Object

 public boolean equals(Object object)

Return true if I'm equal to another object.

Parameters:

object - The object to compare myself against.

Overrides:

equals in class Object

 public boolean equals(ByteBuffer buffer)

Return true if I contain the same items in the same order as another ByteBuffer.

Parameters:

array - The ByteBuffer to compare myself against.

 public synchronized boolean equals(ByteArray array)

Return true if I contain the same items in the same order as a ByteArray.

Parameters:

array - The ByteArray to compare myself against.

 public boolean equals(byte array[])

Return true if I contain the same items in the same order as a native array of bytes.

Parameters:

array - The array to compare myself against.

 public synchronized String toString()

Return a string that describes me.

Overrides:

toString in class Object

 public synchronized void copy(ByteBuffer buffer)

Become a shallow copy of an existing ByteBuffer.

Parameters:

array - The ByteBuffer that I shall become a shallow copy of.

 public synchronized void copyTo(byte array[])

Copy my elements into the specified array. The number of items that are copied is equal to the smaller of my length and the size of the specified array.

Parameters:

array - The array that I shall copy my elements into.

 public synchronized byte[] get()

Retrieve the underlying primitive array.

 public synchronized int hashCode()

Return my hash code for support of hashing containers

Overrides:

hashCode in class Object

 public boolean isEmpty()

Return true if I contain no objects.

 public Object back()

Return my last element.

 public Object front()

Return my first element.

 public int size()

Return the number of entries that I contain.

 public int capacity()

Return the number of elements that I contain without allocating more internal storage.

 public int maxSize()

Return the maximum number of entries that I can contain.

 public Object at(int index)

Return the element at the specified index.

Parameters:

index - The index.

Throws: IndexOutOfBoundsException

If the index is invalid.

 public synchronized byte byteAt(int index)

Return the byte at the specified index.

Parameters:

index - The index.

Throws: IndexOutOfBoundsException

If the index is invalid.

 public synchronized void put(int index,
                              Object object)

Set the element at the specified index to a particular object.

Parameters:

index - The index.

object - The object.

Throws: IndexOutOfBoundsException

If the index is invalid.

 public synchronized void put(int index,
                              byte object)

Set the byte at the specified index to a particular value.

Parameters:

index - The index.

object - The value.

Throws: IndexOutOfBoundsException

If the index is invalid.

 public synchronized void clear()

Remove all of my elements.

 public Object remove(Enumeration pos)

Remove the element at a particular position.

Parameters:

pos - An enumeration positioned at the element to remove.

Throws: IllegalArgumentException

is the Enumeration isn't an ByteIterator for this ByteBuffer object.

 public synchronized Object remove(int index)

Remove the element at a particular index.

Parameters:

index - The index of the element to remove.

Returns:

The object removed.

Throws: IndexOutOfBoundsException

If the index is invalid.

 public int remove(Enumeration first,
                   Enumeration last)

Remove the elements in the specified range.

Parameters:

first - An Enumeration positioned at the first element to remove.

last - An Enumeration positioned immediately after the last element to remove.

Returns:

The number of elements removed.

Throws: IllegalArgumentException

is the Enumeration isn't an ByteIterator for this ByteBuffer object.

 public synchronized int remove(int first,
                                int last)

Remove the elements within a range of indices.

Parameters:

first - The index of the first element to remove.

last - The index of the last element to remove.

Returns:

The number of elements removed.

Throws: IndexOutOfBoundsException

If either index is invalid.

 public synchronized Object popBack()

Remove and return my last element.

Throws: InvalidOperationException

If the ByteBuffer is empty.

 public synchronized Object add(Object object)

Add an object after my last element. Returns null. This function is a synonym for pushBack().

Parameters:

object - The object to add.

 public synchronized void add(byte object)

Add a byte after my last element. Returns null. This function is a synonym for pushBack().

Parameters:

object - The object to add.

 public void pushBack(Object object)

Add an object after my last element.

Parameters:

The - object to add.

 public void pushBack(byte object)

Add a byte after my last element.

Parameters:

The - object to add.

 public ByteIterator insert(ByteIterator pos,
                            Object object)

Insert an object at a particular position and return an iterator positioned at the new element.

Parameters:

pos - An iterator positioned at the element that the object will be inserted immediately before.

object - The object to insert.

 public ByteIterator insert(ByteIterator pos,
                            byte object)

Insert a value at a particular position and return an iterator positioned at the new element.

Parameters:

pos - An iterator positioned at the element that the object will be inserted immediately before.

object - The object to insert.

 public void insert(int index,
                    Object object)

Insert an object at a particular index.

Parameters:

index - The index of the element that the object will be inserted immediately before.

object - The object to insert.

Throws: IndexOutOfBoundsException

If the index is invalid.

 public synchronized void insert(int index,
                                 byte object)

Insert a value at a particular index.

Parameters:

index - The index of the element that the object will be inserted immediately before.

object - The value to insert.

Throws: IndexOutOfBoundsException

If the index is invalid.

 public void insert(ByteIterator pos,
                    int n,
                    Object object)

Insert multiple objects at a particular position.

Parameters:

pos - An iterator positioned at the element before which the elements will be inserted.

n - The number of objects to insert.

object - The object to insert.

 public void insert(ByteIterator pos,
                    int n,
                    byte object)

Insert multiple values at a particular position.

Parameters:

pos - An iterator positioned at the element before which the elements will be inserted.

n - The number of values to insert.

object - The value to insert.

 public void insert(int index,
                    int n,
                    Object object)

Insert multiple objects at a particular index.

Parameters:

index - The index of the element immediately before the values will be inserted.

object - The object to insert.

Throws: IndexOutOfBoundsException

If the index is invalid.

Throws: IllegalArgumentException

If the number of values is negative.

 public synchronized void insert(int index,
                                 int n,
                                 byte object)

Insert multiple objects at a particular index.

Parameters:

index - The index of the element immediately before the values will be inserted.

object - The value to insert.

Throws: IndexOutOfBoundsException

If the index is invalid.

Throws: IllegalArgumentException

If the number of values is negative.

 public void insert(ByteIterator pos,
                    ForwardIterator first,
                    ForwardIterator last)

Insert a sequence of objects at a particular location.

Parameters:

pos - The location of the element that the objects will be inserted immediately before.

first - An iterator positioned at the first element to insert.

last - An iterator positioned immediately after the last element to insert.

 public synchronized void insert(int index,
                                 ForwardIterator first,
                                 ForwardIterator last)

Insert a sequence of objects at a particular index.

Parameters:

index - The index of the element that the objects will be inserted immediately before.

first - An iterator positioned at the first element to insert.

last - An iterator positioned immediately after the last element to insert.

 public synchronized void swap(ByteBuffer array)

Swap my contents with another ByteBuffer.

Parameters:

array - The ByteBuffer that I will swap my contents with.

 public Enumeration elements()

Return an Enumeration of my components.

 public ForwardIterator start()

Return an iterator positioned at my first item.

 public ForwardIterator finish()

Return an iterator positioned immediately after my last item.

 public synchronized ByteIterator begin()

Return an iterator positioned at my first item.

 public synchronized ByteIterator end()

Return an iterator positioned immediately after my last item.

 public synchronized void trimToSize()

If my storage space is currently larger than my total number of elements, reallocate the elements into a storage space that is exactly the right size.

 public synchronized void ensureCapacity(int n)

Pre-allocate enough space to hold a specified number of elements. This operation does not change the value returned by size().

Parameters:

n - The amount of space to pre-allocate.

Throws: IllegalArgumentException

If the specified size is negative.

 public synchronized Object popFront()

Remove and return my first element.

Throws: InvalidOperationException

If the ByteBuffer is empty.

 public void pushFront(Object object)

Insert an object in front of my first element.

Parameters:

object - The object to insert.

 public void pushFront(byte object)

Insert a value in front of my first element.

Parameters:

object - The object to insert.

 public int remove(Object object)

Remove all elements that match a particular object and return the number of objects that were removed.

Parameters:

object - The object to remove.

 public synchronized int remove(Object object,
                                int count)

Remove at most a given number of elements that match a particular object and return the number of objects that were removed.

Parameters:

object - The object to remove.

count - The maximum number of objects to remove.

 public synchronized int remove(int first,
                                int last,
                                Object object)

Remove all elements within a range of indices that match a particular object and return the number of objects that were removed.

Parameters:

first - The index of the first object to consider.

last - The index of the last object to consider.

object - The object to remove.

Throws: IndexOutOfBoundsException

If either index is invalid.

 public int replace(Object oldValue,
                    Object newValue)

Replace all elements that match a particular object with a new value and return the number of objects that were replaced.

Parameters:

oldValue - The object to be replaced.

newValue - The value to substitute.

 public int replace(byte oldValue,
                    byte newValue)

Replace all bytes that match a particular object with a new value and return the number of objects that were replaced.

Parameters:

oldValue - The byte to be replaced.

newValue - The value to substitute.

 public int replace(int first,
                    int last,
                    Object oldValue,
                    Object newValue)

Replace all elements within a range of indices that match a particular object with a new value and return the number of objects that were replaced.

Parameters:

first - The index of the first object to be considered.

last - The index just past the last object to be considered.

oldValue - The object to be replaced.

newValue - The value to substitute.

Throws: IndexOutOfBoundsException

If either index is invalid.

 public synchronized int replace(int first,
                                 int last,
                                 byte oldValue,
                                 byte newValue)

Replace all values within a range of indices that match a particular byte with a new value and return the number of objects that were replaced.

Parameters:

first - The index of the first element to be considered.

last - The index just past the last element to be considered.

oldValue - The byte to be replaced.

newValue - The value to substitute.

Throws: IndexOutOfBoundsException

If either index is invalid.

 public int count(Object object)

Return the number of objects that match a particular value.

Parameters:

object - The object to count.

 public int count(byte object)

Return the number of objects that equal a particular value.

Parameters:

object - The byte to count.

 public int count(int first,
                  int last,
                  Object object)

Return the number of objects within a particular range of indices that match a particular value.

Parameters:

first - The index of the first object to consider.

last - The index of the last object to consider.

Throws: IndexOutOfBoundsException

If either index is invalid.

 public synchronized int count(int first,
                               int last,
                               byte object)

Return the number of objects within a particular range of indices that match a particular byte.

Parameters:

first - The index of the first object to consider.

last - The index of the last object to consider.

Throws: IndexOutOfBoundsException

If either index is invalid.

 public int indexOf(Object object)

Return the index of the first object that matches a particular value, or -1 if the object is not found. Uses .equals() to find a match

Parameters:

object - The object to find.

Throws: ClassCastException

if objects are not Boolean

 public int indexOf(byte object)

Return the index of the first byte that matches a particular value, or -1 if the value is not found.

Parameters:

object - The byte to find.

 public int indexOf(int first,
                    int last,
                    Object object)

Return the index of the first object within a range of indices that match a particular object, or -1 if the object is not found.

Parameters:

first - The index of the first object to consider.

last - The index of the last object to consider.

object - The object to find.

Throws: IndexOutOfBoundsException

If either index is invalid.

 public synchronized int indexOf(int first,
                                 int last,
                                 byte object)

Return the index of the first byte within a range of indices that match a particular value, or -1 if the byte is not found.

Parameters:

first - The index of the first value to consider.

last - The index of the last value to consider.

object - The value to find.

Throws: IndexOutOfBoundsException

If either index is invalid.

 public synchronized void setSize(int newSize)

Sets the size of the ByteBuffer. if the size shrinks, the extra elements (at the end of the array) are lost; if the size increases, the new elements are set to null.

Parameters:

newSize - The new size of the ByteBuffer.

 public boolean contains(Object object)

Return true if I contain a particular object using .equals()

Parameters:

object - The object in question.

 public boolean contains(byte object)

Return true if I contain a particular byte.

Parameters:

object - The byte for which ot search.

All Packages  Class Hierarchy  This Package  Previous  Next  Index