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.apache.maven.index;
20  
21  import java.io.File;
22  
23  import org.apache.maven.index.context.IndexingContext;
24  import org.codehaus.plexus.util.StringUtils;
25  
26  /**
27   * A scanning request provides various input parameters for repository scan
28   *
29   * @author Jason van Zyl
30   */
31  public class ScanningRequest {
32      private final IndexingContext context;
33  
34      private final ArtifactScanningListener artifactScanningListener;
35  
36      private final String startingPath;
37  
38      public ScanningRequest(final IndexingContext context, final ArtifactScanningListener artifactScanningListener) {
39          this(context, artifactScanningListener, null);
40      }
41  
42      public ScanningRequest(
43              final IndexingContext context,
44              final ArtifactScanningListener artifactScanningListener,
45              final String startingPath) {
46          this.context = context;
47          this.artifactScanningListener = artifactScanningListener;
48          this.startingPath = startingPath;
49      }
50  
51      public IndexingContext getIndexingContext() {
52          return context;
53      }
54  
55      public ArtifactScanningListener getArtifactScanningListener() {
56          return artifactScanningListener;
57      }
58  
59      public String getStartingPath() {
60          return startingPath;
61      }
62  
63      public File getStartingDirectory() {
64          if (StringUtils.isBlank(startingPath)) {
65              return getIndexingContext().getRepository();
66          } else {
67              return new File(getIndexingContext().getRepository(), startingPath);
68          }
69      }
70  }