java.util
Class AbstractList

java.lang.Object
  java.util.AbstractCollection
      java.util.AbstractList

All Implemented Interfaces:

Collection, List

Direct Known Subclasses:

AbstractSequentialList, ArrayList, SubList, Vector

public abstract class AbstractList

extends AbstractCollection

implements List

JML's specification of java.util.AbstractList.

Version:

$Revision: 1.14 $

Author:

Gary T. Leavens

Class Specifications

protected initially this.modCount == 0;

Specifications inherited from class Object

represents objectState <- org.jmlspecs.lang.JMLDataGroup.IT; public represents _getClass <- \typeof(this);

Specifications inherited from interface List

instance public represents theCollection <- this.theList.toBag();

Specifications inherited from interface Collection

instance public invariant this.elementType == this.theCollection.elementType; instance public invariant this.containsNull == this.theCollection.containsNull; instance public invariant !this.nullElementsSupported ==> !this.containsNull;

Model Field Summary

 

Model fields inherited from class java.lang.Object

_getClass, objectState, theString

 

Model fields inherited from interface java.util.List

theList

 

Model fields inherited from interface java.util.Collection

addOperationSupported, elementState, nullElementsSupported, removeOperationSupported, theCollection

 

Ghost Field Summary

 

Ghost fields inherited from class java.lang.Object

objectTimesFinalized, owner

 

Ghost fields inherited from interface java.util.Collection

containsNull, elementType

 

Field Summary
protected  int	modCount

 

Constructor Summary
protected	AbstractList()

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Model methods inherited from interface java.util.Collection

hashValue

 

Method Summary
void	add(int index, Object element)
boolean	add(nullable Object o)
boolean	addAll(int index, Collection c)
void	clear()
boolean	equals(nullable Object o)
abstract  Object	get(int index)
int	hashCode()
int	indexOf(Object o)
Iterator	iterator()
int	lastIndexOf(Object o)
ListIterator	listIterator()
ListIterator	listIterator(final int index)
Object	remove(int index)
protected  void	removeRange(int fromIndex, int toIndex)
Object	set(int index, Object element)
List	subList(int fromIndex, int toIndex)

 

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, toArray, toArray, toString

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

 

Field Detail

modCount

protected transient int modCount

Specifications:
is in groups: theList

AbstractList

protected AbstractList()

Specifications: pure

add

public boolean add(nullable Object o)

Specified by:

add in interface List

Overrides:

add in class AbstractCollection

Specifications:

     also

protected model_program { ... }

Specifications inherited from overridden method in class AbstractCollection:
      --- None ---

Specifications inherited from overridden method add(Object o) in interface List:

     also

public behavior
assignable theCollection;
ensures \result &&this.theList.equals(\old(this.theList).insertBack(o));

Specifications inherited from overridden method add(Object o) in interface Collection:

public behavior
requires !this.containsNull ==> o != null;
requires (o == null)||\typeof(o) <: this.elementType;
assignable theCollection;
ensures \result ==> this.theCollection.equals(\old(this.theCollection.insert(o)));
ensures \result &&\old(this.size() < 2147483647) ==> this.size() == \old(this.size()+1);
ensures !\result ==> this.size() == \old(this.size());
ensures !\result ==> \not_modified(theCollection);
ensures this.contains(o);
ensures_redundantly !\result ==> \old(this.contains(o));
signals_only java.lang.UnsupportedOperationException, java.lang.NullPointerException, java.lang.ClassCastException, java.lang.IllegalArgumentException;
signals (java.lang.UnsupportedOperationException) (* this does not support add *);
signals (java.lang.NullPointerException) (* not allowed to add null *);
signals (java.lang.ClassCastException) (* class of specified element prevents it from being added to this *);
signals (java.lang.IllegalArgumentException) (* some aspect of this element prevents it from being added to this *);

get

public abstract Object get(int index)

Specified by:

get in interface List

Specifications: pure

Specifications inherited from overridden method get(int index) in interface List:
       pure

public normal_behavior
requires 0 <= index&&index < this.size();
assignable \nothing;
ensures \result == this.theList.get(index);

     also

public exceptional_behavior
requires !(0 <= index&&index < this.size());
assignable \nothing;
signals_only java.lang.IndexOutOfBoundsException;

    implies_that

public normal_behavior
requires index >= 0;
ensures (\result == null)||\typeof(\result ) <: this.elementType;
ensures !this.containsNull ==> \result != null;

set

public Object set(int index,
                  Object element)

Specified by:

set in interface List

Specifications:

     also

protected exceptional_behavior
requires \typeof(this) == \type(java.util.AbstractList);
assignable \nothing;
signals_only java.lang.UnsupportedOperationException;

Specifications inherited from overridden method set(int index, Object element) in interface List:

public behavior
requires !this.containsNull ==> element != null;
requires (element == null)||\typeof(element) <: this.elementType;

{|

requires 0 <= index&&index < this.size();
assignable theCollection;
ensures \result == (\old(this.theList.get(index)));
ensures this.theList.equals(\old(this.theList.subsequence(0,index)).insertBack(element).concat(\old(this.theList.subsequence(index+1,this.size()))));
signals_only java.lang.UnsupportedOperationException, java.lang.ClassCastException, java.lang.NullPointerException, java.lang.IllegalArgumentException;
signals (java.lang.UnsupportedOperationException) (* set method not supported by list *);
signals (java.lang.ClassCastException) (* class of specified element prevents it from being added to this *);
signals (java.lang.NullPointerException) (* element is null and null elements not supported by this *);
signals (java.lang.IllegalArgumentException) (* some aspect of element prevents it from being added to this *);

also

requires !(0 <= index&&index < this.size());
assignable \nothing;
ensures false;
signals_only java.lang.UnsupportedOperationException, java.lang.IndexOutOfBoundsException;

|}

add

public void add(int index,
                Object element)

Specified by:

add in interface List

Specifications:

     also

protected exceptional_behavior
requires \typeof(this) == \type(java.util.AbstractList);
assignable \nothing;
signals_only java.lang.UnsupportedOperationException;

Specifications inherited from overridden method add(int index, Object element) in interface List:

public behavior
requires !this.containsNull ==> element != null;
requires (element == null)||\typeof(element) <: this.elementType;

{|

requires 0 <= index&&index <= this.size();
assignable theCollection;
ensures (element == null&&this.theList.get(index) == null)||(this.theList.get(index).equals(element))&&( \forall int i; 0 <= i&&i < index; (this.theList.get(i) == null&&\old(this.theList).get(i) == null)||this.theList.get(i).equals(\old(this.theList.get(i))))&&( \forall int i; index <= i&&i < \old(this.size()); (this.theList.get((int)(i+1)) == null&&\old(this.theList).get(i) == null)||this.theList.get((int)(i+1)).equals(\old(this.theList.get(i))));
signals_only java.lang.UnsupportedOperationException, java.lang.ClassCastException, java.lang.NullPointerException, java.lang.IllegalArgumentException;
signals (java.lang.UnsupportedOperationException) (* add method not supported by list *);
signals (java.lang.ClassCastException) (* class of specified element prevents it from being added to this *);
signals (java.lang.NullPointerException) (* element is null and null elements are not supported by this *);
signals (java.lang.IllegalArgumentException) (* some aspect of element prevents it from being added to this *);

also

requires !(0 <= index&&index <= this.size());
assignable \nothing;
ensures false;
signals_only java.lang.UnsupportedOperationException, java.lang.IndexOutOfBoundsException;

|}

remove

public Object remove(int index)

Specified by:

remove in interface List

Specifications:

     also

protected exceptional_behavior
requires \typeof(this) == \type(java.util.AbstractList);
assignable \nothing;
signals_only java.lang.UnsupportedOperationException;

Specifications inherited from overridden method remove(int index) in interface List:

public behavior

{|

requires 0 <= index&&index < this.size();
assignable theCollection;
ensures \result == (\old(this.theList.get(index)));
ensures ( \forall int i; 0 <= i&&i < index; (this.theList.get(i) == null&&\old(this.theList).get(i) == null)||this.theList.get(i) == (\old(this.theList.get(i))))&&( \forall \bigint i; index <= i&&i < (\old(this.size()-1)); (this.theList.get((int)i) == null&&\old(this.theList).get((int)(i+1)) == null)||this.theList.get((int)i) == (\old(this.theList.get((int)(i+1)))));
signals_only java.lang.UnsupportedOperationException;
signals (java.lang.UnsupportedOperationException) (* remove method not supported by list *);

also

requires 0 <= index&&index < this.size();
assignable theCollection;
ensures (\result == null)||\typeof(\result ) <: this.elementType;
ensures !this.containsNull ==> \result != null;

also

requires !(0 <= index&&index < this.size());
assignable \nothing;
ensures false;
signals_only java.lang.UnsupportedOperationException, java.lang.IndexOutOfBoundsException;

|}

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List

Specifications: pure

Specifications inherited from overridden method indexOf(Object o) in interface List:
       pure

public behavior
requires !this.containsNull ==> o != null;
requires (o == null)||\typeof(o) <: this.elementType;
assignable \nothing;
ensures \result != -1&&this.theList.get(\result ) == null ==> o == null;
ensures \result != -1&&this.theList.get(\result ) != null ==> this.theList.get(\result ).equals(o)&&this.theList.indexOf(o) == \result ;
ensures \result == -1&&!this.contains(o);
signals_only java.lang.ClassCastException, java.lang.NullPointerException;
signals (java.lang.ClassCastException) (* class of specified element is incompatible with this *);
signals (java.lang.NullPointerException) (* element is null and null elements are not supported by this *);

    implies_that

ensures \result != -1 ==> ( \forall int i; 0 <= i&&i < \result ; (this.theList.get(i) == null&&o != null)||(this.theList.get(i) != null&&!this.theList.get(i).equals(o)));

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List

Specifications: pure

Specifications inherited from overridden method lastIndexOf(Object o) in interface List:
       pure

public behavior
requires !this.containsNull ==> o != null;
requires (o == null)||\typeof(o) <: this.elementType;
assignable \nothing;
ensures \result != -1&&this.theList.get(\result ) == null ==> o == null;
ensures \result != -1&&this.theList.get(\result ) != null ==> this.theList.get(\result ).equals(o)&&this.theList.reverse().indexOf(o) == this.theList.int_size()-(\result +1);
signals_only java.lang.ClassCastException, java.lang.NullPointerException;
signals (java.lang.ClassCastException) (* class of specified element is incompatible with this *);
signals (java.lang.NullPointerException) (* element is null and null elements are not supported by this *);

    implies_that

ensures \result != -1 ==> ( \forall int i; \result < i&&i < this.theList.int_size(); (this.theList.get(i) == null&&o != null)||(this.theList.get(i) != null&&!this.theList.get(i).equals(o)));

clear

public void clear()

Specified by:

clear in interface List

Overrides:

clear in class AbstractCollection

Specifications:

     also

protected model_program { ... }

Specifications inherited from overridden method in class AbstractCollection:
      --- None ---

Specifications inherited from overridden method in interface List:
      --- None ---

Specifications inherited from overridden method in interface Collection:

public behavior
assignable theCollection;
ensures this.theCollection.isEmpty();
ensures_redundantly this.size() == 0;
signals_only java.lang.UnsupportedOperationException;
signals (java.lang.UnsupportedOperationException) (* clear is not supported by this *);

addAll

public boolean addAll(int index,
                      Collection c)

Specified by:

addAll in interface List

Specifications inherited from overridden method addAll(int index, Collection c) in interface List:

public behavior
requires c != null;
requires 0 <= index&&index <= this.size();
requires c.elementType <: this.elementType;
requires !this.containsNull ==> !c.containsNull;
assignable theCollection;
ensures \result ==> this.theList.equals(\old(this.theList.subsequence(0,index)).concat(org.jmlspecs.models.JMLEqualsSequence.convertFrom(c)).concat(\old(this.theList.subsequence(index,this.size()))));
signals_only java.lang.UnsupportedOperationException, java.lang.IllegalArgumentException;
signals (java.lang.UnsupportedOperationException) (* if this operation is not supported *);
signals (java.lang.IllegalArgumentException) (* if some aspect of c prevents its elements from being added to the list *);

     also

public exceptional_behavior
requires c == null||!(0 <= index&&index <= this.size())||!(c.elementType <: this.elementType)||(!this.containsNull&&c.containsNull);
assignable \nothing;
signals_only java.lang.UnsupportedOperationException, java.lang.ClassCastException, java.lang.NullPointerException, java.lang.IndexOutOfBoundsException;
signals (java.lang.ClassCastException) c != null&&!(c.elementType <: this.elementType);
signals (java.lang.NullPointerException) c == null;
signals (java.lang.IndexOutOfBoundsException) !(0 <= index&&index <= this.size());

iterator

public Iterator iterator()

Specified by:

iterator in interface List

Specifications: pure

Specifications inherited from overridden method in class AbstractCollection:
       pure

Specifications inherited from overridden method in interface List:
       pure

     also

public behavior
assignable \nothing;
ensures \result != null;
ensures this.size() < 2147483647 ==> ( \forall int i; 0 <= i&&i < this.size(); \result .hasNext(i)&&\result .nthNextElement(i) == this.toArray()[i]);

Specifications inherited from overridden method in interface Collection:
       pure non_null

public normal_behavior
assignable \nothing;
ensures \result != null;
ensures \result .elementType == this.elementType;
ensures this.containsNull == \result .returnsNull;

     also

public normal_behavior
ensures ( \forall int i; 0 <= i&&i < this.size(); this.theCollection.has(\result .nthNextElement(i)));
ensures ( \forall java.lang.Object o; ; this.theCollection.has(o) ==> ( \exists int i; 0 <= i&&i < this.size(); o.equals(\result .nthNextElement(i))));
ensures this.size() > 0 ==> \result .hasNext((int)(this.size()-1));
ensures !\result .hasNext((int)(this.size()));
ensures_redundantly ( \forall int i; 0 <= i&&i < this.size(); this.contains(\result .nthNextElement(i)));
ensures_redundantly this.size() != 0 ==> \result .moreElements;

listIterator

public ListIterator listIterator()

Specified by:

listIterator in interface List

Specifications: pure

     also

protected model_program { ... }

Specifications inherited from overridden method in interface List:
       pure non_null

public normal_behavior
assignable \nothing;
ensures \result != null&&this.size() < 2147483647 ==> ( \forall int i; 0 <= i&&i < this.size(); \result .hasNext(i)&&\result .nthNextElement(i) == this.toArray()[i]);
ensures \result .elementType == this.elementType;
ensures this.containsNull == \result .returnsNull;

listIterator

public ListIterator listIterator(final int index)

Specified by:

listIterator in interface List

Specifications: pure

Specifications inherited from overridden method listIterator(int index) in interface List:
       pure non_null

public normal_behavior
requires 0 <= index&&index < this.size();
assignable \nothing;
ensures \result != null&&this.size() < 2147483647 ==> ( \forall int i; index <= i&&i < this.size(); \result .hasNext(i)&&\result .nthNextElement(i) == this.toArray()[i]);

     also

public exceptional_behavior
requires index < 0&&this.size() <= index;
signals_only java.lang.IndexOutOfBoundsException;

    implies_that

ensures \result .elementType == this.elementType;
ensures this.containsNull == \result .returnsNull;

subList

public List subList(int fromIndex,
                    int toIndex)

Specified by:

subList in interface List

Specifications: pure

Specifications inherited from overridden method subList(int fromIndex, int toIndex) in interface List:
       pure

public normal_behavior
requires 0 <= fromIndex&&fromIndex <= this.size()&&0 <= toIndex&&toIndex <= this.size()&&fromIndex <= toIndex;
assignable \nothing;
ensures \result != null&&\result .theList.equals(this.theList.subsequence(fromIndex,toIndex));

     also

public exceptional_behavior
requires !(0 <= fromIndex&&fromIndex <= this.size())||!(0 <= toIndex&&toIndex <= this.size())||!(fromIndex <= toIndex);
assignable \nothing;
signals_only java.lang.IndexOutOfBoundsException;

    implies_that

public normal_behavior
requires 0 <= fromIndex&&fromIndex <= toIndex;

equals

public boolean equals(nullable Object o)

Specified by:

equals in interface List

Overrides:

equals in class Object

Specifications: pure

Specifications inherited from overridden method equals(Object obj) in class Object:
       pure

public normal_behavior
requires obj != null;
ensures (* \result is true when obj is "equal to" this object *);

     also

public normal_behavior
requires this == obj;
ensures \result ;

     also

public code normal_behavior
requires obj != null;
ensures \result <==> this == obj;

     also

diverges false;
ensures obj == null ==> !\result ;

Specifications inherited from overridden method equals(Object o) in interface List:
       pure

     also

public normal_behavior
requires o instanceof java.util.List&&this.size() == ((java.util.List)o).size();
assignable \nothing;
ensures \result ==> ( \forall int i; 0 <= i&&i < this.size(); (this.theList.get(i) == null&&((java.util.List)o).theList.get(i) == null)||(this.theList.get(i).equals(((java.util.List)o).theList.get(i))));

     also

public normal_behavior
requires !(o instanceof java.util.List&&this.size() == ((java.util.List)o).size());
assignable \nothing;
ensures !\result ;

Specifications inherited from overridden method in interface Collection:
      --- None ---

hashCode

public int hashCode()

Specified by:

hashCode in interface List

Overrides:

hashCode in class Object

Specifications: pure

Specifications inherited from overridden method in class Object:

public behavior
assignable objectState;
ensures (* \result is a hash code for this object *);

     also

public code normal_behavior
assignable \nothing;

Specifications inherited from overridden method in interface List:
      --- None ---

Specifications inherited from overridden method in interface Collection:
      --- None ---

removeRange

protected void removeRange(int fromIndex,
                           int toIndex)

Specifications:

protected normal_behavior
requires 0 <= fromIndex&&fromIndex <= toIndex&&toIndex <= this.size();

{|

requires fromIndex == toIndex;
assignable \nothing;

also

requires fromIndex < toIndex&&toIndex < this.size();
assignable theCollection;
ensures this.theList.equals(\old(this.theList.subsequence(0,fromIndex).concat(this.theList.subsequence(toIndex,this.size()))));

|}