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