Coverage Report

Coverage Report - org.apache.maven.index.artifact.GavCalculator

Classes in this File

 package org.apache.maven.index.artifact;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 
 /**
  * An interface to calculate <code>Gav</code> based on provided artifact path and to calculate an artifact path from
  * provided <code>Gav</code>.
  * 
  * @author Tamas Cservenak
  */
 public interface GavCalculator
 {
     /**
      * Calculates GAV from provided <em>repository path</em>. The path has to be absolute starting from repository root.
      * If path represents a proper artifact path (conforming to given layout), GAV is "calculated" from it and is
      * returned. If path represents some file that is not an artifact, but is part of the repository layout (like
      * maven-metadata.xml), or in any other case it returns null. TODO: some place for different levels of "validation"?
      * 
      * @param path the repository path
      * @return Gav parsed from the path
      * @throws IllegalArtifactCoordinateException not throwing it anymore, here just for backward compatibility.
      */
     Gav pathToGav( String path )
         throws IllegalArtifactCoordinateException;
 
     /**
      * Reassembles the repository path from the supplied GAV. It will be an absolute path.
      * 
      * @param gav
      * @return the path calculated from GAV, obeying current layout.
      */
     String gavToPath( Gav gav );
 }

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. TODO: some place for different levels of "validation"?
35		*
36		* @param path the repository path
37		* @return Gav parsed from the path
38		* @throws IllegalArtifactCoordinateException not throwing it anymore, here just for backward compatibility.
39		*/
40		Gav pathToGav( String path )
41		throws IllegalArtifactCoordinateException;
42
43		/**
44		* Reassembles the repository path from the supplied GAV. It will be an absolute path.
45		*
46		* @param gav
47		* @return the path calculated from GAV, obeying current layout.
48		*/
49		String gavToPath( Gav gav );
50		}