(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
20 /**
21  * This abstract base class performs injection at construction. Be sure not to
22  * initialize fields of derived classes to null as these will override the
23  * initializations of this base class.
24  * 
25  * This class uses {@link InjectorBuilder} to obtain an implementation of 
26  * a {@link InjectorFactory} to use. 
27  * 
28  * @author Erik Brakkee
29  */
30 public abstract class Injectable {
31
32     private final Injector injector = 
33         InjectorBuilder.getInjector();
34
35     /**
36      * Inheritance style constructor.
37      */
38     protected Injectable() {
39         inject();
40     }
41
42
43     /**
44      * Inject references. This can be useful when injection is to be done again after construction
45      * to obtain new references or after zeroing out of the references. 
46      */
47     public void inject() {
48         injector.inject(this);
49     }    
50    
51     
52     /**
53      * Gets the default injector.
54      * @return Injector. 
55      */
56     public Injector getInjector() {
57         return injector;
58     }
59 }