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.config;
20
21 /**
22 * Storage for reading and writing release configuration.
23 *
24 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
25 */
26 public interface ReleaseDescriptorStore {
27 /**
28 * Read a configuration.
29 *
30 * @param mergeDescriptor configuration to merge with the loaded configuration. Some values are used as defaults,
31 * while others are used to override
32 * @return the configuration
33 * @throws org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
34 */
35 ReleaseDescriptorBuilder read(ReleaseDescriptorBuilder mergeDescriptor) throws ReleaseDescriptorStoreException;
36
37 /**
38 * Save a configuration.
39 *
40 * @param config the configuration
41 * @throws org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
42 */
43 void write(ReleaseDescriptor config) throws ReleaseDescriptorStoreException;
44
45 /**
46 * Remove a configuration.
47 *
48 * @param config the location of the configuration
49 */
50 void delete(ReleaseDescriptor config);
51 }