Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ReleaseDescriptorStore |
|
| 1.0;1 |
1 | package org.apache.maven.shared.release.config; | |
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 | * Storage for reading and writing release configuration. | |
24 | * | |
25 | * @author <a href="mailto:brett@apache.org">Brett Porter</a> | |
26 | */ | |
27 | public interface ReleaseDescriptorStore | |
28 | { | |
29 | /** | |
30 | * The Plexus role. | |
31 | */ | |
32 | String ROLE = ReleaseDescriptorStore.class.getName(); | |
33 | ||
34 | /** | |
35 | * Read a configuration. | |
36 | * | |
37 | * @param mergeDescriptor configuration to merge with the loaded configuration. Some values are used as defaults, | |
38 | * while others are used to override | |
39 | * @return the configuration | |
40 | */ | |
41 | ReleaseDescriptor read( ReleaseDescriptor mergeDescriptor ) | |
42 | throws ReleaseDescriptorStoreException; | |
43 | ||
44 | /** | |
45 | * Save a configuration. | |
46 | * | |
47 | * @param config the configuration | |
48 | */ | |
49 | void write( ReleaseDescriptor config ) | |
50 | throws ReleaseDescriptorStoreException; | |
51 | ||
52 | /** | |
53 | * Remove a configuration. | |
54 | * | |
55 | * @param config the location of the configuration | |
56 | */ | |
57 | void delete( ReleaseDescriptor config ); | |
58 | } |