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