Expectamundo (eXpectamundo 0.9.9 API)

java.lang.Object
- org.exparity.expectamundo.Expectamundo

public class Expectamundo
extends Object

Expectamundo is a test library for preparing a prototype instance of a non-final type containing expected values against which actual instances can be verified against. For example:

To verifying object properties

 Person expected = Expectamundo.prototype(Person.class);
 Expectamundo.expect(expected.getFirstName()).isEqualTo("Jane");
 Expectamundo.expect(expected.getLastName()).isEqualTo("Doe");
 Expectamundo.expectThat(new Person("Jane","Doe")).matches(expected));

To verifying list properties

 Person expected = Expectamundo.prototype(Person.class);
 Expectamundo.expect(expected.getSiblings().get(0).getFirstName()).isEqualTo("John");
 Expectamundo.expect(expected.getSiblings().get(0).getLastName()).isEqualTo("Doe");
 
 Person jane = new Person("Jane","Doe");
 jane.addSibling(new Person("John","Doe"));
 
 Expectamundo.expectThat(jane).matches(expected));

To verifying map properties

 Person expected = Expectamundo.prototype(Person.class);
 Expectamundo.expect(expected.getSiblingMap().get("John").getFirstName()).isEqualTo("John");
 Expectamundo.expect(expected.getSiblingMap().get("John").getLastName()).isEqualTo("Doe");
 
 Person jane = new Person("Jane","Doe");
 jane.addSibling(new Person("John","Doe"));
 
 Expectamundo.expectThat(jane).matches(expected));

Author:: Stewart Bissett

Constructor Summary

Constructors
Constructor and Description

Expectamundo()

Constructors
Constructor and Description
`Expectamundo()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <V,T extends V> T`	`cast(V value, Class<T> type)` Cast a polymorphic return type to the expected subtype whilst setting an expectation.
`static <T> PrototypeChecker<T>`	`checkThat(T actual)` Check the actual value matches the expectation set up in the prototype.
`static PrototypeDateExpectation`	`expect(Date property)` Setup an expectation for a date property on a `Prototype`.
`static PrototypeStringExpectation`	`expect(String property)` Setup an expectation for a string property on a `Prototype`.
`static <E,T extends Collection<E>> PrototypeCollectionExpectation<E,T>`	`expect(T property)` Setup an expectation for a collection property on a `Prototype`.
`static <T> PrototypeObjectExpectation<T>`	`expect(T property)` Setup an expectation for a object property on a `Prototype`.
`static <T extends Comparable<T>> PrototypeComparableExpectation<T>`	`expect(T property)` Setup an expectation for a `Comparable` property on a `Prototype`.
`static <T> PrototypeArrayExpectation<T>`	`expect(T[] property)` Setup an expectation for a array property on a `Prototype`.
`static <T> PrototypeVerifier<T>`	`expectThat(T actual)` Verify the actual value matches the expectation set up in the prototype and throws and AssertionError if the match fails.
`static boolean`	`isPrototype(Object obj)`
`static <T> org.hamcrest.Matcher<T>`	`matcherFor(T expected)` Return a hamcrest `Matcher` instance to support asserting the contents of an actual instance match the expected.
`static <T> T`	`prototype(Class<T> type)` Create a new prototype instance against which expectations can be set.
`static <T> T`	`prototype(TypeReference<T> typeRef)` Create a new prototype instance against a generic type against which expectations can be set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Expectamundo
```
public Expectamundo()
```
- Method Detail
  - prototype
```
public static <T> T prototype(Class<T> type)
```
    Create a new prototype instance against which expectations can be set. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 
```
    Type Parameters:
    
    T - The type of the instance to create.
    
    Parameters:
    
    type - The class of type of the prototype to create.
    
    Returns:
    
    A new instance of the type against which expectations can be set
  - prototype
```
public static <T> T prototype(TypeReference<T> typeRef)
```
    Create a new prototype instance against a generic type against which expectations can be set. For example
```
 List<String> expected = Expectamundo.prototype(new TypeReference<List<String>>(){})
 
```
    Type Parameters:
    
    T - The class of the prototype to create
    
    Parameters:
    
    typeRef - An instance of a TypeReference parameterized with the type to prototype
    
    Returns:
    
    A new instance of the type against which expectations can be set
  - expect
```
public static <E,T extends Collection<E>> PrototypeCollectionExpectation<E,T> expect(T property)
```
    Setup an expectation for a collection property on a Prototype. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(expected.getSiblings()).isEmpty();
 Expectamundo.expectThat(new Person()).matches(expected);
 
```
    Type Parameters:
    
    T - the type of the collection
    
    E - the type of elements in this collection
    
    Parameters:
    
    property - the value to set the expectation for.
    
    Returns:
    
    A instance of a PrototypeCollectionExpectation to set collection expectations for the property
  - expect
```
public static <T extends Comparable<T>> PrototypeComparableExpectation<T> expect(T property)
```
    Setup an expectation for a Comparable property on a Prototype. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(expected.getAge()).isComparableTo(29);
 Expectamundo.expectThat(new Person()).matches(expected);
 
```
    Type Parameters:
    
    T - the type of the property
    
    Parameters:
    
    property - the value to set the expectation for.
    
    Returns:
    
    A instance of a PrototypeComparableExpectation to set comparable expectations for the property
  - expect
```
public static <T> PrototypeArrayExpectation<T> expect(T[] property)
```
    Setup an expectation for a array property on a Prototype. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(expected.getSiblings()).isEmpty();
 Expectamundo.expectThat(new Person()).matches(expected);
 
```
    Type Parameters:
    
    T - the type of the array
    
    Parameters:
    
    property - the value to set the expectation for.
    
    Returns:
    
    A instance of a PrototypeArrayExpectation to set array expectations for the property
  - expect
```
public static PrototypeStringExpectation expect(String property)
```
    Setup an expectation for a string property on a Prototype. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(expected.getSurname()).hasPattern("Sm.*");
 Expectamundo.expectThat(new Person()).matches(expected);
 
```
    Parameters:
    
    property - the value to set the expectation for.
    
    Returns:
    
    A instance of a PrototypeStringExpectation to set String expectations for the property
  - expect
```
public static PrototypeDateExpectation expect(Date property)
```
    Setup an expectation for a date property on a Prototype. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(expected.getSurname()).hasPattern("Sm.*");
 Expectamundo.expectThat(new Person()).matches(expected);
 
```
    Parameters:
    
    property - the value to set the expectation for.
    
    Returns:
    
    A instance of a PrototypeDateExpectation to set date expectations for the property
  - expect
```
public static <T> PrototypeObjectExpectation<T> expect(T property)
```
    Setup an expectation for a object property on a Prototype. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(expected.getSurname()).isEqualTo("Smith");
 Expectamundo.expectThat(new Person()).matches(expected);
 
```
    Parameters:
    
    property - the value to set the expectation for.
    
    Returns:
    
    A instance of a PrototypeObjectExpectation to set object expectations for the property
  - expectThat
```
public static <T> PrototypeVerifier<T> expectThat(T actual)
```
    Verify the actual value matches the expectation set up in the prototype and throws and AssertionError if the match fails. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(expected.getSurname()).isEqualTo("Smith");
 Expectamundo.expectThat(new Person()).matches(expected);
 
```
    Parameters:
    
    actual - the actual instance to test
    
    Returns:
    
    A instance of a PrototypeVerifier to allow the expectation to be supplied
  - checkThat
```
public static <T> PrototypeChecker<T> checkThat(T actual)
```
    Check the actual value matches the expectation set up in the prototype. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(expected.getSurname()).isEqualTo("Smith");
 Expectamundo.checkThat(new Person()).matches(expected);
 
```
    Parameters:
    
    actual - the actual instance to test
    
    Returns:
    
    A instance of a PrototypeChecker to allow the expectation to be supplied
  - cast
```
public static <V,T extends V> T cast(V value,
                                     Class<T> type)
```
    Cast a polymorphic return type to the expected subtype whilst setting an expectation. For example
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(Expectamundo.cast(expected.getProfession(), Doctor.class).getQualifications()).isNotEmpty())
 Expectamundo.expectThat(new Person()).matches(expected);
 
```
    Type Parameters:
    
    V - the value type
    
    T - the expected type of the value
    
    Parameters:
    
    value - the property value.
    
    type - the Class of the property value to cast to.
  - matcherFor
```
public static <T> org.hamcrest.Matcher<T> matcherFor(T expected)
```
    Return a hamcrest Matcher instance to support asserting the contents of an actual instance match the expected.
```
 Person expected = Expectamundo.prototype(Person.class)
 Expectamundo.expect(expected.getSurname()).isEqualTo("Smith")
 MatcherAssert.assertThat(new Person(), Expectamundo.matches(expected))
 
```
    Type Parameters:
    
    T - The type of the prototype
    
    Parameters:
    
    expected - The prototype with expectations defined against it
    
    Returns:
    
    A hamcrest Matcher for the prototype which can be used to assert the contents of a test object
  - isPrototype
```
public static boolean isPrototype(Object obj)
```

Class Expectamundo

To verifying object properties

To verifying list properties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Expectamundo

Method Detail

prototype

prototype

expect

expect

expect

expect

expect

expect

expectThat

checkThat

cast

matcherFor

isPrototype