org.apache.jdo.impl.sco
Class LinkedList

java.lang.Object
  java.util.AbstractCollection
      java.util.AbstractList
          java.util.AbstractSequentialList
              java.util.LinkedList
                  org.apache.jdo.impl.sco.LinkedList

All Implemented Interfaces:

java.lang.Cloneable, java.util.Collection, java.util.List, SCO, SCOCollection, java.io.Serializable

public class LinkedList

extends java.util.LinkedList

implements SCOCollection

A mutable 2nd class object that represents LinkedList.

Version:

1.0.1

Author:

Marina Vatkina

See Also:

LinkedList, Serialized Form

Nested Class Summary

Nested classes inherited from class java.util.LinkedList

Nested classes inherited from class java.util.AbstractList

Field Summary

private static java.lang.String	_LinkedList
private java.util.Vector	added
private boolean	allowNulls
private java.lang.Class	elementType
private int	fieldNumber
private static org.apache.jdo.util.I18NHelper	msg I18N message handler
private StateManagerInternal	owner
private java.util.Vector	removed

Fields inherited from class java.util.LinkedList

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

LinkedList(java.lang.Class elementType, boolean allowNulls)
Constructs an empty LinkedList object.

LinkedList(java.lang.Class elementType, boolean allowNulls, int initialCapacity)
Constructs an empty LinkedList object that the specified initial capacity which is ignored.

Method Summary

void	add(int index, java.lang.Object element) Inserts the specified element at the specified position in this LinkedList.
boolean	add(java.lang.Object o) Appends the specified element to the end of this LinkedList.
boolean	addAll(java.util.Collection c) Appends all of the elements in the specified Collection to the end of this LinkedList, in the order that they are returned by the specified Collection's Iterator.
boolean	addAll(int index, java.util.Collection c) Inserts all of the elements in in the specified Collection into this LinkedList at the specified position.
void	addAllInternal(java.util.Collection c) Adds objects of the given Collection to this Collection without recording the event.
void	addFirst(java.lang.Object o) Inserts the given element at the beginning of this list.
void	addInternal(java.lang.Object o) Adds object to the Collection without recording the event.
void	addLast(java.lang.Object o) Appends the given element to the end of this list.
boolean	allowNulls() Returns whether nulls are permitted as elements.
void	clear() Removes all of the elements from this LinkedList.
void	clearInternal() Clears Collection without recording the event.
java.lang.Object	clone() Creates and returns a copy of this object.
java.util.Iterator	eitherIterator() Get an iterator regardless of whether the collection is frozen.
java.util.Iterator	frozenIterator() Get an iterator over the frozen elements of this collection.
java.util.Collection	getAdded() Returns the Collection of added elements
java.lang.Class	getElementType() Returns the element type assignment compatible with all added elements of this collection.
java.lang.String	getFieldName() Returns the field name
java.lang.Object	getOwner() Returns the owner object of the SCO instance
java.util.Collection	getRemoved() Returns the Collection of removed elements
private void	makeDirty() Marks object dirty
java.lang.Object	remove(int index) Removes the element at the specified position in this LinkedList.
boolean	remove(java.lang.Object o) Removes the first occurrence of the specified element in this LinkedList If the LinkedList does not contain the element, it is unchanged.
boolean	removeAll(java.util.Collection c) Removes from this LinkedList all of its elements that are contained in the specified Collection.
java.lang.Object	removeFirst() Removes and returns the first element from this list.
void	removeInternal(java.lang.Object o) Removes element from the Collection without recording the event.
java.lang.Object	removeLast() Removes and returns the last element from this list.
void	reset() Resets removed and added lists after flush
boolean	retainAll(java.util.Collection c) Retains only the elements in this LinkedList that are contained in the specified Collection.
java.lang.Object	set(int index, java.lang.Object element) Replaces the element at the specified position in this LinkedList with the specified element.
void	setFrozen(java.lang.Object[] elements) Set the contents of this Collection from the frozen elements.
void	setOwner(java.lang.Object owner, int fieldNumber) Sets the owner and field number.
private void	trackUpdates(boolean modified) Apply changes
void	unsetOwner(java.lang.Object owner, int fieldNumber) Nullifies references to the owner Object iff the passed in owner and fieldNumber match.

Methods inherited from class java.util.LinkedList

contains, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, size, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, iterator, size, toArray, toArray

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, subList

Field Detail

owner

private transient StateManagerInternal owner

fieldNumber

private transient int fieldNumber

elementType

private transient java.lang.Class elementType

allowNulls

private transient boolean allowNulls

added

private transient java.util.Vector added

removed

private transient java.util.Vector removed

msg

private static final org.apache.jdo.util.I18NHelper msg

I18N message handler

_LinkedList

private static final java.lang.String _LinkedList

See Also:

Constant Field Values

Constructor Detail

LinkedList

public LinkedList(java.lang.Class elementType,
                  boolean allowNulls)

Constructs an empty LinkedList object.

Parameters:

elementType - the element types allowed

allowNulls - true if nulls are allowed

LinkedList

public LinkedList(java.lang.Class elementType,
                  boolean allowNulls,
                  int initialCapacity)

Constructs an empty LinkedList object that the specified initial capacity which is ignored.

Parameters:

elementType - the element types allowed

allowNulls - true if nulls are allowed

initialCapacity - the initial capacity of the list (ignored).

Throws:

java.lang.IllegalArgumentException - if the specified initial capacity is negative

Method Detail

set

public java.lang.Object set(int index,
                            java.lang.Object element)

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

Specified by:

set in interface java.util.List

Parameters:

index - index of element to replace.

element - element to be stored at the specified position.

Returns:

the element previously at the specified position.

Throws:

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

java.lang.IllegalArgumentException - fromIndex > toIndex.

See Also:

LinkedList

add

public boolean add(java.lang.Object o)

Appends the specified element to the end of this LinkedList.

Specified by:

add in interface java.util.Collection

Parameters:

o - element to be appended to this LinkedList.

Returns:

true (as per the general contract of Collection.add).

See Also:

LinkedList

addFirst

public void addFirst(java.lang.Object o)

Inserts the given element at the beginning of this list.

Parameters:

o - the element to be inserted at the beginning of this list.

addLast

public void addLast(java.lang.Object o)

Appends the given element to the end of this list. (Identical in function to the add method; included only for consistency.)

Parameters:

o - the element to be inserted at the end of this list.

remove

public boolean remove(java.lang.Object o)

Removes the first occurrence of the specified element in this LinkedList If the LinkedList does not contain the element, it is unchanged.

Specified by:

remove in interface java.util.Collection

Parameters:

o - element to be removed from this LinkedList, if present.

Returns:

true if the LinkedList contained the specified element.

See Also:

LinkedList

removeFirst

public java.lang.Object removeFirst()

Removes and returns the first element from this list.

Returns:

the first element from this list.

Throws:

NoSuchElementException - if this list is empty.

removeLast

public java.lang.Object removeLast()

Removes and returns the last element from this list.

Returns:

the last element from this list.

Throws:

NoSuchElementException - if this list is empty.

add

public void add(int index,
                java.lang.Object element)

Inserts the specified element at the specified position in this LinkedList.

Specified by:

add in interface java.util.List

Parameters:

index - index at which the specified element is to be inserted.

element - element to be inserted.

Throws:

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

See Also:

LinkedList

remove

public java.lang.Object remove(int index)

Removes the element at the specified position in this LinkedList. shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the LinkedList.

Specified by:

remove in interface java.util.List

Parameters:

index - the index of the element to removed.

Throws:

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

See Also:

LinkedList

clear

public void clear()

Removes all of the elements from this LinkedList. The LinkedList will be empty after this call returns (unless it throws an exception).

Specified by:

clear in interface java.util.Collection

See Also:

LinkedList

addAll

public boolean addAll(java.util.Collection c)

Appends all of the elements in the specified Collection to the end of this LinkedList, in the order that they are returned by the specified Collection's Iterator. Delegates to #addAll(int index, Collection c) not to duplicate the processing.

Specified by:

addAll in interface java.util.Collection

Parameters:

c - elements to be inserted into this LinkedList.

Throws:

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

See Also:

LinkedList

removeAll

public boolean removeAll(java.util.Collection c)

Removes from this LinkedList all of its elements that are contained in the specified Collection.

Specified by:

removeAll in interface java.util.Collection

Returns:

true if this LinkedList changed as a result of the call.

See Also:

LinkedList

addAll

public boolean addAll(int index,
                      java.util.Collection c)

Inserts all of the elements in in the specified Collection into this LinkedList at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the LinkedList in the order that they are returned by the specified Collection's iterator.

Specified by:

addAll in interface java.util.List

Parameters:

index - index at which to insert first element from the specified collection.

c - elements to be inserted into this LinkedList.

Throws:

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

See Also:

LinkedList

retainAll

public boolean retainAll(java.util.Collection c)

Retains only the elements in this LinkedList that are contained in the specified Collection.

Specified by:

retainAll in interface java.util.Collection

Returns:

true if this LinkedList changed as a result of the call.

See Also:

LinkedList

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Mutable Second Class Objects are required to provide a public clone method in order to allow for copying PersistenceCapable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.

Specified by:

clone in interface SCO

reset

public void reset()

Description copied from interface: SCOCollection

Resets removed and added lists after flush

Specified by:

reset in interface SCOCollection

See Also:

SCOCollection.reset()

addInternal

public void addInternal(java.lang.Object o)

Description copied from interface: SCOCollection

Adds object to the Collection without recording the event. Used internaly to initially populate the Collection

Specified by:

addInternal in interface SCOCollection

See Also:

SCOCollection.addInternal(Object o)

addAllInternal

public void addAllInternal(java.util.Collection c)

Description copied from interface: SCOCollection

Adds objects of the given Collection to this Collection without recording the event. Used internaly to initially populate the Collection

Specified by:

addAllInternal in interface SCOCollection

See Also:

SCOCollection.addAllInternal(Collection c)

getAdded

public java.util.Collection getAdded()

Description copied from interface: SCOCollection

Returns the Collection of added elements

Specified by:

getAdded in interface SCOCollection

Returns:

Collection of the added elements as java.util.Collection

See Also:

SCOCollection.getAdded()

getRemoved

public java.util.Collection getRemoved()

Description copied from interface: SCOCollection

Returns the Collection of removed elements

Specified by:

getRemoved in interface SCOCollection

Returns:

Collection of the removed elements as java.util.Collection

See Also:

SCOCollection.getRemoved()

clearInternal

public void clearInternal()

Description copied from interface: SCOCollection

Clears Collection without recording the event. Used internaly to clear the Collection

Specified by:

clearInternal in interface SCOCollection

See Also:

SCOCollection.clearInternal()

removeInternal

public void removeInternal(java.lang.Object o)

Description copied from interface: SCOCollection

Removes element from the Collection without recording the event. Used internaly to update the Collection

Specified by:

removeInternal in interface SCOCollection

See Also:

SCOCollection.removeInternal(Object o)

unsetOwner

public void unsetOwner(java.lang.Object owner,
                       int fieldNumber)

Description copied from interface: SCO

Nullifies references to the owner Object iff the passed in owner and fieldNumber match.

Specified by:

unsetOwner in interface SCO

Parameters:

owner - the existing owner object.

fieldNumber - the existing number of the field.

See Also:

SCO.unsetOwner(Object owner, int fieldNumber)

makeDirty

private void makeDirty()

Marks object dirty

trackUpdates

private void trackUpdates(boolean modified)

Apply changes

Parameters:

modified - true if content of this list has been changed.

setOwner

public void setOwner(java.lang.Object owner,
                     int fieldNumber)

Description copied from interface: SCO

Sets the owner and field number. Called by StateManager upon assignment to a managed instance.

Specified by:

setOwner in interface SCO

Parameters:

owner - the owner object.

fieldNumber - the number of the field associated with this instance.

See Also:

(Object owner, int fieldNumber)

getOwner

public java.lang.Object getOwner()

Description copied from interface: SCO

Returns the owner object of the SCO instance

Specified by:

getOwner in interface SCO

Returns:

owner object

See Also:

()

getFieldName

public java.lang.String getFieldName()

Description copied from interface: SCO

Returns the field name

Specified by:

getFieldName in interface SCO

Returns:

field name as java.lang.String

See Also:

SCO.getFieldName()

getElementType

public java.lang.Class getElementType()

Description copied from interface: SCOCollection

Returns the element type assignment compatible with all added elements of this collection.

Specified by:

getElementType in interface SCOCollection

Returns:

the element type assignment compatible with all added elements.

See Also:

{

allowNulls

public boolean allowNulls()

Description copied from interface: SCOCollection

Returns whether nulls are permitted as elements.

Specified by:

allowNulls in interface SCOCollection

Returns:

true if nulls are permitted as elements.

See Also:

{

frozenIterator

public java.util.Iterator frozenIterator()

Get an iterator over the frozen elements of this collection. This class does not require freezing, so this method returns a standard iterator.

Specified by:

frozenIterator in interface SCOCollection

Returns:

an iterator over the elements.

Since:

1.0.1

setFrozen

public void setFrozen(java.lang.Object[] elements)

Set the contents of this Collection from the frozen elements. This class does not support explicit frozen operations, and this method always throws an exception.

Specified by:

setFrozen in interface SCOCollection

Parameters:

elements - not used.

Since:

1.0.1

eitherIterator

public java.util.Iterator eitherIterator()

Get an iterator regardless of whether the collection is frozen. This class does not support frozen operations and always returns a regular iterator.

Specified by:

eitherIterator in interface SCOCollection

Returns:

an iterator over the elements of the list.

Since:

1.0.1