View Javadoc
1   package org.eclipse.aether.util.graph.selector;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   * 
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   * 
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Arrays;
23  import java.util.Collection;
24  import java.util.Collections;
25  import java.util.LinkedHashSet;
26  import java.util.Set;
27  
28  import org.eclipse.aether.collection.DependencyCollectionContext;
29  import org.eclipse.aether.collection.DependencySelector;
30  import org.eclipse.aether.graph.Dependency;
31  
32  /**
33   * A dependency selector that combines zero or more other selectors using a logical {@code AND}. The resulting selector
34   * selects a given dependency if and only if all constituent selectors do so.
35   */
36  public final class AndDependencySelector
37      implements DependencySelector
38  {
39  
40      private final Set<? extends DependencySelector> selectors;
41  
42      private int hashCode;
43  
44      /**
45       * Creates a new selector from the specified selectors. Prefer
46       * {@link #newInstance(DependencySelector, DependencySelector)} if any of the input selectors might be {@code null}.
47       * 
48       * @param selectors The selectors to combine, may be {@code null} but must not contain {@code null} elements.
49       */
50      public AndDependencySelector( DependencySelector... selectors )
51      {
52          if ( selectors != null && selectors.length > 0 )
53          {
54              this.selectors = new LinkedHashSet<DependencySelector>( Arrays.asList( selectors ) );
55          }
56          else
57          {
58              this.selectors = Collections.emptySet();
59          }
60      }
61  
62      /**
63       * Creates a new selector from the specified selectors.
64       * 
65       * @param selectors The selectors to combine, may be {@code null} but must not contain {@code null} elements.
66       */
67      public AndDependencySelector( Collection<? extends DependencySelector> selectors )
68      {
69          if ( selectors != null && !selectors.isEmpty() )
70          {
71              this.selectors = new LinkedHashSet<DependencySelector>( selectors );
72          }
73          else
74          {
75              this.selectors = Collections.emptySet();
76          }
77      }
78  
79      private AndDependencySelector( Set<DependencySelector> selectors )
80      {
81          if ( selectors != null && !selectors.isEmpty() )
82          {
83              this.selectors = selectors;
84          }
85          else
86          {
87              this.selectors = Collections.emptySet();
88          }
89      }
90  
91      /**
92       * Creates a new selector from the specified selectors.
93       * 
94       * @param selector1 The first selector to combine, may be {@code null}.
95       * @param selector2 The second selector to combine, may be {@code null}.
96       * @return The combined selector or {@code null} if both selectors were {@code null}.
97       */
98      public static DependencySelector newInstance( DependencySelector selector1, DependencySelector selector2 )
99      {
100         if ( selector1 == null )
101         {
102             return selector2;
103         }
104         else if ( selector2 == null || selector2.equals( selector1 ) )
105         {
106             return selector1;
107         }
108         return new AndDependencySelector( selector1, selector2 );
109     }
110 
111     public boolean selectDependency( Dependency dependency )
112     {
113         for ( DependencySelector selector : selectors )
114         {
115             if ( !selector.selectDependency( dependency ) )
116             {
117                 return false;
118             }
119         }
120         return true;
121     }
122 
123     public DependencySelector deriveChildSelector( DependencyCollectionContext context )
124     {
125         int seen = 0;
126         Set<DependencySelector> childSelectors = null;
127 
128         for ( DependencySelector selector : selectors )
129         {
130             DependencySelector childSelector = selector.deriveChildSelector( context );
131             if ( childSelectors != null )
132             {
133                 if ( childSelector != null )
134                 {
135                     childSelectors.add( childSelector );
136                 }
137             }
138             else if ( selector != childSelector )
139             {
140                 childSelectors = new LinkedHashSet<DependencySelector>();
141                 if ( seen > 0 )
142                 {
143                     for ( DependencySelector s : selectors )
144                     {
145                         if ( childSelectors.size() >= seen )
146                         {
147                             break;
148                         }
149                         childSelectors.add( s );
150                     }
151                 }
152                 if ( childSelector != null )
153                 {
154                     childSelectors.add( childSelector );
155                 }
156             }
157             else
158             {
159                 seen++;
160             }
161         }
162 
163         if ( childSelectors == null )
164         {
165             return this;
166         }
167         if ( childSelectors.size() <= 1 )
168         {
169             if ( childSelectors.isEmpty() )
170             {
171                 return null;
172             }
173             return childSelectors.iterator().next();
174         }
175         return new AndDependencySelector( childSelectors );
176     }
177 
178     @Override
179     public boolean equals( Object obj )
180     {
181         if ( this == obj )
182         {
183             return true;
184         }
185         else if ( null == obj || !getClass().equals( obj.getClass() ) )
186         {
187             return false;
188         }
189 
190         AndDependencySelector that = (AndDependencySelector) obj;
191         return selectors.equals( that.selectors );
192     }
193 
194     @Override
195     public int hashCode()
196     {
197         if ( hashCode == 0 )
198         {
199             int hash = 17;
200             hash = hash * 31 + selectors.hashCode();
201             hashCode = hash;
202         }
203         return hashCode;
204     }
205 
206 }