View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.util.graph.traverser;
20  
21  import org.eclipse.aether.artifact.ArtifactProperties;
22  import org.eclipse.aether.collection.DependencyCollectionContext;
23  import org.eclipse.aether.collection.DependencyTraverser;
24  import org.eclipse.aether.graph.Dependency;
25  
26  import static java.util.Objects.requireNonNull;
27  
28  /**
29   * A dependency traverser that excludes the dependencies of fat artifacts from the traversal. Fat artifacts are
30   * artifacts that have the property {@link org.eclipse.aether.artifact.ArtifactProperties#INCLUDES_DEPENDENCIES} set to
31   * {@code true}.
32   *
33   * @see org.eclipse.aether.artifact.Artifact#getProperties()
34   */
35  public final class FatArtifactTraverser implements DependencyTraverser {
36  
37      /**
38       * Creates a new instance of this dependency traverser.
39       */
40      public FatArtifactTraverser() {}
41  
42      public boolean traverseDependency(Dependency dependency) {
43          requireNonNull(dependency, "dependency cannot be null");
44          String prop = dependency.getArtifact().getProperty(ArtifactProperties.INCLUDES_DEPENDENCIES, "");
45          return !Boolean.parseBoolean(prop);
46      }
47  
48      public DependencyTraverser deriveChildTraverser(DependencyCollectionContext context) {
49          requireNonNull(context, "context cannot be null");
50          return this;
51      }
52  
53      @Override
54      public boolean equals(Object obj) {
55          if (this == obj) {
56              return true;
57          } else if (null == obj || !getClass().equals(obj.getClass())) {
58              return false;
59          }
60          return true;
61      }
62  
63      @Override
64      public int hashCode() {
65          return getClass().hashCode();
66      }
67  }