(no commit message)
[utils] / support / inject / src / main / java / org / wamblee / inject / Injectable.java
1 /*
2  * Copyright 2005-2010 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.wamblee.inject;
17
18 /**
19  * This abstract base class performs injection at construction. Be sure not to
20  * initialize fields of derived classes to null as these will override the
21  * initializations of this base class.
22  * 
23  * This class uses {@link InjectorBuilder} to obtain an implementation of a
24  * {@link InjectorFactory} to use.
25  * 
26  * @author Erik Brakkee
27  */
28 public abstract class Injectable {
29
30     private final Injector injector = InjectorBuilder.getInjector();
31
32     /**
33      * Inheritance style constructor.
34      */
35     protected Injectable() {
36         inject();
37     }
38
39     /**
40      * Inject references. This can be useful when injection is to be done again
41      * after construction to obtain new references or after zeroing out of the
42      * references.
43      */
44     public void inject() {
45         injector.inject(this);
46     }
47
48     /**
49      * Gets the default injector.
50      * 
51      * @return Injector.
52      */
53     public Injector getInjector() {
54         return injector;
55     }
56 }