Scope (Ibello API 1.21.1 API)

java.lang.Object
- java.lang.Enum<Scope>
- - hu.ibello.inject.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>
```
public enum Scope
extends Enum<Scope>
```
This enum specifies the scope of a dependency injection. During the injection, the injector should decide that it will use a previously created value, of will create a whole new instance. It is allowed to use existing values only from the injection's current scope. If there is no valid value for the injection, a new instance will be created.

These are the scopes:
- PROTOTYPE: if the injected class is in this scope, then every new request will result a new instance.
- TEST: this scope is valid while the current test method runs.
- SPECIFICATION: this scope is valid while the test class (specification) is unchanged.
- SESSION: this scope means a java thread.
- SINGLETON: this scopes will be not invalidated, all instances created in it will be persisted for the whole test execution.
- PAGE: classes marked with this scope should be handled as session-scoped, but after the "normal" injection some other special (page object-related) injections should be performed on them.
- STEPS: classes marked with this scope should be handled as session-scoped, but after the "normal" injection some other special (step library-related) injections should be performed on them.
About the ibello dependency injection system, see hu.ibello.inject.
Author:

Kornél Simon

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ELEMENTS` Marks an element repository class with `Injectable` annotation.
`PAGE` Marks a page object class with `Injectable` annotation.
`PROTOTYPE` Marks a prototype-scoped class with `Injectable` annotation.
`SESSION` Marks a session-scoped class with `Injectable` annotation.
`SINGLETON` Marks a singleton class with `Injectable` annotation.
`SPECIFICATION` Marks a specification-scoped class with `Injectable` annotation.
`STEPS` Marks a step library class with `Injectable` annotation.
`TEST` Marks a test-scoped class with `Injectable` annotation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accepts(Scope childScope)` Checks if this scope accepts the given scope as child.
`static Scope`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static 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
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - PROTOTYPE
```
public static final Scope PROTOTYPE
```
    Marks a prototype-scoped class with Injectable annotation. Prototype scope means that every time when an instance of the marked class needs to be injected, a new instance will be created.
    About the ibello dependency injection system, see hu.ibello.inject.
  - TEST
```
public static final Scope TEST
```
    Marks a test-scoped class with Injectable annotation. Test scope means that during a test method execution the same instance is used. Instances are not shared between test executions.
    About the ibello dependency injection system, see hu.ibello.inject.
  - SPECIFICATION
```
public static final Scope SPECIFICATION
```
    Marks a specification-scoped class with Injectable annotation. Specification scope means that during the execution of a specification (a test class) the same instance is used. Instances are not shared between specification executions.
    About the ibello dependency injection system, see hu.ibello.inject.
  - SESSION
```
public static final Scope SESSION
```
    Marks a session-scoped class with Injectable annotation. Session scope means that during a session (in a single thread) the same instance is used. Instances are not shared between sessions.
    About the ibello dependency injection system, see hu.ibello.inject.
  - SINGLETON
```
public static final Scope SINGLETON
```
    Marks a singleton class with Injectable annotation. Singleton scope means that during the whole test execution the same instance is used.
    About the ibello dependency injection system, see hu.ibello.inject.
  - PAGE
```
public static final Scope PAGE
```
    Marks a page object class with Injectable annotation. The marked class will be in session scope. It means that during a session (in a single thread) the same instance is used. Instances are not shared between sessions. Additionally the class is considered as a page object, and some special injections are performed on every instances.
    About the ibello dependency injection system, see hu.ibello.inject.
  - ELEMENTS
```
public static final Scope ELEMENTS
```
    Marks an element repository class with Injectable annotation. The marked class will be in prototype scope. It means that for each declared usage location of this class a new instance will be created. Additionally the class is considered as an element repository, and some special injections are performed on every instances.
    About the ibello dependency injection system, see hu.ibello.inject.
  - STEPS
```
public static final Scope STEPS
```
    Marks a step library class with Injectable annotation. The marked class will be in session scope. It means that during a session (in a single thread) the same instance is used. Instances are not shared between sessions. Additionally the class is considered as a step library, and some special injections are performed on every instances.
    About the ibello dependency injection system, see hu.ibello.inject.
- Method Detail
  - values
```
public static 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 (Scope c : 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 Scope valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - accepts
```
public boolean accepts(Scope childScope)
```
    Checks if this scope accepts the given scope as child.
    
    Imagine that you have a class marked with Injectable annotation, with the current scope. This class has an injected field. The injected class is also marked with Injectable annotation, but with the given scope. If this method returns false, then the field cannot be injected because it's scope does not fit into this scope.
    
    Example: you cannot inject a test-scoped field into a singleton class, because instance in test scope are valid only during a single test run, while singleton instances are valid for the entire execution.
    
    About the ibello dependency injection system, see hu.ibello.inject.
    
    Parameters:
    
    childScope - the scope which will be verified as child scope
    
    Returns:
    
    true if instances from childScope can be injected into this scope, false if not

Enum Scope

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PROTOTYPE

TEST

SPECIFICATION

SESSION

SINGLETON

PAGE

ELEMENTS

STEPS

Method Detail

values

valueOf

accepts