1 package org.apache.maven.shared.release.policy.naming;
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 import org.apache.maven.shared.release.policy.PolicyException;
23
24 /**
25 * API for branch and tag naming. Used by maven-release-plugin to suggest names for tags and branches.
26 *
27 * @since 3.0.0 (MRELEASE-979)
28 */
29 public interface NamingPolicy
30 {
31 /**
32 * <p>getName.</p>
33 *
34 * @return the calculation of the name used for branching or tagging.
35 * @param request the {@code NamingPolicyRequest}
36 * @throws org.apache.maven.shared.release.policy.PolicyException if exception in the policy
37 */
38 NamingPolicyResult getName( NamingPolicyRequest request )
39 throws PolicyException;
40
41 }