View Javadoc

1   package org.apache.maven.plugin.javadoc.resolver;
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 org.apache.maven.artifact.Artifact;
23  import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
24  
25  /**
26   * ArtifactFilter implementation which returns true for the given pomArtifact
27   * and offers the opportunity to delegate to another filter, if the given
28   * artifact is not the pomArtifact.
29   */
30  public class ProjectArtifactFilter implements ArtifactFilter
31  {
32  
33      private Artifact pomArtifact;
34      private ArtifactFilter childFilter;
35  
36      public ProjectArtifactFilter(Artifact pomArtifact)
37      {
38          this(pomArtifact, null);
39      }
40  
41      public ProjectArtifactFilter(Artifact pomArtifact, ArtifactFilter childFilter)
42      {
43          this.pomArtifact = pomArtifact;
44          this.childFilter = childFilter;
45      }
46  
47      public boolean include(Artifact artifact)
48      {
49          // always include the pom artifact
50          if ( pomArtifact.equals(artifact) )
51          {
52              return true;
53          }
54  
55          // delegate to given filter, if available
56          if ( childFilter != null )
57          {
58              return childFilter.include(artifact);
59          }
60  
61          // given artifact does not match any rule
62          return false;
63      }
64  }