io.micronaut.testresources.core

Class Scope

java.lang.Object

io.micronaut.testresources.core.Scope

public final class Scope
extends java.lang.Object

A scope represents the lifecycle of a test resource. The root scope is handled by the test resources provider, and lives as long as the provider is alive, or that it is explicitly closed. The scope property is always implicitly requested.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_KEY The property name, for when the scope is passed as a property string.
static Scope	ROOT The default scope.

Method Summary

Modifier and Type	Method and Description
Scope	child(java.lang.String id) Creates a child scope with the given id.
boolean	equals(java.lang.Object o)
static Scope	from(java.util.Map<java.lang.String,java.lang.Object> properties) Returns the scope id if found in the supplied properties.
int	hashCode()
boolean	includes(Scope scope) Determines if this scope is the supplied scope, or the parent of the supplied scope.
static Scope	of(java.lang.String id) Returns a new scope with the given id.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ROOT

public static final Scope ROOT

The default scope.

PROPERTY_KEY

public static final java.lang.String PROPERTY_KEY

The property name, for when the scope is passed as a property string.

See Also:

Constant Field Values

Method Detail

from

public static Scope from(java.util.Map<java.lang.String,java.lang.Object> properties)

Returns the scope id if found in the supplied properties.

Parameters:

properties - the properties where to look for the scope

Returns:

the scope

child

public Scope child(java.lang.String id)

Creates a child scope with the given id.

Parameters:

id - the child id

Returns:

the child scope

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

includes

public boolean includes(Scope scope)

Determines if this scope is the supplied scope, or the parent of the supplied scope.

Parameters:

scope - the scope to check

Returns:

true if this scope includes the supplied scope

of

public static Scope of(java.lang.String id)

Returns a new scope with the given id.

Parameters:

id - the scope id

Returns:

the scope