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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*
* Sonar, open source software quality management tool.
* Copyright (C) 2008-2012 SonarSource
* mailto:contact AT sonarsource DOT com
*
* Sonar is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* Sonar is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sonar; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
package org.sonar.batch.bootstrap;
import org.picocontainer.ComponentAdapter;
import org.sonar.api.platform.ComponentContainer;
import org.sonar.api.platform.PluginMetadata;
import java.util.List;
/**
* Module describes group of components - {@link #configure()}.
* Several modules can be grouped together - {@link #install(Module)}, {@link #installChild(Module)}.
* <p/>
*/
public abstract class Module {
ComponentContainer container;
/**
* @return this
*/
public final Module init() {
return init(new ComponentContainer());
}
/**
* @return this
*/
private Module init(ComponentContainer container) {
this.container = container;
configure();
return this;
}
/**
* Installs module into this module.
*
* @return this
*/
public final Module install(Module module) {
module.init(container);
return this;
}
/**
* Installs module into new scope - see http://picocontainer.org/scopes.html
*
* @return installed module
*/
public final Module installChild(Module child) {
ComponentContainer childContainer = container.createChild();
child.init(childContainer);
return child;
}
public final void uninstallChild() {
container.removeChild();
}
/**
* @return this
*/
public final Module start() {
container.startComponents();
doStart();
return this;
}
protected void doStart() {
// empty method to be overridden
}
/**
* @return this
*/
public final Module stop() {
try {
doStop();
container.stopComponents();
} catch (Exception e) {
// ignore
}
return this;
}
protected void doStop() {
// empty method to be overridden
}
/**
* Implementation of this method must not contain conditional logic and just should contain several invocations of
* {@link #addCoreSingleton(Object)}, {@link #addExtension(org.sonar.api.platform.PluginMetadata, Object)} or {@link #addAdapter(ComponentAdapter)}.
*/
protected abstract void configure();
protected final void addCoreSingleton(Object component) {
container.addSingleton(component);
}
protected final void declareExtension(PluginMetadata plugin, Object extension) {
container.declareExtension(plugin, extension);
}
protected final void addExtension(PluginMetadata plugin, Object extension) {
container.addExtension(plugin, extension);
}
protected final void addAdapter(ComponentAdapter<?> componentAdapter) {
container.addPicoAdapter(componentAdapter);
}
public final <T> T getComponentByType(Class<T> componentType) {
return container.getComponentByType(componentType);
}
public final Object getComponentByKey(Object key) {
return container.getComponentByKey(key);
}
public final <T> List<T> getComponents(Class<T> componentType) {
return container.getComponentsByType(componentType);
}
}
|
