org.testifyproject

Interface LocalResourceInstance<R,C>

Type Parameters:

R - the underlying local resource type

C - the underlying local resource client type

All Superinterfaces:

PropertiesReader, PropertiesTrait

public interface LocalResourceInstance<R,C>
extends PropertiesReader

A contract that defines methods to get information about a local resource instance. A local resource instance consists of a resource, an optional client that can be used to communicate with the local resource, and properties associated with the local resource instance.

Author:

saden

See Also:

ResourceProvider

Method Summary

Modifier and Type	Method and Description
Optional<Instance<C>>	getClient() Get the client instance associated with the local resource.
String	getFqn() Get a unique fully qualified name associated with the local resource.
LocalResource	getLocalResource() Get the local resource annotation associated with the local resource instance.
Instance<R>	getResource() Get the underlying local resource instance.

Methods inherited from interface org.testifyproject.trait.PropertiesReader

findCollection, findMap, findProperty, getPropertiesReader, getProperty

Methods inherited from interface org.testifyproject.trait.PropertiesTrait

getProperties, isEmpty

Method Detail

getFqn

String getFqn()

Get a unique fully qualified name associated with the local resource.

Returns:

the local resource's fully qualified name

getLocalResource

LocalResource getLocalResource()

Get the local resource annotation associated with the local resource instance.

Returns:

the local resource annotation

getClient

Optional<Instance<C>> getClient()

Get the client instance associated with the local resource.

Returns:

an optional with client, empty optional otherwise

getResource

Instance<R> getResource()

Get the underlying local resource instance.

Returns:

the underlying local resource