org.testifyproject

Interface SutDescriptor

All Superinterfaces:

AnnotationTrait<Field>, FieldAnnotationTrait, FieldTrait, MemberTrait<Field>, PropertiesReader, PropertiesTrait, PropertiesWriter, TypeTrait

public interface SutDescriptor
extends FieldTrait, FieldAnnotationTrait, PropertiesReader, PropertiesWriter

A contract that defines methods to access properties of or perform operations on a system under test (SUT).

Author:

saden

Method Summary

Modifier and Type	Method and Description
Optional<FieldDescriptor>	findFieldDescriptor(Type type) Find the descriptor for a field with the given type on the system under test.
Optional<FieldDescriptor>	findFieldDescriptor(Type type, String name) Find the descriptor for a field with the given type and name on the system under test.
Optional<ParameterDescriptor>	findParameterDescriptor(Type type) Find the descriptor for a constructor parameter with the given type on the system under test.
Optional<ParameterDescriptor>	findParameterDescriptor(Type type, String name) Find the descriptor for a constructor parameter with the given type and name on the system under test.
Constructor	getConstructor() Get the constructor of the system under test class.
Collection<FieldDescriptor>	getFieldDescriptors() Get a list of field descriptors for all the fields associated with the system under test .
Collection<ParameterDescriptor>	getParameterDescriptors() Get a list of parameter descriptors for all the parameters associated with the system under test's constructor.
default Sut	getSut() Get Sut annotation.
Boolean	isSutClass(Type type) Determine if the given type is the same type or super type of the system under test.
default Boolean	isVirtualSut() Determine if the the Sut annotation is a delegated mock.

Methods inherited from interface org.testifyproject.trait.FieldAnnotationTrait

getFake, getFixture, getProperty, getReal, getVirtual, isInjectable, isMock

Methods inherited from interface org.testifyproject.trait.FieldTrait

destroy, getAnnotatedElement, getValue, init, setValue

Methods inherited from interface org.testifyproject.trait.TypeTrait

findMethod, findMethod, getClassLoader, getGenericType, getType, getTypeName, invoke, isSubtypeOf, isSupertypeOf

Methods inherited from interface org.testifyproject.trait.MemberTrait

getDeclaringClass, getDeclaringClassLoader, getDeclaringClassName, getMember, getName

Methods inherited from interface org.testifyproject.trait.AnnotationTrait

getAnnotation, getAnnotations, getMetaAnnotations, hasAnyAnnotations, hasAnyAnnotations

Methods inherited from interface org.testifyproject.trait.PropertiesReader

findCollection, findMap, findProperty, getPropertiesReader, getProperty

Methods inherited from interface org.testifyproject.trait.PropertiesWriter

addCollectionElement, addMapEntry, addProperty, computeIfAbsent

Methods inherited from interface org.testifyproject.trait.PropertiesTrait

getProperties, isEmpty

Method Detail

getSut

default Sut getSut()

Get Sut annotation.

Returns:

sut annotation

getConstructor

Constructor getConstructor()

Get the constructor of the system under test class.

Returns:

system under test constructor.

getFieldDescriptors

Collection<FieldDescriptor> getFieldDescriptors()

Get a list of field descriptors for all the fields associated with the system under test .

Returns:

a list with field descriptor, empty list otherwise

getParameterDescriptors

Collection<ParameterDescriptor> getParameterDescriptors()

Get a list of parameter descriptors for all the parameters associated with the system under test's constructor.

Returns:

a list with parameter descriptor, empty list otherwise

findFieldDescriptor

Optional<FieldDescriptor> findFieldDescriptor(Type type,
                                              String name)

Find the descriptor for a field with the given type and name on the system under test.

Parameters:

type - the field type

name - the field name

Returns:

an optional with a field descriptor, empty optional otherwise

findFieldDescriptor

Optional<FieldDescriptor> findFieldDescriptor(Type type)

Find the descriptor for a field with the given type on the system under test.

Parameters:

type - the field type

Returns:

an optional with a field descriptor, empty optional otherwise

findParameterDescriptor

Optional<ParameterDescriptor> findParameterDescriptor(Type type,
                                                      String name)

Find the descriptor for a constructor parameter with the given type and name on the system under test.

Parameters:

type - the parameter type

name - the parameter name

Returns:

an optional with a parameter descriptor, empty optional otherwise

findParameterDescriptor

Optional<ParameterDescriptor> findParameterDescriptor(Type type)

Find the descriptor for a constructor parameter with the given type on the system under test.

Parameters:

type - the parameter type

Returns:

an optional with a parameter descriptor, empty optional otherwise

isSutClass

Boolean isSutClass(Type type)

Determine if the given type is the same type or super type of the system under test.

Parameters:

type - the type

Returns:

true if type is the same or super type, false otherwise

isVirtualSut

default Boolean isVirtualSut()

Determine if the the Sut annotation is a delegated mock.

Returns:

true if the member is a delegated sut