Interface IObject

All Known Implementing Classes:

ClassImpl, NoOpTestClass

public interface IObject

Represents the associations of a class with one or more instances. Relevant with @Factory annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IObject.IdentifiableArrayObject	A wrapper class that wraps around an array and associates a unique Id that can be used as a key for the array.
static class	IObject.IdentifiableObject	A wrapper object that associates a unique id to every unique test class object.

Method Summary

Modifier and Type	Method	Description
void	addObject(IObject.IdentifiableObject instance)
static Optional<IObject>	cast(Object object)
long[]	getInstanceHashCodes()
IObject.IdentifiableObject[]	getObjects(boolean create, String errorMsgPrefix)	Returns all the instances the methods will be invoked upon.
static long[]	instanceHashCodes(Object object)
static IObject.IdentifiableObject[]	objects(Object object, boolean create)
static IObject.IdentifiableObject[]	objects(Object object, boolean create, String errorMsgPrefix)

Method Details

getObjects

IObject.IdentifiableObject[] getObjects(boolean create,
 String errorMsgPrefix)

Returns all the instances the methods will be invoked upon. This will typically be an array of one object in the absence of a @Factory annotation.

Parameters:

create - - true if objects should be created before returning.

errorMsgPrefix - - Text that should be prefixed to the error message when there are issues. Can be empty.

Returns:

- An array of IObject.IdentifiableObject objects

getInstanceHashCodes

long[] getInstanceHashCodes()

Returns:

- An array representing the hash codes of the corresponding instances.

addObject

void addObject(IObject.IdentifiableObject instance)

Parameters:

instance - - The instance that should be added to the list of instances.

instanceHashCodes

static long[] instanceHashCodes(Object object)

Parameters:

object - - The object that should be inspected for its compatibility with IObject.

Returns:

- An array representing the hash codes of the corresponding instances.

objects

static IObject.IdentifiableObject[] objects(Object object,
 boolean create)

Parameters:

object - - The object that should be inspected for its compatibility with IObject.

create - - true if objects should be created before returning.

Returns:

- An array (can be empty is instance compatibility fails) of IObject.IdentifiableObject objects.

objects

static IObject.IdentifiableObject[] objects(Object object,
 boolean create,
 String errorMsgPrefix)

Parameters:

object - - The object that should be inspected for its compatibility with IObject.

create - - true if objects should be created before returning.

errorMsgPrefix - - Text that should be prefixed to the error message when there are issues. Can be empty.

Returns:

- An array (can be empty is instance compatibility fails) of IObject.IdentifiableObject objects.

cast

static Optional<IObject> cast(Object object)

Parameters:

object - - The object that should be inspected for its compatibility with IObject.

Returns:

- If the incoming object is an instance of IObject then the cast instance is wrapped within Optional else it would be an Optional.empty()