/
Instance.java
45 lines (44 loc) · 1.51 KB
/
Instance.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/*
* JBoss, Home of Professional Open Source
* Copyright 2010 Red Hat Inc. and/or its affiliates and other contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jboss.arquillian.core.api;
/**
* An injectable instance.
* <p>
* All {@link org.jboss.arquillian.core.api.annotation.Inject} annotated fields must have this type or be a subtype
* of it.
* <p>
* <pre>
* {@code @Inject
* private Instance<MyObject> myObjectInst;
*
* public void listen(@Observes OtherEvent otherEvent) {
* // do something..
* myObjectInst.get().performSomeOperation();
* // do something..
* }
* }
* </pre>
* <p>
* Instances are provided using the {@link InstanceProducer#set(Object)} method, they are not automatically detected or
* provided by Arquillian.
*
* @author <a href="mailto:aslak@redhat.com">Aslak Knutsen</a>
* @version $Revision: $
*/
public interface Instance<T> {
T get();
}