JML

org.jmlspecs.jmlunit.strategies
Class AbstractExtensibleStrategyDecorator

java.lang.Object
  extended byorg.jmlspecs.jmlunit.strategies.AbstractExtensibleStrategyDecorator
All Implemented Interfaces:
StrategyType
Direct Known Subclasses:
CloneableObjectAbstractExtensibleStrategyDecorator, ImmutableObjectExtensibleStrategyDecorator

public abstract class AbstractExtensibleStrategyDecorator
extends Object
implements StrategyType

A decorator for strategies that allows for easy extension 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 addData() method; this 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
AbstractExtensibleStrategyDecorator(StrategyType strat)
           
 
Model Method Summary
 
Model methods inherited from class java.lang.Object
hashValue
 
Method Summary
protected  Object[] addData()
          Subclasses can override this to make simple extensions to the data used.
protected abstract  StrategyType addedDataStrategy(Object[] added)
           
 IndefiniteIterator iterator()
          Compute a fresh indefinite iterator, which can be used to provide test data of some reference type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

defaultData

private final 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 final 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
Constructor Detail

AbstractExtensibleStrategyDecorator

public AbstractExtensibleStrategyDecorator(StrategyType strat)
Specifications:
public normal_behavior
requires strat != null;
assignable defaultData, addedData, objectState, owner, strat.owner;
ensures this.defaultData == strat;
ensures this.owner == null&&strat.owner == this;
Method Detail

addedDataStrategy

protected abstract StrategyType addedDataStrategy(Object[] added)
Specifications:
protected normal_behavior
requires added != null;
assignable addedData, objectState;
ensures \result != null;

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;

addData

protected Object[] addData()
Subclasses can override this to make simple extensions to the data used. This should only be called once when the object is being construted.

Specifications:
protected normal_behavior
assignable objectState;
ensures \result != null&&this.defaultData == \old(this.defaultData);

JML

JML is Copyright (C) 1998-2002 by Iowa State University and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This release depends on code from the MultiJava project and is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.