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.shared.release.scm;
20
21 /**
22 * Translate the SCM information after tagging/reverting to trunk.
23 *
24 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
25 */
26 // TODO move this API into SCM?
27 public interface ScmTranslator {
28 /**
29 * Take an URL and find the correct replacement URL for a given branch.
30 *
31 * @param url the source URL
32 * @param branchName the branch name
33 * @param branchBase the branch base for providers that support it
34 * @return the replacement URL
35 */
36 String translateBranchUrl(String url, String branchName, String branchBase);
37
38 /**
39 * Take an URL and find the correct replacement URL for a given tag.
40 *
41 * @param url the source URL
42 * @param tag the tag
43 * @param tagBase the tag base for providers that support it
44 * @return the replacement URL
45 */
46 String translateTagUrl(String url, String tag, String tagBase);
47
48 /**
49 * Determine what tag should be added to the POM given the original tag and the new one.
50 *
51 * @param tag the new tag
52 * @return the tag to use, or <code>null</code> if the provider does not use tags
53 */
54 String resolveTag(String tag);
55
56 /**
57 * Translates an ScmFile path to a path relative to the working directory.
58 *
59 * @param path the ScmFile path
60 * @return the relative path with OS specific File separator
61 * @since 2.3.1
62 */
63 String toRelativePath(String path);
64 }