1 package org.apache.maven.shared.release.policy.version;
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 import org.apache.maven.shared.release.versions.VersionParseException;
24
25 /**
26 * API for next version calculations, used by maven-release-plugin to suggest release and next develoment versions.
27 *
28 * @since 2.5.1 (MRELEASE-431)
29 */
30 public interface VersionPolicy
31 {
32 /**
33 * <p>getReleaseVersion.</p>
34 *
35 * @return the calculation of the release version from development state.
36 * @param request the {@code VersionPolicyRequest}
37 * @throws org.apache.maven.shared.release.policy.PolicyException if exception in the policy
38 * @throws org.apache.maven.shared.release.versions.VersionParseException if exception parsing the version
39 */
40 VersionPolicyResult getReleaseVersion( VersionPolicyRequest request )
41 throws PolicyException, VersionParseException;
42
43 /**
44 * <p>getDevelopmentVersion.</p>
45 *
46 * @return the calculation of the next development version from release state.
47 * @param request the {@code VersionPolicyRequest}
48 * @throws org.apache.maven.shared.release.policy.PolicyException if exception in the policy
49 * @throws org.apache.maven.shared.release.versions.VersionParseException if exception parsing the version
50 */
51 VersionPolicyResult getDevelopmentVersion( VersionPolicyRequest request )
52 throws PolicyException, VersionParseException;
53 }