View Javadoc

1   package org.apache.maven.index.artifact;
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  /**
23   * An interface to calculate <code>Gav</code> based on provided artifact path and to calculate an artifact path from
24   * provided <code>Gav</code>.
25   * 
26   * @author Tamas Cservenak
27   */
28  public interface GavCalculator
29  {
30      /**
31       * Calculates GAV from provided <em>repository path</em>. The path has to be absolute starting from repository root.
32       * If path represents a proper artifact path (conforming to given layout), GAV is "calculated" from it and is
33       * returned. If path represents some file that is not an artifact, but is part of the repository layout (like
34       * maven-metadata.xml), or in any other case it returns null.
35       * 
36       * @param path the repository path
37       * @return Gav parsed from the path
38       */
39      Gav pathToGav( String path );
40  
41      /**
42       * Reassembles the repository path from the supplied GAV. It will be an absolute path.
43       * 
44       * @param gav
45       * @return the path calculated from GAV, obeying current layout.
46       */
47      String gavToPath( Gav gav );
48  }