org.jmlspecs.jmlunit.strategies
Class NewObjectAbstractExtensibleStrategyDecorator

java.lang.Object
  org.jmlspecs.jmlunit.strategies.NewObjectAbstractExtensibleStrategyDecorator

All Implemented Interfaces:

StrategyType

Direct Known Subclasses:

CollectionStrategy, JMLCollectionStrategy, ObjectStrategy

public abstract class NewObjectAbstractExtensibleStrategyDecorator

extends Object

implements StrategyType

A decorator for strategies that allows for easy extension in the "new object" style to the test data of the underlying strategy.

This type provides an extension mechanism that is easier to use than a composite. To extend the test data, make a subclass that overrides the make(int) method; that method provides the additional data for testing.

Author:

Gary T. Leavens

Class Specifications

Specifications inherited from class Object

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

Model Field Summary

 

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
[spec_public] private  StrategyType	addedData           The added data, returned after the default data in the iterations.
[spec_public] private  StrategyType	defaultData           The default data, returned first in the iterations.

 

Constructor Summary

NewObjectAbstractExtensibleStrategyDecorator(StrategyType strat)

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Method Summary
IndefiniteIterator	iterator()           Compute a fresh indefinite iterator, which can be used to provide test data of some reference type.
protected  Object	make(int n)           Return the nth test data item.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

defaultData

private StrategyType defaultData

The default data, returned first in the iterations.

Specifications: spec_public non_null
is in groups: objectState
maps defaultData.objectState \into objectState

addedData

private StrategyType addedData

The added data, returned after the default data in the iterations.

Specifications: spec_public non_null
is in groups: objectState
maps addedData.objectState \into objectState

NewObjectAbstractExtensibleStrategyDecorator

public NewObjectAbstractExtensibleStrategyDecorator(StrategyType strat)

Specifications:

public normal_behavior
requires strat != null;
assignable defaultData, addedData, objectState;
ensures this.defaultData == strat;

make

protected Object make(int n)

Return the nth test data item. The default implementation of this method provides no data. To provide additional test data, you should override this method, without making a super call to it.

Specifications:

protected behavior
requires 0 <= n;
assignable objectState;
signals_only java.util.NoSuchElementException;

iterator

public IndefiniteIterator iterator()

Description copied from interface: StrategyType

Compute a fresh indefinite iterator, which can be used to provide test data of some reference type. The indefinite iterator returned should be freshly created. Usually it should not be at its end. However, in rare cases it might make sense to have an empty iterator be computed (e.g., by filtering).

Specified by:

iterator in interface StrategyType

Specifications: non_null

Specifications inherited from overridden method in interface StrategyType:
       non_null

assignable objectState;
ensures \fresh(\result );
ensures_redundantly \result != null;