org.jmlspecs.samples.list.list1.node
Class SLNode

java.lang.Object
  org.jmlspecs.samples.list.list1.node.SLNode

Direct Known Subclasses:

DLNode

public class SLNode

extends Object

Class Specifications

public invariant this.entries != null&&this.allButFirst != null&&this.entries.equals(this.allButFirst.insertFront(this.theEntry)); protected represents theEntry <- this.entry_; protected represents nextNode <- this.nextNode_; protected represents entries <- this.allButFirst.insertFront(this.entry_); protected represents allButFirst <- (this.nextNode_ == null) ? new org.jmlspecs.models.JMLObjectSequence() : this.nextNode_.entries;

Specifications inherited from class Object

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

Model Field Summary
JMLObjectSequence	allButFirst
JMLObjectSequence	entries
SLNode	nextNode
Object	theEntry

 

Model fields inherited from class java.lang.Object

_getClass, objectState, theString

 

Ghost Field Summary

 

Ghost fields inherited from class java.lang.Object

objectTimesFinalized, owner

 

Field Summary
protected  Object	entry_
protected  SLNode	nextNode_

 

Constructor Summary
protected	SLNode()
	SLNode(Object ent)
protected	SLNode(Object ent, SLNode nxtNode)

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Method Summary
Object	clone()
Object	getEntry()
SLNode	getNextNode()
void	insertAfter(Object newEntry)
void	removeNextNode()
void	setEntry(Object newEntry)
protected  String	stringOfEntries(SLNode curr)           Returns the string concatentation of all nodes following this node up to and excluding the end of the chain or this, which ever is reached first (i.e. this method will terminate even for circular lists).
String	toString()

 

Methods inherited from class java.lang.Object

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

 

Model Field Detail

entries

public JMLObjectSequence entries

Specifications:
datagroup contains: org.jmlspecs.samples.list.list1.node.DLNode.prevEntries allButFirst theEntry nextNode_.entries nextNode_.theEntry

allButFirst

public JMLObjectSequence allButFirst

Specifications:
is in groups: entries
datagroup contains: nextNode nextNode_.allButFirst nextNode_.nextNode

theEntry

public Object theEntry

Specifications:
is in groups: entries
datagroup contains: entry_

nextNode

public SLNode nextNode

Specifications:
is in groups: allButFirst
datagroup contains: org.jmlspecs.samples.list.list1.node.DLNode.nextDL nextNode_

entry_

protected Object entry_

Specifications:
is in groups: theEntry

nextNode_

protected SLNode nextNode_

Specifications:
is in groups: nextNode
maps nextNode_.entries \into entries, nextNode_.allButFirst \into allButFirst, nextNode_.theEntry \into entries, nextNode_.nextNode \into allButFirst

SLNode

public SLNode(Object ent)

Specifications:

public normal_behavior
assignable entries;
ensures this.theEntry == ent&&this.entries.int_size() == 1&&this.entries.itemAt(0) == ent&&this.allButFirst.isEmpty();

SLNode

protected SLNode()

Specifications:

protected normal_behavior
assignable entries;
ensures this.theEntry == null&&this.entries.int_size() == 1&&this.entries.itemAt(0) == null&&this.allButFirst.isEmpty();

SLNode

protected SLNode(Object ent,
                 SLNode nxtNode)

Specifications:

protected normal_behavior
assignable entries;
ensures this.theEntry == ent&&this.entries.itemAt(0) == ent&&this.nextNode == nxtNode;

getEntry

public Object getEntry()

Specifications: pure

public normal_behavior
assignable \nothing;
ensures \result == this.theEntry;

setEntry

public void setEntry(Object newEntry)

Specifications:

public normal_behavior
assignable theEntry;
ensures this.theEntry == newEntry&&this.entries.itemAt(0) == newEntry;

getNextNode

public SLNode getNextNode()

Specifications: pure

public normal_behavior
assignable \nothing;
ensures \result == this.nextNode;

insertAfter

public void insertAfter(Object newEntry)

Specifications:

public normal_behavior
assignable allButFirst;
ensures this.allButFirst.equals(\old(this.allButFirst).insertFront(newEntry));

removeNextNode

public void removeNextNode()

Specifications:

public normal_behavior
requires !this.allButFirst.isEmpty();
assignable allButFirst;
ensures this.allButFirst.equals(\old(this.allButFirst).trailer());

     also

requires this.allButFirst.isEmpty();
assignable \nothing;
ensures this.allButFirst.isEmpty();

clone

public Object clone()

Overrides:

clone in class Object

Specifications: non_null

     also

public normal_behavior
assignable \nothing;
ensures \result instanceof org.jmlspecs.samples.list.list1.node.SLNode&&((org.jmlspecs.samples.list.list1.node.SLNode)\result ).entries.equals(this.entries);

Specifications inherited from overridden method in class Object:
       non_null

protected normal_behavior
requires this instanceof java.lang.Cloneable;
assignable \nothing;
ensures \result != null;
ensures \typeof(\result ) == \typeof(this);
ensures (* \result is a clone of this *);

     also

protected normal_behavior
requires this.getClass().isArray();
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((java.lang.Object[])\result ).length == ((java.lang.Object[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((java.lang.Object[])this).length; ((java.lang.Object[])\result )[i] == ((java.lang.Object[])this)[i]);

     also

requires this.getClass().isArray();
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures java.lang.reflect.Array.getLength(\result ) == java.lang.reflect.Array.getLength(this);
ensures ( \forall int i; 0 <= i&&i < java.lang.reflect.Array.getLength(this); ( \exists java.lang.Object result_i; result_i == java.lang.reflect.Array.get(\result ,i); (result_i == null&&java.lang.reflect.Array.get(this,i) == null)||(result_i != null&&result_i.equals(java.lang.reflect.Array.get(this,i)))));

     also

protected exceptional_behavior
requires !(this instanceof java.lang.Cloneable);
assignable \nothing;
signals_only java.lang.CloneNotSupportedException;

     also

protected normal_behavior
requires \elemtype(\typeof(this)) <: \type(java.lang.Object);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((java.lang.Object[])\result ).length == ((java.lang.Object[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((java.lang.Object[])this).length; ((java.lang.Object[])\result )[i] == ((java.lang.Object[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(int);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((int[])\result ).length == ((int[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((int[])this).length; ((int[])\result )[i] == ((int[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(byte);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((byte[])\result ).length == ((byte[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((byte[])this).length; ((byte[])\result )[i] == ((byte[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(char);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((char[])\result ).length == ((char[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((char[])this).length; ((char[])\result )[i] == ((char[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(long);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((long[])\result ).length == ((long[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((long[])this).length; ((long[])\result )[i] == ((long[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(short);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((short[])\result ).length == ((short[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((short[])this).length; ((short[])\result )[i] == ((short[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(boolean);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((boolean[])\result ).length == ((boolean[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((boolean[])this).length; ((boolean[])\result )[i] == ((boolean[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(float);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((float[])\result ).length == ((float[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((float[])this).length; (java.lang.Float.isNaN(((float[])\result )[i])&&java.lang.Float.isNaN(((float[])this)[i]))||((float[])\result )[i] == ((float[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(double);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((double[])\result ).length == ((double[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((double[])this).length; (java.lang.Double.isNaN(((double[])\result )[i])&&java.lang.Double.isNaN(((double[])this)[i]))||((double[])\result )[i] == ((double[])this)[i]);

toString

public String toString()

Overrides:

toString in class Object

Specifications: pure non_null

Specifications inherited from overridden method in class Object:
       non_null

public normal_behavior
assignable objectState;
ensures \result != null&&\result .equals(this.theString);
ensures (* \result is a string representation of this object *);

     also

public code normal_behavior
assignable \nothing;
ensures \result != null&&(* \result is the instance's class name, followed by an @, followed by the instance's hashcode in hex *);

     also

public code model_program { ... }

    implies_that

assignable objectState;
ensures \result != null;

stringOfEntries

protected String stringOfEntries(SLNode curr)

Returns the string concatentation of all nodes following this node up to and excluding the end of the chain or this, which ever is reached first (i.e. this method will terminate even for circular lists).

Specifications: pure