org.jmlspecs.jmlunit.strategies
Class CharExtensibleStrategyDecorator

java.lang.Object
  org.jmlspecs.jmlunit.strategies.CharAbstractStrategy
      org.jmlspecs.jmlunit.strategies.CharExtensibleStrategyDecorator

All Implemented Interfaces:

CharStrategyType, StrategyType

Direct Known Subclasses:

CharBigStrategy

public class CharExtensibleStrategyDecorator

extends CharAbstractStrategy

A decorator for strategies (which provide test data of type type char) 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  CharStrategyType	addedData           The added data, returned after the default data in the iterations.
[spec_public] private  CharStrategyType	defaultData           The default data, returned first in the iterations.

 

Constructor Summary

CharExtensibleStrategyDecorator(non_null CharStrategyType strat)

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Method Summary
protected  char[]	addData()           Subclasses can override this to make simple extensions to the data used.
CharIterator	charIterator()           Compute a fresh CharIterator, which can be used to provide test data of type char.

 

Methods inherited from class org.jmlspecs.jmlunit.strategies.CharAbstractStrategy

iterator

 

Methods inherited from class java.lang.Object

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

 

Field Detail

defaultData

private CharStrategyType 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 CharStrategyType 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

CharExtensibleStrategyDecorator

public CharExtensibleStrategyDecorator(non_null CharStrategyType strat)

Specifications:

public normal_behavior
assignable objectState, defaultData, addedData, owner, strat.owner;
ensures this.defaultData == strat;

charIterator

public CharIterator charIterator()

Description copied from interface: CharStrategyType

Compute a fresh CharIterator, which can be used to provide test data of type char. The CharIterator 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).

Specifications: non_null

Specifications inherited from overridden method in interface CharStrategyType:

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

addData

protected char[] addData()

Subclasses can override this to make simple extensions to the data used. This should only be called once when the object is being constructed.

Specifications:

protected normal_behavior
assignable objectState;
ensures \result != null;