Shared.Scope

java.lang.Object
- java.lang.Enum<Shared.Scope>
- - org.junitpioneer.jupiter.resource.Shared.Scope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Shared.Scope>

Enclosing class:

Shared
```
public static enum Shared.Scope
extends java.lang.Enum<Shared.Scope>
```
Scope specifies how long a shared resource lives.
It is part of the "resources" JUnit Jupiter extension, which pertains to anything that needs to be injected into tests and which may need to be started up or torn down. Temporary directories are a common example.
For more details and examples, see the documentation on resources.

Since:

1.9.0

See Also:

Resource, ResourceFactory, Shared

Enum Constant Summary

Enum Constants
Enum Constant	Description
`GLOBAL`	At this scope, a shared resource will last as long as the entire test suite.
`SOURCE_FILE`	At this scope, a shared resource will last as long as the test file it is defined in.

Constructor Summary

Constructors
Modifier Constructor Description

private Scope()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Shared.Scope`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Shared.Scope[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - GLOBAL
```
public static final Shared.Scope GLOBAL
```
    At this scope, a shared resource will last as long as the entire test suite.
  - SOURCE_FILE
```
public static final Shared.Scope SOURCE_FILE
```
    At this scope, a shared resource will last as long as the test file it is defined in.
- Constructor Detail
  - Scope
```
private Scope()
```
- Method Detail
  - values
```
public static Shared.Scope[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (Shared.Scope c : Shared.Scope.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Shared.Scope valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null