jdave
Class Specification<T>

java.lang.Object
  jdave.ContainmentSupport
      jdave.mock.MockSupport
          jdave.Specification<T>

public abstract class Specification<T>
extends MockSupport

Author:

Joni Freeman, Pekka Enberg

Field Summary

T	be
T	context
protected Specification<T>	does
protected Specification<T>	must
protected Specification<T>	should

Constructor Summary

Specification()

Method Summary

protected void	addListener(ILifecycleListener listener) Add a ILifecycleListener listener to specification.
void	create() Create this specification.
void	destroy() Destroy this specification.
IEqualityCheck	equal(long expected)
IEqualityCheck	equal(Number expectedNumber, double delta)
IEqualityCheck	equal(Object obj)
IEqualityCheck	equal(String obj)
void	fail(String message) Fail with a message.
void	fireAfterContextCreation(Object contextInstance, Object createdContext)
void	fireAfterContextDestroy(Object contextInstance)
void	fireAfterContextInstantiation(Object contextInstance)
IContextObjectFactory<T>	getContextObjectFactory()
IEqualityCheck	isNotNull()
MapContainment	maps(Object... keys)
boolean	needsThreadLocalIsolation() Returns true if thread local isolation is needed for this specification.
Not<T>	not()
<E extends Throwable> ExpectedException<E>	raise(Class<E> expected)
<E extends Throwable> ExpectedException<E>	raise(Class<E> expectedType, String expectedMessage)
<E extends Throwable> ExpectedException<E>	raiseExactly(Class<E> expected)
<E extends Throwable> ExpectedException<E>	raiseExactly(Class<E> expected, String expectedMessage)
IContract	satisfies(IContract contract)
protected void	setContextObjectFactory(IContextObjectFactory<T> contextObjectFactory)
static void	setStringComparisonFailure(IStringComparisonFailure failure)
<V extends Throwable> void	specify(Block block, ExpectedException<V> expectation) The given block is expected to throw an exception.
<V extends Throwable> void	specify(Block block, ExpectedNoThrow<V> expectation) The given block is expected to not throw an exception.
void	specify(boolean expected)
<E> void	specify(boolean[] actual, IContainment<E> containment)
<E> void	specify(byte[] actual, IContainment<E> containment)
<E> void	specify(char[] actual, IContainment<E> containment)
<E> void	specify(Collection<E> actual, IContainment<E> containment)
<E> void	specify(Collection<E> actual, jdave.Where<E> where) Matches all the actual objects using Hamcrest Matcher.
<E> void	specify(double[] actual, IContainment<E> containment)
<E> void	specify(float[] actual, IContainment<E> containment)
<E> void	specify(int[] actual, IContainment<E> containment)
<E> void	specify(Iterable<E> actual, jdave.Where<E> where)
<E> void	specify(Iterator<E> actual, IContainment<E> containment)
<E> void	specify(Iterator<E> actual, jdave.Where<E> where)
<E> void	specify(long[] actual, IContainment<E> containment)
void	specify(Map<?,?> actual, MapContainment containment)
<E> void	specify(Object[] actual, IContainment<E> containment)
<E> void	specify(Object[] actual, jdave.Where<E> where)
void	specify(Object obj, IContract contract)
void	specify(Object actual, IEqualityCheck equalityCheck)
void	specify(Object actual, org.hamcrest.Matcher<?> matcher) Matches the actual object using Hamcrest Matcher.
void	specify(Object actual, Object expected)
<E> void	specify(short[] actual, IContainment<E> containment)
void	specify(T actual, boolean expected)
void	specify(T actual, Boolean expected)
<E> jdave.Where<E>	where(Each<E> each)

Methods inherited from class jdave.mock.MockSupport

checking, dummy, dummy, mock, mock, mockery, sequence, setDefaultResultForType, states, verifyMocks

Methods inherited from class jdave.ContainmentSupport

contain, containAll, containAll, containAll, containAll, containAll, containAll, containAll, containAll, containAll, containAll, containAny, containAny, containAny, containAny, containAny, containAny, containAny, containAny, containAny, containAny, containExactly, containExactly, containExactly, containExactly, containExactly, containExactly, containExactly, containExactly, containExactly, containExactly, containInOrder, containInOrder, containInOrder, containInOrder, containInOrder, containInOrder, containInOrder, containInOrder, containInOrder, containInOrder, containInPartialOrder, containInPartialOrder, containInPartialOrder, containInPartialOrder, containInPartialOrder, containInPartialOrder, containInPartialOrder, containInPartialOrder, containInPartialOrder, containInPartialOrder, contains, containsAll, containsAll, containsAll, containsAll, containsAll, containsAll, containsAll, containsAll, containsAll, containsAll, containsAny, containsAny, containsAny, containsAny, containsAny, containsAny, containsAny, containsAny, containsAny, containsAny, containsExactly, containsExactly, containsExactly, containsExactly, containsExactly, containsExactly, containsExactly, containsExactly, containsExactly, containsExactly, containsInOrder, containsInOrder, containsInOrder, containsInOrder, containsInOrder, containsInOrder, containsInOrder, containsInOrder, containsInOrder, containsInOrder, containsInPartialOrder, containsInPartialOrder, containsInPartialOrder, containsInPartialOrder, containsInPartialOrder, containsInPartialOrder, containsInPartialOrder, containsInPartialOrder, containsInPartialOrder, containsInPartialOrder, newAllContainment, newAllContainment, newAllContainment, newAnyContainment, newAnyContainment, newAnyContainment, newExactContainment, newExactContainment, newExactContainment, newInOrderContainment, newInOrderContainment, newInOrderContainment, newInPartialOrderContainment, newInPartialOrderContainment, newInPartialOrderContainment, newObjectContainment

Methods inherited from class java.lang.Object

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

Field Detail

should

protected Specification<T> should

does

protected Specification<T> does

must

protected Specification<T> must

be

public T be

context

public T context

Constructor Detail

Specification

public Specification()

Method Detail

not

public Not<T> not()

specify

public void specify(boolean expected)

specify

public void specify(T actual,
                    boolean expected)

specify

public void specify(T actual,
                    Boolean expected)

specify

public <E> void specify(Iterator<E> actual,
                        IContainment<E> containment)

specify

public <E> void specify(Collection<E> actual,
                        IContainment<E> containment)

specify

public <E> void specify(Object[] actual,
                        IContainment<E> containment)

specify

public <E> void specify(boolean[] actual,
                        IContainment<E> containment)

specify

public <E> void specify(byte[] actual,
                        IContainment<E> containment)

specify

public <E> void specify(char[] actual,
                        IContainment<E> containment)

specify

public <E> void specify(double[] actual,
                        IContainment<E> containment)

specify

public <E> void specify(float[] actual,
                        IContainment<E> containment)

specify

public <E> void specify(int[] actual,
                        IContainment<E> containment)

specify

public <E> void specify(long[] actual,
                        IContainment<E> containment)

specify

public <E> void specify(short[] actual,
                        IContainment<E> containment)

specify

public void specify(Object actual,
                    Object expected)

specify

public void specify(Object actual,
                    IEqualityCheck equalityCheck)

specify

public void specify(Object actual,
                    org.hamcrest.Matcher<?> matcher)

Matches the actual object using Hamcrest Matcher.

Hamcrest provides a library of matcher objects allowing 'match' rules to be defined declaratively.

 <code>
 import static org.hamcrest.Matchers.*;
 public class HamcrestSampleSpec extends Specification<Person> {
     public class SampleContext {
         public void sample() {
             specify(person.getAge(), greaterThan(30));
         }
     }
 }
 </code>
 

See Hamcrest home page

specify

public <E> void specify(Collection<E> actual,
                        jdave.Where<E> where)

Matches all the actual objects using Hamcrest Matcher.

Hamcrest provides a library of matcher objects allowing 'match' rules to be defined declaratively.

 <code>
 import static org.hamcrest.Matchers.*;
 public class HamcrestSampleSpec extends Specification<Person> {
     public class SampleContext {
         public void sample() {
             specify(persons, where(new Each<Person>() {{ matches(item.getAge(), is(greaterThan(30))); }}));
         }
     }
 }
 </code>
 

See Hamcrest home page

specify

public <E> void specify(Iterable<E> actual,
                        jdave.Where<E> where)

See Also:

specify(Collection, Where)

specify

public <E> void specify(Object[] actual,
                        jdave.Where<E> where)

See Also:

specify(Collection, Where)

specify

public <E> void specify(Iterator<E> actual,
                        jdave.Where<E> where)

See Also:

specify(Collection, Where)

where

public <E> jdave.Where<E> where(Each<E> each)

specify

public <V extends Throwable> void specify(Block block,
                                          ExpectedException<V> expectation)

The given block is expected to throw an exception.

There's two variants for setting exception expectations.

 <code>
 specify(new Block() { ... }, should.raise(SomeException.class);
 specify(new Block() { ... }, should.raiseExactly(SomeException.class);
 </code>
 

The first one accepts the given exception or any of its subclasses, the second one expects an exact exception type. Both can additionally be checked against expected exception message:

 <code>
 specify(new Block() { ... }, should.raise(SomeException.class, "expected message");
 specify(new Block() { ... }, should.raiseExactly(SomeException.class, "expected message");
 </code>
 

specify

public <V extends Throwable> void specify(Block block,
                                          ExpectedNoThrow<V> expectation)
             throws Throwable

The given block is expected to not throw an exception.

There's two variants for setting exception expectations.

 <code>
 specify(new Block() { ... }, should.not().raise(SomeException.class);
 specify(new Block() { ... }, should.not().raiseExactly(SomeException.class);
 </code>
 

The first one expects that the given block does not throw the exception or any of its subclasses, the second one expects that the given block does not throw the given exact exception type.

Throws:

Throwable

specify

public void specify(Object obj,
                    IContract contract)

equal

public IEqualityCheck equal(long expected)

equal

public IEqualityCheck equal(String obj)

equal

public IEqualityCheck equal(Object obj)

equal

public IEqualityCheck equal(Number expectedNumber,
                            double delta)

raise

public <E extends Throwable> ExpectedException<E> raise(Class<E> expected)

See Also:

specify(Block, ExpectedException), specify(Block, ExpectedNoThrow)

raise

public <E extends Throwable> ExpectedException<E> raise(Class<E> expectedType,
                                                        String expectedMessage)

See Also:

specify(Block, ExpectedException), specify(Block, ExpectedNoThrow)

raiseExactly

public <E extends Throwable> ExpectedException<E> raiseExactly(Class<E> expected)

See Also:

specify(Block, ExpectedException), specify(Block, ExpectedNoThrow)

raiseExactly

public <E extends Throwable> ExpectedException<E> raiseExactly(Class<E> expected,
                                                               String expectedMessage)

See Also:

specify(Block, ExpectedException), specify(Block, ExpectedNoThrow)

satisfies

public IContract satisfies(IContract contract)

create

public void create()
            throws Exception

Create this specification.

This method is called before the create method of the executed context has been called. Override this method to add common initialization code for contexts within a specification.

Throws:

Exception

destroy

public void destroy()
             throws Exception

Destroy this specification.

This method is called after the optional destroy method of the excuted context has been called. Override this method to add common destroy code for contexts within a specification.

Throws:

Exception

needsThreadLocalIsolation

public boolean needsThreadLocalIsolation()

Returns true if thread local isolation is needed for this specification.

Some contexts set thread local variables. This may cause following behaviors to fail if they depend on initial thread local state. Thread locals can be isolated for all behavior methods of current specification by overiding this method and returning true. Then a new fresh thread is created for all methods in the specification.

Returns:

true if thread local isolation is needed for this specification. The default is false.

setContextObjectFactory

protected void setContextObjectFactory(IContextObjectFactory<T> contextObjectFactory)

getContextObjectFactory

public IContextObjectFactory<T> getContextObjectFactory()

addListener

protected void addListener(ILifecycleListener listener)

Add a ILifecycleListener listener to specification.

ILifecycleListener will be notified when contexts are instantiated and context objects are created and destroyed.

Parameters:

listener - a listener to get lifecycle event notifications

fireAfterContextInstantiation

public void fireAfterContextInstantiation(Object contextInstance)

fireAfterContextCreation

public void fireAfterContextCreation(Object contextInstance,
                                     Object createdContext)

fireAfterContextDestroy

public void fireAfterContextDestroy(Object contextInstance)

isNotNull

public IEqualityCheck isNotNull()

setStringComparisonFailure

public static void setStringComparisonFailure(IStringComparisonFailure failure)

maps

public MapContainment maps(Object... keys)

specify

public void specify(Map<?,?> actual,
                    MapContainment containment)

fail

public void fail(String message)

Fail with a message.

Parameters:

message - a message printed to the console