Blame - tools/maven-bundle-plugin/doc/site/xref/org/apache/felix/bundleplugin/AbstractDependencyFilter.html - onos-felix

Stuart McCulloch

2011-07-05 11:48:22 +0000

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>AbstractDependencyFilter xref</title>

</head>

<body>

<pre>

<a name="1" href="#1">1</a> /*

12

<a name="2" href="#2">2</a> * Licensed to the Apache Software Foundation (ASF) under one

13

<a name="3" href="#3">3</a> * or more contributor license agreements. See the NOTICE file

14

<a name="4" href="#4">4</a> * distributed with this work for additional information

15

<a name="5" href="#5">5</a> * regarding copyright ownership. The ASF licenses this file

16

<a name="6" href="#6">6</a> * to you under the Apache License, Version 2.0 (the

17

<a name="7" href="#7">7</a> * "License"); you may not use this file except in compliance

18

<a name="8" href="#8">8</a> * with the License. You may obtain a copy of the License at

19

<a name="9" href="#9">9</a> *

20

<a name="10" href="#10">10</a> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a>

21

<a name="11" href="#11">11</a> *

22

<a name="12" href="#12">12</a> * Unless required by applicable law or agreed to in writing,

23

<a name="13" href="#13">13</a> * software distributed under the License is distributed on an

24

<a name="14" href="#14">14</a> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

25

<a name="15" href="#15">15</a> * KIND, either express or implied. See the License for the

26

<a name="16" href="#16">16</a> * specific language governing permissions and limitations

27

<a name="17" href="#17">17</a> * under the License.

28

<a name="18" href="#18">18</a> */

29

<a name="19" href="#19">19</a> package org.apache.felix.bundleplugin;

30

31

32

<a name="22" href="#22">22</a> import java.util.Collection;

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

33

<a name="23" href="#23">23</a> import java.util.Iterator;

34

<a name="24" href="#24">24</a> import java.util.LinkedHashSet;

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

35

<a name="25" href="#25">25</a> import java.util.Map;

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

36

<a name="26" href="#26">26</a> import java.util.regex.Pattern;

37

38

<a name="28" href="#28">28</a> import org.apache.maven.artifact.Artifact;

39

<a name="29" href="#29">29</a> import org.apache.maven.plugin.MojoExecutionException;

40

Stuart McCulloch

8ddadb7

2013-06-07 23:25:18 +0000

[diff] [blame]

41

<a name="31" href="#31">31</a> import aQute.bnd.osgi.Instruction;

42

<a name="32" href="#32">32</a> import aQute.bnd.header.OSGiHeader;

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

43

44

45

<a name="35" href="#35">35</a> /**

46

<a name="36" href="#36">36</a> * Apply clause-based filter over given dependencies

47

<a name="37" href="#37">37</a> *

48

<a name="38" href="#38">38</a> * @author <a href="<a href="mailto:dev@felix.apache.org" target="alexandria_uri">mailto:dev@felix.apache.org</a>">Felix Project Team</a>

49

<a name="39" href="#39">39</a> */

50

<a name="40" href="#40">40</a> public abstract class <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">AbstractDependencyFilter</a>

51

<a name="41" href="#41">41</a> {

52

<a name="42" href="#42">42</a> private static final Pattern MISSING_KEY_PATTERN = Pattern.compile( "(^|,)\\p{Blank}*(!)?\\p{Blank}*([a-zA-Z]+=)" );

53

54

<a name="44" href="#44">44</a> /**

55

<a name="45" href="#45">45</a> * Dependency artifacts.

56

<a name="46" href="#46">46</a> */

57

<a name="47" href="#47">47</a> private final Collection m_dependencyArtifacts;

58

59

60

<a name="50" href="#50">50</a> public <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">AbstractDependencyFilter</a>( Collection dependencyArtifacts )

61

<a name="51" href="#51">51</a> {

62

<a name="52" href="#52">52</a> m_dependencyArtifacts = dependencyArtifacts;

63

<a name="53" href="#53">53</a> }

64

65

<a name="55" href="#55">55</a> private static abstract class <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>

66

<a name="56" href="#56">56</a> {

67

<a name="57" href="#57">57</a> private final Instruction m_instruction;

68

<a name="58" href="#58">58</a> private final String m_defaultValue;

69

70

71

<a name="61" href="#61">61</a> public <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( String expression )

72

<a name="62" href="#62">62</a> {

73

<a name="63" href="#63">63</a> this( expression, "" );

74

<a name="64" href="#64">64</a> }

75

76

77

<a name="67" href="#67">67</a> public <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( String expression, String defaultValue )

78

<a name="68" href="#68">68</a> {

Stuart McCulloch

8ddadb7

2013-06-07 23:25:18 +0000

[diff] [blame]

79

<a name="69" href="#69">69</a> m_instruction = new Instruction( expression );

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

80

<a name="70" href="#70">70</a> m_defaultValue = defaultValue;

81

<a name="71" href="#71">71</a> }

82

83

84

<a name="74" href="#74">74</a> public void filter( Collection dependencies )

85

<a name="75" href="#75">75</a> {

86

<a name="76" href="#76">76</a> for ( Iterator i = dependencies.iterator(); i.hasNext(); )

87

<a name="77" href="#77">77</a> {

88

<a name="78" href="#78">78</a> if ( false == matches( ( Artifact ) i.next() ) )

89

<a name="79" href="#79">79</a> {

90

<a name="80" href="#80">80</a> i.remove();

91

<a name="81" href="#81">81</a> }

92

<a name="82" href="#82">82</a> }

93

<a name="83" href="#83">83</a> }

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

94

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

95

96

<a name="86" href="#86">86</a> abstract boolean matches( Artifact dependency );

97

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

98

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

99

<a name="89" href="#89">89</a> boolean matches( String text )

100

<a name="90" href="#90">90</a> {

101

<a name="91" href="#91">91</a> boolean result;

102

103

<a name="93" href="#93">93</a> if ( null == text )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

104

<a name="94" href="#94">94</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

105

<a name="95" href="#95">95</a> result = m_instruction.matches( m_defaultValue );

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

106

<a name="96" href="#96">96</a> }

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

107

<a name="97" href="#97">97</a> else

108

<a name="98" href="#98">98</a> {

109

<a name="99" href="#99">99</a> result = m_instruction.matches( text );

110

<a name="100" href="#100">100</a> }

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

111

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

112

<a name="102" href="#102">102</a> return m_instruction.isNegated() ? !result : result;

113

<a name="103" href="#103">103</a> }

114

<a name="104" href="#104">104</a> }

115

116

117

<a name="107" href="#107">107</a> protected final void processInstructions( String header ) throws MojoExecutionException

118

<a name="108" href="#108">108</a> {

119

<a name="109" href="#109">109</a> Map instructions = OSGiHeader.parseHeader( MISSING_KEY_PATTERN.matcher( header ).replaceAll( "$1$2*;$3" ) );

120

121

<a name="111" href="#111">111</a> Collection availableDependencies = new LinkedHashSet( m_dependencyArtifacts );

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

122

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

123

<a name="113" href="#113">113</a> <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a> filter;

124

<a name="114" href="#114">114</a> for ( Iterator clauseIterator = instructions.entrySet().iterator(); clauseIterator.hasNext(); )

125

<a name="115" href="#115">115</a> {

126

<a name="116" href="#116">116</a> String inline = "false";

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

127

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

128

<a name="118" href="#118">118</a> // always start with a fresh *modifiable* collection for each unique clause

129

<a name="119" href="#119">119</a> Collection filteredDependencies = new LinkedHashSet( availableDependencies );

130

131

<a name="121" href="#121">121</a> // CLAUSE: REGEXP --> { ATTRIBUTE MAP }

132

<a name="122" href="#122">122</a> Map.Entry clause = ( Map.Entry ) clauseIterator.next();

133

<a name="123" href="#123">123</a> String primaryKey = ( ( String ) clause.getKey() ).replaceFirst( "~+$", "" );

134

<a name="124" href="#124">124</a> boolean isNegative = primaryKey.startsWith( "!" );

135

<a name="125" href="#125">125</a> if ( isNegative )

136

<a name="126" href="#126">126</a> {

137

<a name="127" href="#127">127</a> primaryKey = primaryKey.substring( 1 );

138

<a name="128" href="#128">128</a> }

139

140

<a name="130" href="#130">130</a> if ( !"*".equals( primaryKey ) )

141

<a name="131" href="#131">131</a> {

142

<a name="132" href="#132">132</a> filter = new <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( primaryKey )

143

<a name="133" href="#133">133</a> {

144

<a name="134" href="#134">134</a> boolean matches( Artifact dependency )

145

<a name="135" href="#135">135</a> {

146

<a name="136" href="#136">136</a> return super.matches( dependency.getArtifactId() );

147

<a name="137" href="#137">137</a> }

148

<a name="138" href="#138">138</a> };

149

<a name="139" href="#139">139</a> // FILTER ON MAIN CLAUSE

150

<a name="140" href="#140">140</a> filter.filter( filteredDependencies );

151

<a name="141" href="#141">141</a> }

152

153

<a name="143" href="#143">143</a> for ( Iterator attrIterator = ( ( Map ) clause.getValue() ).entrySet().iterator(); attrIterator.hasNext(); )

154

<a name="144" href="#144">144</a> {

155

<a name="145" href="#145">145</a> // ATTRIBUTE: KEY --> REGEXP

156

<a name="146" href="#146">146</a> Map.Entry attr = ( Map.Entry ) attrIterator.next();

157

<a name="147" href="#147">147</a> if ( "groupId".equals( attr.getKey() ) )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

158

<a name="148" href="#148">148</a> {

159

<a name="149" href="#149">149</a> filter = new <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( ( String ) attr.getValue() )

160

<a name="150" href="#150">150</a> {

161

<a name="151" href="#151">151</a> boolean matches( Artifact dependency )

162

<a name="152" href="#152">152</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

163

<a name="153" href="#153">153</a> return super.matches( dependency.getGroupId() );

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

164

<a name="154" href="#154">154</a> }

165

<a name="155" href="#155">155</a> };

166

<a name="156" href="#156">156</a> }

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

167

<a name="157" href="#157">157</a> else if ( "artifactId".equals( attr.getKey() ) )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

168

<a name="158" href="#158">158</a> {

169

<a name="159" href="#159">159</a> filter = new <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( ( String ) attr.getValue() )

170

<a name="160" href="#160">160</a> {

171

<a name="161" href="#161">161</a> boolean matches( Artifact dependency )

172

<a name="162" href="#162">162</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

173

<a name="163" href="#163">163</a> return super.matches( dependency.getArtifactId() );

174

<a name="164" href="#164">164</a> }

175

<a name="165" href="#165">165</a> };

176

<a name="166" href="#166">166</a> }

177

<a name="167" href="#167">167</a> else if ( "version".equals( attr.getKey() ) )

178

<a name="168" href="#168">168</a> {

179

<a name="169" href="#169">169</a> filter = new <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( ( String ) attr.getValue() )

180

<a name="170" href="#170">170</a> {

181

<a name="171" href="#171">171</a> boolean matches( Artifact dependency )

182

<a name="172" href="#172">172</a> {

183

<a name="173" href="#173">173</a> try

184

<a name="174" href="#174">174</a> {

185

<a name="175" href="#175">175</a> // use the symbolic version if available (ie. 1.0.0-SNAPSHOT)

186

<a name="176" href="#176">176</a> return super.matches( dependency.getSelectedVersion().toString() );

187

<a name="177" href="#177">177</a> }

188

<a name="178" href="#178">178</a> catch ( Exception e )

189

<a name="179" href="#179">179</a> {

190

<a name="180" href="#180">180</a> return super.matches( dependency.getVersion() );

191

<a name="181" href="#181">181</a> }

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

192

<a name="182" href="#182">182</a> }

193

<a name="183" href="#183">183</a> };

194

<a name="184" href="#184">184</a> }

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

195

<a name="185" href="#185">185</a> else if ( "scope".equals( attr.getKey() ) )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

196

<a name="186" href="#186">186</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

197

<a name="187" href="#187">187</a> filter = new <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( ( String ) attr.getValue(), "compile" )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

198

<a name="188" href="#188">188</a> {

199

<a name="189" href="#189">189</a> boolean matches( Artifact dependency )

200

<a name="190" href="#190">190</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

201

<a name="191" href="#191">191</a> return super.matches( dependency.getScope() );

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

202

<a name="192" href="#192">192</a> }

203

<a name="193" href="#193">193</a> };

204

<a name="194" href="#194">194</a> }

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

205

<a name="195" href="#195">195</a> else if ( "type".equals( attr.getKey() ) )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

206

<a name="196" href="#196">196</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

207

<a name="197" href="#197">197</a> filter = new <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( ( String ) attr.getValue(), "jar" )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

208

<a name="198" href="#198">198</a> {

209

<a name="199" href="#199">199</a> boolean matches( Artifact dependency )

210

<a name="200" href="#200">200</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

211

<a name="201" href="#201">201</a> return super.matches( dependency.getType() );

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

212

<a name="202" href="#202">202</a> }

213

<a name="203" href="#203">203</a> };

214

<a name="204" href="#204">204</a> }

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

215

<a name="205" href="#205">205</a> else if ( "classifier".equals( attr.getKey() ) )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

216

<a name="206" href="#206">206</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

217

<a name="207" href="#207">207</a> filter = new <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( ( String ) attr.getValue() )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

218

<a name="208" href="#208">208</a> {

219

<a name="209" href="#209">209</a> boolean matches( Artifact dependency )

220

<a name="210" href="#210">210</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

221

<a name="211" href="#211">211</a> return super.matches( dependency.getClassifier() );

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

222

<a name="212" href="#212">212</a> }

223

<a name="213" href="#213">213</a> };

224

<a name="214" href="#214">214</a> }

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

225

<a name="215" href="#215">215</a> else if ( "optional".equals( attr.getKey() ) )

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

226

<a name="216" href="#216">216</a> {

Stuart McCulloch

148b7bf

2011-11-28 16:39:12 +0000

[diff] [blame]

227

<a name="217" href="#217">217</a> filter = new <a href="../../../../org/apache/felix/bundleplugin/AbstractDependencyFilter.html">DependencyFilter</a>( ( String ) attr.getValue(), "false" )

228

<a name="218" href="#218">218</a> {

229

<a name="219" href="#219">219</a> boolean matches( Artifact dependency )

230

<a name="220" href="#220">220</a> {

231

<a name="221" href="#221">221</a> return super.matches( "" + dependency.isOptional() );

232

<a name="222" href="#222">222</a> }

233

<a name="223" href="#223">223</a> };

234

<a name="224" href="#224">224</a> }

235

<a name="225" href="#225">225</a> else if ( "inline".equals( attr.getKey() ) )

236

<a name="226" href="#226">226</a> {

237

<a name="227" href="#227">227</a> inline = ( String ) attr.getValue();

238

<a name="228" href="#228">228</a> continue;

239

<a name="229" href="#229">229</a> }

240

<a name="230" href="#230">230</a> else

241

<a name="231" href="#231">231</a> {

242

<a name="232" href="#232">232</a> throw new MojoExecutionException( "Unexpected attribute " + attr.getKey() );

243

<a name="233" href="#233">233</a> }

244

245

<a name="235" href="#235">235</a> // FILTER ON EACH ATTRIBUTE

246

<a name="236" href="#236">236</a> filter.filter( filteredDependencies );

247

<a name="237" href="#237">237</a> }

248

249

<a name="239" href="#239">239</a> if ( isNegative )

250

<a name="240" href="#240">240</a> {

251

<a name="241" href="#241">241</a> // negative clauses reduce the set of available artifacts

252

<a name="242" href="#242">242</a> availableDependencies.removeAll( filteredDependencies );

253

<a name="243" href="#243">243</a> if ( !clauseIterator.hasNext() )

254

<a name="244" href="#244">244</a> {

255

<a name="245" href="#245">245</a> // assume there's an implicit * missing at the end

256

<a name="246" href="#246">246</a> processDependencies( availableDependencies, inline );

257

<a name="247" href="#247">247</a> }

258

<a name="248" href="#248">248</a> }

259

<a name="249" href="#249">249</a> else

260

<a name="250" href="#250">250</a> {

261

<a name="251" href="#251">251</a> // positive clause; doesn't alter the available artifacts

262

<a name="252" href="#252">252</a> processDependencies( filteredDependencies, inline );

263

<a name="253" href="#253">253</a> }

264

<a name="254" href="#254">254</a> }

265

<a name="255" href="#255">255</a> }

266

267

268

<a name="258" href="#258">258</a> protected abstract void processDependencies( Collection dependencies, String inline );

269

<a name="259" href="#259">259</a> }

Stuart McCulloch

d16db97

2011-07-05 11:48:22 +0000

[diff] [blame]

270

</pre>

271

<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>

272

</html>

273