TestDescriptor (Testify API Documentation)

All Superinterfaces:

AnnotationTrait<Class>, PropertiesReader, PropertiesTrait, PropertiesWriter
```
public interface TestDescriptor
extends PropertiesReader, PropertiesWriter, AnnotationTrait<Class>
```
A contract that defines methods used to access or perform operations on a test class.

Author:

saden

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Optional<MethodDescriptor>`	`findCollaboratorProvider(Type returnType)` Find the collaborator provider for the given return type.
`Optional<MethodDescriptor>`	`findCollaboratorProvider(Type returnType, String name)` Find the collaborator provider for the given name and return type.
`Optional<MethodDescriptor>`	`findConfigHandler(Type configurableType)` Find the config handler associated with the test class capable of configuring the given configurable type.
`Optional<FieldDescriptor>`	`findFieldDescriptor(Type type)` Find the descriptor for a field with the given type on the test class.
`Optional<FieldDescriptor>`	`findFieldDescriptor(Type type, String name)` Find the descriptor for a field with the given type and name on the test class.
`Optional<Application>`	`getApplication()` The application annotation associated with the test class.
`Optional<CollaboratorProvider>`	`getCollaboratorProvider()` The collaborator provider annotation associated with the test class.
`Collection<MethodDescriptor>`	`getCollaboratorProviders()` Get a collection of collaborator provider methods associated with the test class.
`Optional<ConfigHandler>`	`getConfigHandler()` The config handler annotation associated with the test class.
`Collection<MethodDescriptor>`	`getConfigHandlers()` Get a collection of method handlers for all the config handlers associated with the test class.
`Collection<FieldDescriptor>`	`getFieldDescriptors()` Get a collection of field descriptors for all the fields associated with the test class.
`Collection<Class<? extends Annotation>>`	`getGuidelines()` Get guideline annotations associated with the test.
`Optional<Hint>`	`getHint()` Get hint annotation associated with the test.
`Collection<Annotation>`	`getInspectedAnnotations()` Get a collection of all known and inspected annotations including those placed on `Bundle` annotation.
`Collection<LocalResource>`	`getLocalResources()` Get a collection of local resources associated with the test class.
`Collection<Module>`	`getModules()` Get a collection of modules associated with the test class.
`Collection<RemoteResource>`	`getRemoteResources()` Get a collection of remote resources associated with the test class.
`Collection<Scan>`	`getScans()` Get a collection of scans associated with the test class.
`Optional<Field>`	`getSutField()` Get the system under test field associated with the test class.
`Class<?>`	`getTestClass()` Get the test class.
`ClassLoader`	`getTestClassLoader()` The class loader associated with the test class.
`String`	`getTestClassName()` The name of the test class.
`Collection<VirtualResource>`	`getVirtualResources()` Get a collection of virtual resources associated with the test class.

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

Methods inherited from interface org.testifyproject.trait.AnnotationTrait
getAnnotatedElement, getAnnotation, getAnnotations, getMetaAnnotations, hasAnyAnnotations, hasAnyAnnotations

- Method Detail
  - getTestClassName
```
String getTestClassName()
```
    The name of the test class.
    
    Returns:
    
    test class name
  - getTestClass
```
Class<?> getTestClass()
```
    Get the test class.
    
    Returns:
    
    the test class
  - getTestClassLoader
```
ClassLoader getTestClassLoader()
```
    The class loader associated with the test class.
    
    Returns:
    
    the test class classloader
  - getCollaboratorProvider
```
Optional<CollaboratorProvider> getCollaboratorProvider()
```
    The collaborator provider annotation associated with the test class.
    
    Returns:
    
    an optional with collaborator provider, empty optional otherwise
  - getCollaboratorProviders
```
Collection<MethodDescriptor> getCollaboratorProviders()
```
    Get a collection of collaborator provider methods associated with the test class.
    
    Returns:
    
    a collection of method descriptor, empty list otherwise
  - getApplication
```
Optional<Application> getApplication()
```
    The application annotation associated with the test class.
    
    Returns:
    
    an optional with application annotation, empty optional otherwise
  - getSutField
```
Optional<Field> getSutField()
```
    Get the system under test field associated with the test class.
    
    Returns:
    
    an optional with sut class field, empty optional otherwise
  - getConfigHandler
```
Optional<ConfigHandler> getConfigHandler()
```
    The config handler annotation associated with the test class.
    
    Returns:
    
    an optional with config handler, empty optional otherwise
  - getConfigHandlers
```
Collection<MethodDescriptor> getConfigHandlers()
```
    Get a collection of method handlers for all the config handlers associated with the test class.
    
    Returns:
    
    a collection with method descriptors, empty list otherwise
  - getFieldDescriptors
```
Collection<FieldDescriptor> getFieldDescriptors()
```
    Get a collection of field descriptors for all the fields associated with the test class.
    
    Returns:
    
    a collection with field descriptor, empty list otherwise
  - getModules
```
Collection<Module> getModules()
```
    Get a collection of modules associated with the test class.
    
    Returns:
    
    a collection with modules, empty list otherwise
  - getScans
```
Collection<Scan> getScans()
```
    Get a collection of scans associated with the test class.
    
    Returns:
    
    a collection with scans, empty list otherwise
  - getLocalResources
```
Collection<LocalResource> getLocalResources()
```
    Get a collection of local resources associated with the test class.
    
    Returns:
    
    a collection with local resources, empty list otherwise
  - getVirtualResources
```
Collection<VirtualResource> getVirtualResources()
```
    Get a collection of virtual resources associated with the test class.
    
    Returns:
    
    a collection with virtual resources, empty list otherwise
  - getRemoteResources
```
Collection<RemoteResource> getRemoteResources()
```
    Get a collection of remote resources associated with the test class.
    
    Returns:
    
    a collection with remote resources, empty list otherwise
  - getInspectedAnnotations
```
Collection<Annotation> getInspectedAnnotations()
```
    Get a collection of all known and inspected annotations including those placed on Bundle annotation.
    
    Returns:
    
    a collection of inspected annotations, empty list otherwise
  - getGuidelines
```
Collection<Class<? extends Annotation>> getGuidelines()
```
    Get guideline annotations associated with the test.
    
    Returns:
    
    a collection of guidelines, empty array otherwise
  - getHint
```
Optional<Hint> getHint()
```
    Get hint annotation associated with the test.
    
    Returns:
    
    the hint annotation, empty optional otherwise
  - findConfigHandler
```
Optional<MethodDescriptor> findConfigHandler(Type configurableType)
```
    Find the config handler associated with the test class capable of configuring the given configurable type.
    
    Parameters:
    
    configurableType - the configurable type
    
    Returns:
    
    an optional with method descriptor, empty optional otherwise
  - findCollaboratorProvider
```
Optional<MethodDescriptor> findCollaboratorProvider(Type returnType)
```
    Find the collaborator provider for the given return type.
    
    Parameters:
    
    returnType - the return type
    
    Returns:
    
    an optional with method descriptor, empty optional otherwise
  - findCollaboratorProvider
```
Optional<MethodDescriptor> findCollaboratorProvider(Type returnType,
                                                    String name)
```
    Find the collaborator provider for the given name and return type.
    
    Parameters:
    
    returnType - the return type
    
    name - the name associated with the collaborator provider method
    
    Returns:
    
    an optional with method descriptor, empty optional otherwise
  - findFieldDescriptor
```
Optional<FieldDescriptor> findFieldDescriptor(Type type,
                                              String name)
```
    Find the descriptor for a field with the given type and name on the test class.
    
    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 test class.
    
    Parameters:
    
    type - the field type
    
    Returns:
    
    an optional with a field descriptor, empty optional otherwise

Interface TestDescriptor

Method Summary

Methods inherited from interface org.testifyproject.trait.PropertiesReader

Methods inherited from interface org.testifyproject.trait.PropertiesWriter

Methods inherited from interface org.testifyproject.trait.PropertiesTrait

Methods inherited from interface org.testifyproject.trait.AnnotationTrait

Method Detail

getTestClassName

getTestClass

getTestClassLoader

getCollaboratorProvider

getCollaboratorProviders

getApplication

getSutField

getConfigHandler

getConfigHandlers

getFieldDescriptors

getModules

getScans

getLocalResources

getVirtualResources

getRemoteResources

getInspectedAnnotations

getGuidelines

getHint

findConfigHandler

findCollaboratorProvider

findCollaboratorProvider

findFieldDescriptor

findFieldDescriptor