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 * Read a configuration. 31 * 32 * @param mergeDescriptor configuration to merge with the loaded configuration. Some values are used as defaults, 33 * while others are used to override 34 * @return the configuration 35 * @throws org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any. 36 */ 37 ReleaseDescriptorBuilder read( ReleaseDescriptorBuilder mergeDescriptor ) 38 throws ReleaseDescriptorStoreException; 39 40 /** 41 * Save a configuration. 42 * 43 * @param config the configuration 44 * @throws org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any. 45 */ 46 void write( ReleaseDescriptor config ) 47 throws ReleaseDescriptorStoreException; 48 49 /** 50 * Remove a configuration. 51 * 52 * @param config the location of the configuration 53 */ 54 void delete( ReleaseDescriptor config ); 55 }